Package io.permazen.cli.cmd

Class KVGetCommand

java.lang.Object

io.permazen.cli.cmd.AbstractCommand

io.permazen.cli.cmd.AbstractKVCommand

io.permazen.cli.cmd.KVGetCommand

All Implemented Interfaces:

Command

public class KVGetCommand
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
KVGetCommand()

Method Summary

Modifier and Type	Method	Description
static long	dumpRange(PrintStream writer, Iterator<KVPair> iter)	Print a hex and ASCII decode of the given key/value pairs.
static long	dumpRange(PrintStream writer, Iterator<KVPair> iter, boolean cstrings, boolean novalues, long limit)	Print a hex and ASCII decode of the given key/value pairs.
Session.Action	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).
EnumSet<SessionMode>	getSessionModes()	Get the SessionMode(s) supported by this command.

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

fromCString, getParser, toCString

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

execute, getName, getUsage

Methods inherited from class java.lang.Object

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

Constructor Details

KVGetCommand

public KVGetCommand()

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

getSessionModes

public EnumSet<SessionMode> getSessionModes()

Description copied from class: AbstractCommand

Get the SessionMode(s) supported by this command.

The implementation in AbstractCommand returns an EnumSet containing SessionMode.CORE_API and SessionMode.PERMAZEN.

Specified by:

getSessionModes in interface Command

Overrides:

getSessionModes in class AbstractCommand

Returns:

set of supported SessionModes

getAction

public Session.Action 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

dumpRange

public static long dumpRange(PrintStream writer,
 Iterator<KVPair> iter)

Print a hex and ASCII decode of the given key/value pairs.

Parameters:

writer - print output

iter - key/value pair iteration

Returns:

the number of key/value pairs printed

Throws:

IllegalArgumentException - if writer or iter is null

dumpRange

public static long dumpRange(PrintStream writer,
 Iterator<KVPair> iter,
 boolean cstrings,
 boolean novalues,
 long limit)

Print a hex and ASCII decode of the given key/value pairs.

Parameters:

writer - print output

iter - key/value pair iteration

cstrings - decode keys and values as strings

novalues - only print the keys, omitting the values

limit - stop after this many key/value pairs

Returns:

the number of key/value pairs printed

Throws:

IllegalArgumentException - if limit is negative

IllegalArgumentException - if writer or iter is null