org.odpi.openmetadata.accessservices.subjectarea.properties.enums

Enum OperationalStatus

java.lang.Object

java.lang.Enum<OperationalStatus>

org.odpi.openmetadata.accessservices.subjectarea.properties.enums.OperationalStatus

All Implemented Interfaces:

Serializable, Comparable<OperationalStatus>

public enum OperationalStatus
extends Enum<OperationalStatus>
implements Serializable

Defines whether a component is operational.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Disabled The component is not operational.
Enabled The component is operational.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the description for the enum.
String	getName() Return the descriptive name for the OperationalStatus enum instance
int	getOrdinal() Return the numerical value for the enum.
static OperationalStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static OperationalStatus[]	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

Disabled

public static final OperationalStatus Disabled

The component is not operational.

Enabled

public static final OperationalStatus Enabled

The component is operational.

Method Detail

values

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

Returns:

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

valueOf

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

getOrdinal

public int getOrdinal()

Return the numerical value for the enum.

Returns:

int enum value ordinal

getDescription

public String getDescription()

Return the description for the enum.

Returns:

String description

getName

public String getName()

Return the descriptive name for the OperationalStatus enum instance

Returns:

String name