org.radix.serialization2

Enum DsonOutput.Output

java.lang.Object

java.lang.Enum<DsonOutput.Output>

org.radix.serialization2.DsonOutput.Output

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DsonOutput.Output>

Enclosing class:

DsonOutput

public static enum DsonOutput.Output
extends java.lang.Enum<DsonOutput.Output>

Output modes for serialization.

There are four concrete output modes, HASH, API, WIRE and PERSIST. Two additional modes are provided for ease of use ALL and NONE, representing the union of all the concrete modes, and the empty set respectively.

Note that the output mode NONE is of limited use.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL An output mode that always results in output.
API An output mode for use with application interfaces.
HASH An output mode for calculating hashes.
NONE An output mode that never results in output.
PERSIST An output mode for use when writing data to persistent storage.
WIRE An output mode for use when communicating to other nodes.

Method Summary

Modifier and Type	Method and Description
static java.util.EnumSet<DsonOutput.Output>	toEnumSet(DsonOutput.Output[] value, boolean include) Convert enclosing annotation values to an EnumSet.
static DsonOutput.Output	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DsonOutput.Output[]	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

NONE

public static final DsonOutput.Output NONE

An output mode that never results in output. Of limited use.

HASH

public static final DsonOutput.Output HASH

An output mode for calculating hashes.

API

public static final DsonOutput.Output API

An output mode for use with application interfaces.

WIRE

public static final DsonOutput.Output WIRE

An output mode for use when communicating to other nodes.

PERSIST

public static final DsonOutput.Output PERSIST

An output mode for use when writing data to persistent storage.

ALL

public static final DsonOutput.Output ALL

An output mode that always results in output.

Method Detail

values

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

Returns:

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

valueOf

public static DsonOutput.Output valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

toEnumSet

public static java.util.EnumSet<DsonOutput.Output> toEnumSet(DsonOutput.Output[] value,
                                                             boolean include)

Convert enclosing annotation values to an EnumSet.

Parameters:

value - The values from the annotation

include - The include flag from the annotation

Returns:

An EnumSet identifying the DsonOutput.Output modes to output fields for.