SMILA 1.0 API documentation

org.eclipse.smila.jobmanager.definitions
Enum JobRunMode

java.lang.Object
  extended by java.lang.Enum<JobRunMode>
      extended by org.eclipse.smila.jobmanager.definitions.JobRunMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<JobRunMode>

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

Available Job Run Modes.


Enum Constant Summary
RUNONCE
          run once mode.
STANDARD
          standard mode (default).
 
Field Summary
static java.util.List<JobRunMode> ALL_MODES
          list of all job run modes, in default priority order.
 
Method Summary
static java.util.List<JobRunMode> parseModes(AnySeq modesAny)
          convert sequence of mode values to list of JobRunModes.
static AnySeq toAny(java.util.Collection<JobRunMode> modes)
          convert modes to corresponding sequence of string values.
 java.lang.String toString()
          
static JobRunMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static JobRunMode[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

STANDARD

public static final JobRunMode STANDARD
standard mode (default).


RUNONCE

public static final JobRunMode RUNONCE
run once mode.

Field Detail

ALL_MODES

public static final java.util.List<JobRunMode> ALL_MODES
list of all job run modes, in default priority order.

Method Detail

values

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

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

valueOf

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

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Enum<JobRunMode>

parseModes

public static java.util.List<JobRunMode> parseModes(AnySeq modesAny)
                                             throws InvalidDefinitionException
convert sequence of mode values to list of JobRunModes.

Parameters:
modesAny - may be null.
Returns:
null if input was null or empty, else list of corresponding JobRunModes.
Throws:
InvalidDefinitionException - if input contains non-value anys or invalid values.

toAny

public static AnySeq toAny(java.util.Collection<JobRunMode> modes)
convert modes to corresponding sequence of string values.

Parameters:
modes - must not be null.
Returns:
corresponding sequence.

SMILA 1.0 API documentation