Enum State
- All Implemented Interfaces:
Serializable
,Comparable<State>
Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file
operations. There are six possible states: OFFLINE
, ONLINE
, STARTING
,
STOPPING
, START_FAILED
, and STOP_FAILED
.
OFFLINE
indicates that the server exists, but that it is not available for file operations.
ONLINE
indicates that the server is available to perform file operations. STARTING
indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under
normal conditions, it can take a couple of minutes for the server to be completely operational. Both
START_FAILED
and STOP_FAILED
are error conditions.
-
Enum Constant Summary
Enum ConstantDescription -
Method Summary
Modifier and TypeMethodDescriptionstatic State
Use this in place of valueOf to convert the raw string returned by the service into the enum value.toString()
static State
Returns the enum constant of this type with the specified name.static State[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
OFFLINE
-
ONLINE
-
STARTING
-
STOPPING
-
START_FAILED
-
STOP_FAILED
-
UNKNOWN_TO_SDK_VERSION
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
toString
-
fromValue
Use this in place of valueOf to convert the raw string returned by the service into the enum value.- Parameters:
value
- real value- Returns:
- State corresponding to the value
-
knownValues
Use this in place ofvalues()
to return aSet
of all values known to the SDK. This will return all known enum values exceptUNKNOWN_TO_SDK_VERSION
.
-