Package jenkins.scm.impl

Class UncategorizedSCMHeadCategory

java.lang.Object

jenkins.scm.api.SCMCategory<SCMHead>

jenkins.scm.api.SCMHeadCategory

jenkins.scm.impl.UncategorizedSCMHeadCategory

public final class UncategorizedSCMHeadCategory
extends SCMHeadCategory

Standard category for uncategorized instances.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final UncategorizedSCMHeadCategory	DEFAULT	The UncategorizedSCMHeadCategory singleton with the default naming.

Constructor Summary

Constructors

Constructor	Description
UncategorizedSCMHeadCategory(org.jvnet.localizer.Localizable displayName)	Constructs a UncategorizedSCMHeadCategory with customized naming.

Method Summary

Modifier and Type	Method	Description
boolean	isMatch(SCMHead instance)	Checks if the supplied instance is a match for this SCMCategory.

Methods inherited from class jenkins.scm.api.SCMHeadCategory

addUncategorizedIfMissing, collect, collectAndSimplify, defaultDisplayName, simplify, union

Methods inherited from class jenkins.scm.api.SCMCategory

getDisplayName, getName, group, group, isMatch, isUncategorized, toDisplayName, toDisplayName, toShortUrl, toShortUrl

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final UncategorizedSCMHeadCategory DEFAULT

The UncategorizedSCMHeadCategory singleton with the default naming.

Constructor Details

UncategorizedSCMHeadCategory

public UncategorizedSCMHeadCategory(@NonNull
 org.jvnet.localizer.Localizable displayName)

Constructs a UncategorizedSCMHeadCategory with customized naming. Use this constructor when the generic naming is not appropriate terminology for the specific SCMSource's naming of branches.

For example: the Accurev source control system uses the term "streams" to refer to the same thing that Git would call "branches", it would confuse Accurev users if we called their "streams" as "branches" so an Accurev specific provider would use this constructor to generate a singleton with the "streams" name. If there is a Git and Accurev source in the same context then SCMHeadCategory.collectAndSimplify(Iterable) will contain an UncategorizedSCMHeadCategory under the default key that has a SCMCategory.getDisplayName() of Branches / Streams

Parameters:

displayName - the display name for the uncategorized SCMHeads when the source control system uses a different terminology from "branches".

Method Details

isMatch

public boolean isMatch(@NonNull
 SCMHead instance)

Checks if the supplied instance is a match for this SCMCategory.

Specified by:

isMatch in class SCMCategory<SCMHead>

Parameters:

instance - the instance to test.

Returns:

true if the instance belongs to this SCMCategory.