Package hudson.views

Class StatusFilter

java.lang.Object

hudson.views.ViewJobFilter

hudson.views.StatusFilter

All Implemented Interfaces:

ExtensionPoint, Describable<ViewJobFilter>

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public final class StatusFilter
extends ViewJobFilter

Job Filter that will filter jobs based on its disabled status

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatusFilter.StatusFilterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
StatusFilter(boolean statusFilter)	Creates a new status filter based on supplied boolean

Method Summary

Modifier and Type	Method	Description
List<TopLevelItem>	filter(List<TopLevelItem> added, List<TopLevelItem> all, View filteringView)	Choose which jobs to show for a view.
boolean	getStatusFilter()	The setting of the job status filter

Methods inherited from class hudson.views.ViewJobFilter

all, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

StatusFilter

@DataBoundConstructor
public StatusFilter(boolean statusFilter)

Creates a new status filter based on supplied boolean

Parameters:

statusFilter - true for enabled jobs only and false for disabled jobs only

Method Details

filter

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

Choose which jobs to show for a view.

Specified by:

filter in class ViewJobFilter

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.

getStatusFilter

public boolean getStatusFilter()

The setting of the job status filter

Returns:

true if only enabled jobs are shown and false if only disabled jobs are shown