org.openepics.cable.model

Enum CableStatus

java.lang.Object

java.lang.Enum<CableStatus>

org.openepics.cable.model.CableStatus

All Implemented Interfaces:

Serializable, Comparable<CableStatus>

public enum CableStatus
extends Enum<CableStatus>

This represents the status of a Cable.

Author:

Sunil Sah

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPROVED The cable is approved, this is the default status.
COMMISSIONED Filters all commissioned cables
DELETED The cable is deleted.
INSERTED The cable is inserted.
NOT_IN_USE Filters all not in use cables
PULLED Filters all Pulled cables
ROUTED The cable is routed.

Method Summary

Modifier and Type	Method and Description
static CableStatus	convertToCableStatus(String value) Converts string value into Cable Status
String	getDisplayName()
static CableStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static CableStatus[]	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

INSERTED

public static final CableStatus INSERTED

The cable is inserted.

ROUTED

public static final CableStatus ROUTED

The cable is routed.

APPROVED

public static final CableStatus APPROVED

The cable is approved, this is the default status.

DELETED

public static final CableStatus DELETED

The cable is deleted.

PULLED

public static final CableStatus PULLED

Filters all Pulled cables

COMMISSIONED

public static final CableStatus COMMISSIONED

Filters all commissioned cables

NOT_IN_USE

public static final CableStatus NOT_IN_USE

Filters all not in use cables

Method Detail

values

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

Returns:

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

valueOf

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

getDisplayName

public String getDisplayName()

Returns:

the display name for this status

convertToCableStatus

public static CableStatus convertToCableStatus(String value)

Converts string value into Cable Status

Parameters:

value - string value of status

Returns:

the cable status that matches received value