Package io.permazen.cli.cmd

Class AbstractKVCommand

java.lang.Object

io.permazen.cli.cmd.AbstractCommand

io.permazen.cli.cmd.AbstractKVCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

DecodeKeyCommand, KVGetCommand, KVLoadCommand, KVPutCommand, KVRemoveCommand, KVSaveCommand

public abstract class AbstractKVCommand
extends AbstractCommand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractKVCommand.BytesParser	Parses byte[] data as hexadecimal or doubly-quoted "C" style string.
static interface	AbstractKVCommand.KVAction

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	CSTRING_PATTERN	Matches the doubly-quoted C strings returnd by toCString().
static final Pattern	HEXBYTES_PATTERN	Matches hexadecimal byte strings.

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

log, name, paramParser

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractKVCommand(String spec)

Method Summary

Modifier and Type	Method	Description
static ByteData	fromCString(String string)	Parse byte[] data encoded as a double-quoted C-string representation by toCString().
protected Parser<?>	getParser(String typeName)	Convert parameter spec type name into a Parser.
static String	toCString(ByteData data)	Convert byte[] data into a double-quoted C-string representation, surrounded by double quotes, with non-ASCII bytes, double-quotes, and backslashes escaped with a backslash.

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

execute, getAction, getHelpDetail, getHelpSummary, getName, getSessionModes, getUsage

Methods inherited from class java.lang.Object

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

Field Details

CSTRING_PATTERN

public static final Pattern CSTRING_PATTERN

Matches the doubly-quoted C strings returnd by toCString().

HEXBYTES_PATTERN

public static final Pattern HEXBYTES_PATTERN

Matches hexadecimal byte strings.

Constructor Details

AbstractKVCommand

protected AbstractKVCommand(String spec)

Method Details

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 AbstractCommand

Parameters:

typeName - parameter encoding ID or encoding ID alias

Returns:

parser for parameters of the specified type

toCString

public static String toCString(ByteData data)

Convert byte[] data into a double-quoted C-string representation, surrounded by double quotes, with non-ASCII bytes, double-quotes, and backslashes escaped with a backslash.

Supported escapes are \\, \", \b, \f, \t, \n, \r, and \xNN.

Parameters:

data - byte array

Returns:

C string representation

fromCString

public static ByteData fromCString(String string)

Parse byte[] data encoded as a double-quoted C-string representation by toCString().

Parameters:

string - C string

Returns:

byte data

Throws:

IllegalArgumentException - if string is malformed