org.spicefactory.pimento.io
Enum PropertyState

java.lang.Object
  extended by java.lang.Enum<PropertyState>
      extended by org.spicefactory.pimento.io.PropertyState
All Implemented Interfaces:
Serializable, Comparable<PropertyState>

public enum PropertyState
extends Enum<PropertyState>

Represents the state of a property. Instances of this class are often included in entity snapshots instead of the actual values for the property, for example to represent lazy or inaccessible properties.

Author:
Jens Halm

Enum Constant Summary
INACCESSIBLE
          Represents a property value that is inaccessible, usually due to security constraints.
INITIALIZED
          Represents a normal initialized property value.
LAZY
          Represent a lazy association or collection that can be fetched in a separate request.
UNMODIFIED
          Represents an unmodified property value.
 
Method Summary
static PropertyState valueOf(String name)
          Returns the enum constant of this type with the specified name.
static PropertyState[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

INACCESSIBLE

public static final PropertyState INACCESSIBLE
Represents a property value that is inaccessible, usually due to security constraints.


LAZY

public static final PropertyState LAZY
Represent a lazy association or collection that can be fetched in a separate request.


INITIALIZED

public static final PropertyState INITIALIZED
Represents a normal initialized property value.


UNMODIFIED

public static final PropertyState UNMODIFIED
Represents an unmodified property value. Currently only used on the client side.

Method Detail

values

public static final PropertyState[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(PropertyState c : PropertyState.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static PropertyState 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