Package jenkins.branch

Class SimpleViewBranchFilter

java.lang.Object

hudson.views.ViewJobFilter

jenkins.branch.SimpleViewBranchFilter

All Implemented Interfaces:

ExtensionPoint, Describable<ViewJobFilter>

public abstract class SimpleViewBranchFilter
extends ViewJobFilter

Base class for a ViewJobFilter that will filter based on the Branch that a job in a MultiBranchProject belongs to.

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
SimpleViewBranchFilter()

Method Summary

Modifier and Type	Method	Description
List<TopLevelItem>	filter(List<TopLevelItem> added, List<TopLevelItem> all, View filteringView)
boolean	isExcluded(Branch branch)	Tests if the supplied branch should be excluded.
abstract boolean	isIncluded(Branch branch)	Tests if the supplied branch should be included.

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 Detail

SimpleViewBranchFilter

public SimpleViewBranchFilter()

Method Detail

filter

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

Specified by:

filter in class ViewJobFilter

isExcluded

public boolean isExcluded(Branch branch)

Tests if the supplied branch should be excluded.

Parameters:

branch - the Branch.

Returns:

true to exclude the branch from the view.

isIncluded

public abstract boolean isIncluded(Branch branch)

Tests if the supplied branch should be included. Inclusion wins over exclusion.

Parameters:

branch - the Branch.

Returns:

true to include the branch from the view.