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 UncategorizedSCMHeadCategory
DEFAULT
TheUncategorizedSCMHeadCategory
singleton with the default naming.
-
Constructor Summary
Constructors Constructor Description UncategorizedSCMHeadCategory(org.jvnet.localizer.Localizable displayName)
Constructs aUncategorizedSCMHeadCategory
with customized naming.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isMatch(SCMHead instance)
Checks if the supplied instance is a match for thisSCMCategory
.-
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
-
-
-
-
Field Detail
-
DEFAULT
public static final UncategorizedSCMHeadCategory DEFAULT
TheUncategorizedSCMHeadCategory
singleton with the default naming.
-
-
Constructor Detail
-
UncategorizedSCMHeadCategory
public UncategorizedSCMHeadCategory(@NonNull org.jvnet.localizer.Localizable displayName)
Constructs aUncategorizedSCMHeadCategory
with customized naming. Use this constructor when the generic naming is not appropriate terminology for the specificSCMSource
'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 anUncategorizedSCMHeadCategory
under thedefault
key that has aSCMCategory.getDisplayName()
ofBranches / Streams
- Parameters:
displayName
- the display name for the uncategorizedSCMHead
s when the source control system uses a different terminology from "branches".
-
-
Method Detail
-
isMatch
public boolean isMatch(@NonNull SCMHead instance)
Checks if the supplied instance is a match for thisSCMCategory
.- Specified by:
isMatch
in classSCMCategory<SCMHead>
- Parameters:
instance
- the instance to test.- Returns:
true
if the instance belongs to thisSCMCategory
.
-
-