Package com.googlecode.objectify.util

Enum KeyFormat

java.lang.Object

java.lang.Enum<KeyFormat>

com.googlecode.objectify.util.KeyFormat

All Implemented Interfaces:

Serializable, Comparable<KeyFormat>, java.lang.constant.Constable

public enum KeyFormat
extends Enum<KeyFormat>

The new Cloud SDK has a new format for "url safe strings". This code lets us read and write the old-style GAE standard web safe string format.

Author:

Fred Wulff

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
String	formatOldStyleAppEngineKey(com.google.cloud.datastore.Key key)
com.google.cloud.datastore.Key	parseOldStyleAppEngineKey(String urlsafeKey)
static KeyFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KeyFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final KeyFormat INSTANCE

Method Details

values

public static KeyFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeyFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

parseOldStyleAppEngineKey

public com.google.cloud.datastore.Key parseOldStyleAppEngineKey(String urlsafeKey)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

formatOldStyleAppEngineKey

public String formatOldStyleAppEngineKey(com.google.cloud.datastore.Key key)