com.tinkerpop.blueprints.util.io.graphson

Enum GraphSONMode

java.lang.Object

java.lang.Enum<GraphSONMode>

com.tinkerpop.blueprints.util.io.graphson.GraphSONMode

All Implemented Interfaces:

Serializable, Comparable<GraphSONMode>

public enum GraphSONMode
extends Enum<GraphSONMode>

Modes of operation of the GraphSONUtility.

Author:

Stephen Mallette

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPACT COMPACT constructs GraphSON on the assumption that all property keys are fair game for exclusion including _type, _inV, _outV, _label and _id.
EXTENDED EXTENDED includes the _type field and explicit data typing.
NORMAL NORMAL includes the _type field and JSON data typing.

Method Summary

Methods

Modifier and Type	Method and Description
static GraphSONMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static GraphSONMode[]	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

COMPACT

public static final GraphSONMode COMPACT

COMPACT constructs GraphSON on the assumption that all property keys are fair game for exclusion including _type, _inV, _outV, _label and _id. It is possible to write GraphSON that cannot be read back into Graph, if some or all of these keys are excluded.

NORMAL

public static final GraphSONMode NORMAL

NORMAL includes the _type field and JSON data typing.

EXTENDED

public static final GraphSONMode EXTENDED

EXTENDED includes the _type field and explicit data typing.

Method Detail

values

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

Returns:

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

valueOf

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