org.apache.reef.examples.group.bgd

Enum ControlMessages

java.lang.Object

java.lang.Enum<ControlMessages>

org.apache.reef.examples.group.bgd.ControlMessages

All Implemented Interfaces:

Serializable, Comparable<ControlMessages>

public enum ControlMessages
extends Enum<ControlMessages>
implements Serializable

Control messages used in BGD example.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ComputeGradientWithMinEta
ComputeGradientWithModel
DoLineSearch
DoLineSearchWithModel
Stop
Synchronize

Method Summary

Methods

Modifier and Type	Method and Description
static ControlMessages	valueOf(String name) Returns the enum constant of this type with the specified name.
static ControlMessages[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ComputeGradientWithModel

public static final ControlMessages ComputeGradientWithModel

ComputeGradientWithMinEta

public static final ControlMessages ComputeGradientWithMinEta

DoLineSearch

public static final ControlMessages DoLineSearch

DoLineSearchWithModel

public static final ControlMessages DoLineSearchWithModel

Synchronize

public static final ControlMessages Synchronize

Stop

public static final ControlMessages Stop

Method Detail

values

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

Returns:

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

valueOf

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