com.atlassian.scheduler.status
Enum RunOutcome

java.lang.Object
  extended by java.lang.Enum<RunOutcome>
      extended by com.atlassian.scheduler.status.RunOutcome
All Implemented Interfaces:
Serializable, Comparable<RunOutcome>

@PublicApi
public enum RunOutcome
extends Enum<RunOutcome>

Indicates what the result was the last time that this job attempted to fire.


Enum Constant Summary
ABORTED
          We did not start the job at the scheduled time because it was not ready.
FAILED
          The job was started but it either threw an exception or returned a JobRunnerResponse that indicated the job had failed.
SUCCESS
          The job ran successfully.
UNAVAILABLE
          The job had no job runner registered when an attempt was made to fire it.
 
Method Summary
static RunOutcome valueOf(String name)
          Returns the enum constant of this type with the specified name.
static RunOutcome[] 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

SUCCESS

public static final RunOutcome SUCCESS
The job ran successfully.


UNAVAILABLE

public static final RunOutcome UNAVAILABLE
The job had no job runner registered when an attempt was made to fire it. This likely means that the job is left over from an older version of the application or from an add-on that is no longer installed.

Note: This outcome is only produced by the scheduler implementations; it cannot be returned in a JobRunnerResponse.


ABORTED

public static final RunOutcome ABORTED
We did not start the job at the scheduled time because it was not ready. Some possible causes include:


FAILED

public static final RunOutcome FAILED
The job was started but it either threw an exception or returned a JobRunnerResponse that indicated the job had failed.

Method Detail

values

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

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

valueOf

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


Copyright © 2014 Atlassian. All Rights Reserved.