com.spotify.helios.common.descriptors

Enum Goal

java.lang.Object

java.lang.Enum<Goal>

com.spotify.helios.common.descriptors.Goal

All Implemented Interfaces:

Serializable, Comparable<Goal>

public enum Goal
extends Enum<Goal>

An enum representing a Job Goal. That is: what would we like to do to the job?

Enum Constant Summary

Enum Constants

Enum Constant and Description
START
STOP
UNDEPLOY

Method Summary

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

START

public static final Goal START

STOP

public static final Goal STOP

UNDEPLOY

public static final Goal UNDEPLOY

Method Detail

values

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

Returns:

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

valueOf

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