StateObject.State (dotify.library 1.0.5 API)

java.lang.Object
- java.lang.Enum<StateObject.State>
- - org.daisy.dotify.common.io.StateObject.State

All Implemented Interfaces:

Serializable, Comparable<StateObject.State>

Enclosing class:

StateObject
```
public static enum StateObject.State
extends Enum<StateObject.State>
```
Possible states for a StateObject.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`CLOSED`	Indicates that the StateObject has been open, but is now closed.
`OPEN`	Indicates that the StateObject is open.
`UNOPENED`	Indicates that the StateObject has not yet been opened.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static StateObject.State`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static StateObject.State[]`	`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
  - UNOPENED
```
public static final StateObject.State UNOPENED
```
    Indicates that the StateObject has not yet been opened.
  - OPEN
```
public static final StateObject.State OPEN
```
    Indicates that the StateObject is open.
  - CLOSED
```
public static final StateObject.State CLOSED
```
    Indicates that the StateObject has been open, but is now closed.
- Method Detail
  - values
```
public static StateObject.State[] 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 (StateObject.State c : StateObject.State.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StateObject.State 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