org.xmpp.util

Enum ValueWrapper.Representation

java.lang.Object

java.lang.Enum<ValueWrapper.Representation>

org.xmpp.util.ValueWrapper.Representation

All Implemented Interfaces:

Serializable, Comparable<ValueWrapper.Representation>

Enclosing class:

ValueWrapper<V>

public static enum ValueWrapper.Representation
extends Enum<ValueWrapper.Representation>

Indication of how the key of this cache entry represents the cache value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ILLEGAL The key that maps to this ValueWrapper instance cannot be used to generate a valid value.
USE_KEY The generated value based on the key that maps to this ValueWrapper would be an exact duplicate of the key.
USE_VALUE The key that maps to this ValueWrapper can be used to generate a valid value.

Method Summary

Modifier and Type	Method and Description
static ValueWrapper.Representation	valueOf(String name) Returns the enum constant of this type with the specified name.
static ValueWrapper.Representation[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ILLEGAL

public static final ValueWrapper.Representation ILLEGAL

The key that maps to this ValueWrapper instance cannot be used to generate a valid value.

USE_KEY

public static final ValueWrapper.Representation USE_KEY

The generated value based on the key that maps to this ValueWrapper would be an exact duplicate of the key. To conserve memory, this wrapped value instance will not have a value set. Use the key that points to this wrapper instead.

USE_VALUE

public static final ValueWrapper.Representation USE_VALUE

The key that maps to this ValueWrapper can be used to generate a valid value. The generated value is wrapped in this ValueWrapper instance.

Method Detail

values

public static ValueWrapper.Representation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ValueWrapper.Representation c : ValueWrapper.Representation.values())
    System.out.println(c);

Returns:

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

valueOf

public static ValueWrapper.Representation 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