org.jenkinsci.plugins.runselector

Class RunSelector

java.lang.Object

hudson.model.AbstractDescribableImpl<RunSelector>

org.jenkinsci.plugins.runselector.RunSelector

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<RunSelector>

Direct Known Subclasses:

AbstractSpecificRunSelector, FallbackRunSelector, ParameterizedRunSelector, StatusRunSelector, TriggeringRunSelector

public abstract class RunSelector
extends hudson.model.AbstractDescribableImpl<RunSelector>
implements hudson.ExtensionPoint

Extension point for enumerating builds to copy artifacts from. Subclasses should override getNextBuild(Job, RunSelectorContext). use RunSelectorDescriptor for its descriptor.

Author:

Alan Harder

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
RunSelector()

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Returns the display name for this selector.
hudson.model.Run<?,?>	getNextBuild(hudson.model.Job<?,?> job, RunSelectorContext context) Override this method to implement RunSelector.
hudson.model.Run<?,?>	select(hudson.model.Job<?,?> job, RunSelectorContext context)

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RunSelector

public RunSelector()

Method Detail

select

@CheckForNull
public hudson.model.Run<?,?> select(@Nonnull
                                                  hudson.model.Job<?,?> job,
                                                  @Nonnull
                                                  RunSelectorContext context)
                                           throws IOException,
                                                  InterruptedException

Parameters:

job - the job to pick a build from.

context - context for the current execution of runselector.

Returns:

the build matches this selectors and conditions stored in the context.

Throws:

IOException - if an error occurs while performing the operation.

InterruptedException - if any thread interrupts the current thread.

getNextBuild

@CheckForNull
public hudson.model.Run<?,?> getNextBuild(@Nonnull
                                                        hudson.model.Job<?,?> job,
                                                        @Nonnull
                                                        RunSelectorContext context)
                                                 throws IOException,
                                                        InterruptedException

Override this method to implement RunSelector. Use RunSelectorContext.getLastMatchBuild() to continue enumerating builds. Or you can save the execution state with RunSelectorContext.addExtension(Object)

Parameters:

job - the job to pick a build from.

context - context for the current execution of runselector.

Returns:

the build matches this selector.

Throws:

IOException - if an error occurs while performing the operation.

InterruptedException - if any thread interrupts the current thread.

getDisplayName

public String getDisplayName()

Returns the display name for this selector. You can override this to output configurations of this selector in verbose logs.

Returns:

the display name for this selector.