hudson.init

Annotation Type Terminator

@Indexed
 @Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Terminator

Author:

Kohsuke Kawaguchi

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
TermMilestone	after Indicates that the specified milestone is necessary before executing this terminator.
String[]	attains Indicates the milestones that this terminator contributes to.
TermMilestone	before Indicates that this terminator is a necessary step before achieving the specified milestone.
String	displayName Key in Messages.properties that represents what this task is about.
String[]	requires Indicates the milestones necessary before executing this terminator.

Element Detail

after

public abstract TermMilestone after

Indicates that the specified milestone is necessary before executing this terminator.

This has the identical purpose as requires(), but it's separated to allow better type-safety when using TermMilestone as a requirement (since enum member definitions need to be constant.)

Default:

hudson.init.TermMilestone.STARTED

before

public abstract TermMilestone before

Indicates that this terminator is a necessary step before achieving the specified milestone.

This has the identical purpose as attains(). See after() for why there are two things to achieve the same goal.

Default:

hudson.init.TermMilestone.COMPLETED

requires

public abstract String[] requires

Indicates the milestones necessary before executing this terminator.

Default:

{}

attains

public abstract String[] attains

Indicates the milestones that this terminator contributes to. A milestone is considered attained if all the terminators that attains the given milestone completes. So it works as a kind of join.

Default:

{}

displayName

public abstract String displayName

Key in Messages.properties that represents what this task is about. Used for rendering the progress. Defaults to "${short class name}.${method Name}".

Default:

""