org.dataone.service.types.v1

Enum NodeState

java.lang.Object

java.lang.Enum<NodeState>

org.dataone.service.types.v1.NodeState

All Implemented Interfaces:

Serializable, Comparable<NodeState>

public enum NodeState
extends Enum<NodeState>
implements Serializable

An indicator of the current node accessibility. Nodes that are marked *down* are inaccessible for service operations, those that are *up* are in the normal accessible state, and *unknown* indicates that the state has not been determined yet. Schema fragment(s) for this class:

 <xs:simpleType xmlns:ns="http://ns.dataone.org/service/types/v1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="NodeState">
   <xs:restriction base="xs:string">
     <xs:enumeration value="up"/>
     <xs:enumeration value="down"/>
     <xs:enumeration value="unknown"/>
   </xs:restriction>
 </xs:simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN
UNKNOWN
UP

Method Summary

Methods

Modifier and Type	Method and Description
static NodeState	convert(String value)
static NodeState	valueOf(String name) Returns the enum constant of this type with the specified name.
static NodeState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
String	xmlValue()

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

UP

public static final NodeState UP

DOWN

public static final NodeState DOWN

UNKNOWN

public static final NodeState UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

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

xmlValue

public String xmlValue()

convert

public static NodeState convert(String value)