DESY ACOP Beans Home

de.desy.acop.video.displayer
Enum OverlayState

java.lang.Object
  java.lang.Enum<OverlayState>
      de.desy.acop.video.displayer.OverlayState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OverlayState>

public enum OverlayState
extends java.lang.Enum<OverlayState>

Overlay information enumeration

Author:

mdavid

Enum Constant Summary

AUTO
overlay information appears when moving over video frame.

OFF
overlay information always disabled.

ON
overlay information always enabled.

Method Summary

java.lang.String	getDescription()
static OverlayState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OverlayState[]	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

ON

public static final OverlayState ON

overlay information always enabled.

OFF

public static final OverlayState OFF

overlay information always disabled.

AUTO

public static final OverlayState AUTO

overlay information appears when moving over video frame.

Method Detail

values

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

Returns:

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

valueOf

public static OverlayState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDescription

public java.lang.String getDescription()