Package io.permazen.cli.cmd

Class DecodeKeyCommand

java.lang.Object

io.permazen.cli.cmd.AbstractCommand

io.permazen.cli.cmd.AbstractKVCommand

io.permazen.cli.cmd.DecodeKeyCommand

All Implemented Interfaces:

Command

public class DecodeKeyCommand
extends AbstractKVCommand

Nested Class Summary

Nested classes/interfaces inherited from class io.permazen.cli.cmd.AbstractKVCommand

AbstractKVCommand.BytesParser, AbstractKVCommand.KVAction

Field Summary

Fields inherited from class io.permazen.cli.cmd.AbstractKVCommand

CSTRING_PATTERN, HEXBYTES_PATTERN

Fields inherited from class io.permazen.cli.cmd.AbstractCommand

log, name, paramParser

Constructor Summary

Constructors

Constructor	Description
DecodeKeyCommand()

Method Summary

Modifier and Type	Method	Description
static String	decode(Transaction tx, ByteData key)	Decode a key/value in the context of a Transaction.
io.permazen.cli.cmd.DecodeKeyCommand.DecodeKeyAction	getAction(Session session, Map<String,Object> params)	Process command line parameters and return action.
String	getHelpDetail()	Get expanded help (typically multiple lines).
String	getHelpSummary()	Get summarized help (typically a single line).
protected Parser<?>	getParser(String typeName)	Convert parameter spec type name into a Parser.

Methods inherited from class io.permazen.cli.cmd.AbstractKVCommand

fromCString, toCString

Methods inherited from class io.permazen.cli.cmd.AbstractCommand

execute, getName, getSessionModes, getUsage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DecodeKeyCommand

public DecodeKeyCommand()

Method Details

getHelpSummary

public String getHelpSummary()

Description copied from class: AbstractCommand

Get summarized help (typically a single line).

Specified by:

getHelpSummary in interface Command

Specified by:

getHelpSummary in class AbstractCommand

Returns:

one line command summary

getHelpDetail

public String getHelpDetail()

Description copied from class: AbstractCommand

Get expanded help (typically multiple lines).

The implementation in AbstractCommand delegates to getHelpSummary().

Specified by:

getHelpDetail in interface Command

Overrides:

getHelpDetail in class AbstractCommand

Returns:

detailed command description

getParser

protected Parser<?> getParser(String typeName)

Description copied from class: AbstractCommand

Convert parameter spec type name into a Parser. Used for custom type names not supported by ParamParser.

The implementation in AbstractCommand supports all Encodings registered with the database, plus:

• objid for an object ID of the form 64e8f29755302fe1 (returns ObjId)

Overrides:

getParser in class AbstractKVCommand

Parameters:

typeName - parameter encoding ID or encoding ID alias

Returns:

parser for parameters of the specified type

getAction

public io.permazen.cli.cmd.DecodeKeyCommand.DecodeKeyAction getAction(Session session,
 Map<String,Object> params)

Description copied from class: AbstractCommand

Process command line parameters and return action.

Specified by:

getAction in class AbstractCommand

Parameters:

session - CLI session

params - parsed parameters indexed by name

Returns:

action to perform for the parsed command

decode

public static String decode(Transaction tx,
 ByteData key)

Decode a key/value in the context of a Transaction.

Parameters:

tx - transaction

key - key to decode

Returns:

description of decoded key

Throws:

IllegalArgumentException - if either parameter is null