Package hudson.views

Class ViewJobFilter

java.lang.Object

hudson.views.ViewJobFilter

All Implemented Interfaces:

ExtensionPoint, Describable<ViewJobFilter>

Direct Known Subclasses:

StatusFilter

public abstract class ViewJobFilter
extends Object
implements ExtensionPoint, Describable<ViewJobFilter>

Each ViewJobFilter contributes to or removes from the list of Jobs for a view.

Author:

Jacob Robertson

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ViewJobFilter()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<ViewJobFilter,Descriptor<ViewJobFilter>>	all()	Returns all the registered ViewJobFilter descriptors.
abstract List<TopLevelItem>	filter(List<TopLevelItem> added, List<TopLevelItem> all, View filteringView)	Choose which jobs to show for a view.
Descriptor<ViewJobFilter>	getDescriptor()	Gets the descriptor for this instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ViewJobFilter

public ViewJobFilter()

Method Details

all

public static DescriptorExtensionList<ViewJobFilter,Descriptor<ViewJobFilter>> all()

Returns all the registered ViewJobFilter descriptors.

getDescriptor

public Descriptor<ViewJobFilter> getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

Specified by:

getDescriptor in interface Describable<ViewJobFilter>

filter

public abstract List<TopLevelItem> filter(List<TopLevelItem> added,
 List<TopLevelItem> all,
 View filteringView)

Choose which jobs to show for a view.

Parameters:

added - which jobs have been added so far. This JobFilter can remove or add to this list.

all - All jobs that are possible.

filteringView - The view that we are filtering jobs for.

Returns:

a new list based off of the jobs added so far, and all jobs available.