Package hudson.init

Enum Class TermMilestone

java.lang.Object

java.lang.Enum<TermMilestone>

hudson.init.TermMilestone

All Implemented Interfaces:

Serializable, Comparable<TermMilestone>, Constable, org.jvnet.hudson.reactor.Milestone

public enum TermMilestone
extends Enum<TermMilestone>
implements org.jvnet.hudson.reactor.Milestone

Various key milestone in the termination process of Jenkins.

Plugins can use these milestones to execute their tear down processing at the right moment (in addition to defining their own milestones by implementing Milestone.

These milestones are achieve in this order.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETED	The very last milestone This is used in Initializer.before() since annotations cannot have null as the default value.
STARTED	The very first milestone that gets achieved without doing anything.

Method Summary

Modifier and Type	Method	Description
static org.jvnet.hudson.reactor.TaskBuilder	ordering()	Creates a set of dummy tasks to enforce ordering among TermMilestones.
String	toString()
static TermMilestone	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TermMilestone[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STARTED

public static final TermMilestone STARTED

The very first milestone that gets achieved without doing anything. This is used in Initializer.after() since annotations cannot have null as the default value.

COMPLETED

public static final TermMilestone COMPLETED

The very last milestone This is used in Initializer.before() since annotations cannot have null as the default value.

Method Details

values

public static TermMilestone[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TermMilestone valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

ordering

public static org.jvnet.hudson.reactor.TaskBuilder ordering()

Creates a set of dummy tasks to enforce ordering among TermMilestones.

toString

public String toString()

Overrides:

toString in class Enum<TermMilestone>