Package org.jenkinsci.plugins.runselector

Class RunFilter

java.lang.Object

hudson.model.AbstractDescribableImpl<RunFilter>

org.jenkinsci.plugins.runselector.RunFilter

All Implemented Interfaces:

ExtensionPoint, Describable<RunFilter>

Direct Known Subclasses:

AndRunFilter, DisplayNameRunFilter, DownstreamRunFilter, NoRunFilter, NotRunFilter, OrRunFilter, ParameterizedRunFilter, ParametersRunFilter, SavedRunFilter

public abstract class RunFilter
extends AbstractDescribableImpl<RunFilter>
implements ExtensionPoint

Additional filters used by RunSelector. Use RunFilterDescriptor for its descriptor.

Author:

Alan Harder

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
RunFilter()

Method Summary

Modifier and Type	Method	Description
static List<RunFilterDescriptor>	all()
static List<RunFilterDescriptor>	allWithNoRunFilter()
RunFilterDescriptor	getDescriptor()
String	getDisplayName()	Returns the display name for this filters.
boolean	isSelectable(Run<?,?> candidate, RunSelectorContext context)

Methods inherited from class java.lang.Object

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

Constructor Details

RunFilter

public RunFilter()

Method Details

isSelectable

public boolean isSelectable(@NonNull
 Run<?,?> candidate,
 @NonNull
 RunSelectorContext context)

Parameters:

candidate - the build to check

context - the context of current runselector execution.

Returns:

whether this build can be selected.

getDescriptor

public RunFilterDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<RunFilter>

Overrides:

getDescriptor in class AbstractDescribableImpl<RunFilter>

all

public static List<RunFilterDescriptor> all()

Returns:

all descriptors of RunFilter without NoRunFilter

allWithNoRunFilter

public static List<RunFilterDescriptor> allWithNoRunFilter()

Returns:

all descriptors of RunFilter including NoRunFilter

getDisplayName

public String getDisplayName()

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

Returns:

the display name for this filters.