org.openepics.cable.ui

Enum CableStatusFilter

java.lang.Object

java.lang.Enum<CableStatusFilter>

org.openepics.cable.ui.CableStatusFilter

All Implemented Interfaces:

Serializable, Comparable<CableStatusFilter>

public enum CableStatusFilter
extends Enum<CableStatusFilter>

This represents the types of filters for cable status.

Author:

Sunil Sah

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Filters all cables.
COMMISSIONED Filters all commissioned cables
DELETED Filters all deleted cables.
NON_DELETED Filters all cables that aren't deleted.
NOT_IN_USE Filters all not in use cables
PULLED Filters all Pulled cables

Method Summary

Modifier and Type	Method and Description
String	getDisplayName()
static CableStatusFilter	valueOf(String name) Returns the enum constant of this type with the specified name.
static CableStatusFilter[]	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

ALL

public static final CableStatusFilter ALL

Filters all cables.

NON_DELETED

public static final CableStatusFilter NON_DELETED

Filters all cables that aren't deleted.

DELETED

public static final CableStatusFilter DELETED

Filters all deleted cables.

PULLED

public static final CableStatusFilter PULLED

Filters all Pulled cables

COMMISSIONED

public static final CableStatusFilter COMMISSIONED

Filters all commissioned cables

NOT_IN_USE

public static final CableStatusFilter NOT_IN_USE

Filters all not in use cables

Method Detail

values

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

Returns:

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

valueOf

public static CableStatusFilter 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 filter