com.cinchapi.concourse.validate

Class Keys

Object

Keys

public final class Keys
extends Object

Utility functions for data keys.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Keys.Key A parsed key that includes information about it's Keys.KeyType and some other data that may be useful in further processing.
static class	Keys.KeyType The various kinds of keys that can be parsed.

Method Summary

Modifier and Type	Method and Description
static boolean	isFunctionKey(String key) Return true if key is a function key.
static boolean	isNavigationKey(String key) Return true if key is a navigation key.
static boolean	isWritable(String key) Return true of the key is a valid data key for writing.
static Keys.Key	parse(String key) Parse key and return a Keys.Key object that contains the relevant information.
static ImplicitKeyRecordFunction	tryParseFunction(String key) If possible, parse the Function that is expressed by the key.

Methods inherited from class Object

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

Method Detail

isFunctionKey

public static boolean isFunctionKey(String key)

Return true if key is a function key.

Parameters:

key -

Returns:

true if the provided key is a function key

isNavigationKey

public static boolean isNavigationKey(String key)

Return true if key is a navigation key.

Parameters:

key -

Returns:

true if the provided key is a valid navigation key

isWritable

public static boolean isWritable(String key)

Return true of the key is a valid data key for writing.

Parameters:

key -

Returns:

true if the provided key is valid for writing

parse

public static Keys.Key parse(String key)

Parse key and return a Keys.Key object that contains the relevant information.

Parameters:

key -

Returns:

the parsed Keys.Key

tryParseFunction

@Nullable
public static ImplicitKeyRecordFunction tryParseFunction(String key)

If possible, parse the Function that is expressed by the key.

Parameters:

key -

Returns:

the parsed Function, if possible, otherwise null