com.persistit

Class KeyParser

java.lang.Object

com.persistit.KeyParser

public class KeyParser
extends Object

Parses String values as Key or KeyFilter values.

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
KeyParser(String source) Construct a KeyParser for the specified string.
KeyParser(String source, int offset, int size) Construct a KeyParser for a substring of the specified string.

Method Summary

Modifier and Type	Method and Description
int	getIndex() Return the current index for parsing.
boolean	parseKey(Key key) Parse a key value from the string or substring from which this KeyParser was constructed, modifying the supplied Key to contain the result.
KeyFilter	parseKeyFilter() Parse and returns a KeyFilter from the string or substring from which this KeyParser was constructed.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyParser

public KeyParser(String source)

Construct a KeyParser for the specified string.

Parameters:

source - The string to be parsed.

KeyParser

public KeyParser(String source,
                 int offset,
                 int size)

Construct a KeyParser for a substring of the specified string.

Parameters:

source - The string

offset - Offset of the first character of the substring to parse

size - Size of the substring

Method Detail

parseKey

public boolean parseKey(Key key)

Parse a key value from the string or substring from which this KeyParser was constructed, modifying the supplied Key to contain the result.

Returns:

true if the key value was parsed successfully. false if the string or substring was invalid as a string representation of a Key.

parseKeyFilter

public KeyFilter parseKeyFilter()

Parse and returns a KeyFilter from the string or substring from which this KeyParser was constructed.

Returns:

A KeyFilter or null if the string or substring was invalid as a string representation of a KeyFilter.

getIndex

public int getIndex()

Return the current index for parsing. This indicates the first character that did not conform

Returns:

The index