Package net.solarnetwork.node.service

Enum Class PlatformService.PlatformState

java.lang.Object

java.lang.Enum<PlatformService.PlatformState>

net.solarnetwork.node.service.PlatformService.PlatformState

All Implemented Interfaces:

Serializable, Comparable<PlatformService.PlatformState>, Constable

Enclosing interface:

PlatformService

public static enum PlatformService.PlatformState
extends Enum<PlatformService.PlatformState>

An enumeration of possible platform states.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Normal	A normal state, without any specific restrictions in place.
Restarting	The platform is restarting.
UserBlockingSystemTask	A task is being performed that restricts user interactions until the task completes.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Normal

public static final PlatformService.PlatformState Normal

A normal state, without any specific restrictions in place.

UserBlockingSystemTask

public static final PlatformService.PlatformState UserBlockingSystemTask

A task is being performed that restricts user interactions until the task completes.

Restarting

public static final PlatformService.PlatformState Restarting

The platform is restarting.

Method Details

values

public static PlatformService.PlatformState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PlatformService.PlatformState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null