com.avaya.conferencing.api.acp.control.operations
Enum StateChange

java.lang.Object
  java.lang.Enum<StateChange>
      com.avaya.conferencing.api.acp.control.operations.StateChange

All Implemented Interfaces:

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

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

Describes the different types of state change that can be effected.

Since:

5.1.0.0.29

Enum Constant Summary

OFF
Turns the state off.

ON
Turns the state on.

TOGGLE
Toggles the state.

Method Summary

abstract boolean	eval(boolean isOn, boolean on, boolean off) Evaluates between two different values depending on the current state and the type of state change.
abstract byte	eval(boolean isOn, byte on, byte off) Evaluates between two different values depending on the current state and the type of state change.
abstract char	eval(boolean isOn, char on, char off) Evaluates between two different values depending on the current state and the type of state change.
abstract double	eval(boolean isOn, double on, double off) Evaluates between two different values depending on the current state and the type of state change.
abstract float	eval(boolean isOn, float on, float off) Evaluates between two different values depending on the current state and the type of state change.
abstract int	eval(boolean isOn, int on, int off) Evaluates between two different values depending on the current state and the type of state change.
abstract long	eval(boolean isOn, long on, long off) Evaluates between two different values depending on the current state and the type of state change.
abstract short	eval(boolean isOn, short on, short off) Evaluates between two different values depending on the current state and the type of state change.
abstract <T> T	eval(boolean isOn, T on, T off) Evaluates between two different values depending on the current state and the type of state change.
static StateChange	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StateChange[]	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

TOGGLE

public static final StateChange TOGGLE

Toggles the state.

Since:

5.1.0.0.29

OFF

public static final StateChange OFF

Turns the state off.

Since:

5.1.0.0.29

ON

public static final StateChange ON

Turns the state on.

Since:

5.1.0.0.29

Method Detail

values

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

Returns:

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

valueOf

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

eval

public abstract <T> T eval(boolean isOn,
                           T on,
                           T off)

Evaluates between two different values depending on the current state and the type of state change.

Type Parameters:

T - The type-parameter.

Parameters:

isOn - true if the state is currently on.

on - The value to return to turn the state on.

off - The value to return to turn the state off.

Returns:

either the value to turn the state on or the value to turn the state off in accordance with the state change mode.

Since:

5.1.0.0.29

eval

public abstract int eval(boolean isOn,
                         int on,
                         int off)

Evaluates between two different values depending on the current state and the type of state change.

Parameters:

isOn - true if the state is currently on.

on - The value to return to turn the state on.

off - The value to return to turn the state off.

Returns:

either the value to turn the state on or the value to turn the state off in accordance with the state change mode.

Since:

5.1.0.0.29

eval

public abstract long eval(boolean isOn,
                          long on,
                          long off)

Evaluates between two different values depending on the current state and the type of state change.

Parameters:

isOn - true if the state is currently on.

on - The value to return to turn the state on.

off - The value to return to turn the state off.

Returns:

either the value to turn the state on or the value to turn the state off in accordance with the state change mode.

Since:

5.1.0.0.29

eval

public abstract short eval(boolean isOn,
                           short on,
                           short off)

Evaluates between two different values depending on the current state and the type of state change.

Parameters:

isOn - true if the state is currently on.

on - The value to return to turn the state on.

off - The value to return to turn the state off.

Returns:

either the value to turn the state on or the value to turn the state off in accordance with the state change mode.

Since:

5.1.0.0.29

eval

public abstract boolean eval(boolean isOn,
                             boolean on,
                             boolean off)

Evaluates between two different values depending on the current state and the type of state change.

Parameters:

isOn - true if the state is currently on.

on - The value to return to turn the state on.

off - The value to return to turn the state off.

Returns:

either the value to turn the state on or the value to turn the state off in accordance with the state change mode.

Since:

5.1.0.0.29

eval

public abstract char eval(boolean isOn,
                          char on,
                          char off)

Evaluates between two different values depending on the current state and the type of state change.

Parameters:

isOn - true if the state is currently on.

on - The value to return to turn the state on.

off - The value to return to turn the state off.

Returns:

either the value to turn the state on or the value to turn the state off in accordance with the state change mode.

Since:

5.1.0.0.29

eval

public abstract byte eval(boolean isOn,
                          byte on,
                          byte off)

Evaluates between two different values depending on the current state and the type of state change.

Parameters:

isOn - true if the state is currently on.

on - The value to return to turn the state on.

off - The value to return to turn the state off.

Returns:

either the value to turn the state on or the value to turn the state off in accordance with the state change mode.

Since:

5.1.0.0.29

eval

public abstract float eval(boolean isOn,
                           float on,
                           float off)

Evaluates between two different values depending on the current state and the type of state change.

Parameters:

isOn - true if the state is currently on.

on - The value to return to turn the state on.

off - The value to return to turn the state off.

Returns:

either the value to turn the state on or the value to turn the state off in accordance with the state change mode.

Since:

5.1.0.0.29

eval

public abstract double eval(boolean isOn,
                            double on,
                            double off)

Evaluates between two different values depending on the current state and the type of state change.

Parameters:

isOn - true if the state is currently on.

on - The value to return to turn the state on.

off - The value to return to turn the state off.

Returns:

either the value to turn the state on or the value to turn the state off in accordance with the state change mode.

Since:

5.1.0.0.29