com.smartgwt.client.types
Enum JSONCircularReferenceMode

java.lang.Object
  extended by java.lang.Enum<JSONCircularReferenceMode>
      extended by com.smartgwt.client.types.JSONCircularReferenceMode
All Implemented Interfaces:
ValueEnum, Serializable, Comparable<JSONCircularReferenceMode>

public enum JSONCircularReferenceMode
extends Enum<JSONCircularReferenceMode>
implements ValueEnum

What the JSONEncoder should do when it encounters a circular reference in an object structure.


Enum Constant Summary
MARKER
          leave a string marker, the JSONEncoder.setCircularReferenceMarker(java.lang.String), wherever a circular reference is found
OMIT
          circular references in Arrays will be represented as a null entry, and objects will have a property with a null value
PATH
          leave a string marker followed by the path to the first occurrence of the circular reference from the top of the object tree that was serialized.
 
Method Summary
 String getValue()
           
static JSONCircularReferenceMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static JSONCircularReferenceMode[] 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

OMIT

public static final JSONCircularReferenceMode OMIT
circular references in Arrays will be represented as a null entry, and objects will have a property with a null value


MARKER

public static final JSONCircularReferenceMode MARKER
leave a string marker, the JSONEncoder.setCircularReferenceMarker(java.lang.String), wherever a circular reference is found


PATH

public static final JSONCircularReferenceMode PATH
leave a string marker followed by the path to the first occurrence of the circular reference from the top of the object tree that was serialized. This potentially allows the original object graph to be reconstructed.

Method Detail

values

public static JSONCircularReferenceMode[] 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 (JSONCircularReferenceMode c : JSONCircularReferenceMode.values())
    System.out.println(c);

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

valueOf

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

getValue

public String getValue()
Specified by:
getValue in interface ValueEnum