net.sourceforge.obby4j
Enum DocumentContents.State

java.lang.Object
  java.lang.Enum<DocumentContents.State>
      net.sourceforge.obby4j.DocumentContents.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentContents.State>

Enclosing class:

DocumentContents

public static enum DocumentContents.State
extends java.lang.Enum<DocumentContents.State>

The states a document's content can be in.

Enum Constant Summary

READY
The general post-synchronization state in which client-side modifications are accepted.

SYNCING
While in this state, the contents are sychronized from the server and any client-side modification of the contents is not allowed.

Method Summary

static DocumentContents.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DocumentContents.State[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

READY

public static final DocumentContents.State READY

The general post-synchronization state in which client-side modifications are accepted.

SYNCING

public static final DocumentContents.State SYNCING

While in this state, the contents are sychronized from the server and any client-side modification of the contents is not allowed.

Method Detail

valueOf

public static DocumentContents.State 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

values

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

Returns:

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