jenkins.scm.api

Class SCMHeadCategory

java.lang.Object

jenkins.scm.api.SCMCategory<SCMHead>

jenkins.scm.api.SCMHeadCategory

Direct Known Subclasses:

ChangeRequestSCMHeadCategory, TagSCMHeadCategory, UncategorizedSCMHeadCategory

public abstract class SCMHeadCategory
extends SCMCategory<SCMHead>

Base class for categories of SCMHead, for example: branches, tags, change requests, mainlines, features, etc.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
SCMHeadCategory(org.jvnet.localizer.Localizable pronoun)
SCMHeadCategory(String urlName, org.jvnet.localizer.Localizable pronoun)

Method Summary

Modifier and Type	Method and Description
static List<SCMHeadCategory>	addUncategorizedIfMissing(List<SCMHeadCategory> categories) Ensures that the supplied list of categories includes the UncategorizedSCMHeadCategory.
static List<SCMHeadCategory>	collect(Iterable<SCMSource> sources) Iterates SCMSource instances collecting the unique list of SCMHeadCategory instances.
static Map<String,SCMHeadCategory>	collectAndSimplify(Iterable<SCMSource> sources) Collects the SCMHeadCategory instances from a set of SCMSource instances and simplifies the result.
protected org.jvnet.localizer.Localizable	defaultDisplayName() The default display name.
static Map<String,SCMHeadCategory>	simplify(Iterable<SCMHeadCategory> categories) Simplifies a collection of SCMHeadCategory replacing duplicates with their union(List).
static SCMHeadCategory	union(List<SCMHeadCategory> categories) Reduces a list of categories into a single composite category.

Methods inherited from class jenkins.scm.api.SCMCategory

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMHeadCategory

public SCMHeadCategory(@CheckForNull
                       org.jvnet.localizer.Localizable pronoun)

SCMHeadCategory

public SCMHeadCategory(@NonNull
                       String urlName,
                       @CheckForNull
                       org.jvnet.localizer.Localizable pronoun)

Method Detail

collect

@NonNull
public static List<SCMHeadCategory> collect(@NonNull
                                                     Iterable<SCMSource> sources)

Iterates SCMSource instances collecting the unique list of SCMHeadCategory instances.

Parameters:

sources - the SCMSource instances to iterate.

Returns:

the list of unique SCMHeadCategory instances.

addUncategorizedIfMissing

public static List<SCMHeadCategory> addUncategorizedIfMissing(List<SCMHeadCategory> categories)

Ensures that the supplied list of categories includes the UncategorizedSCMHeadCategory.

Parameters:

categories - the list of SCMHeadCategory instances (must be mutable)

Returns:

the supplied list for method chaining.

union

public static SCMHeadCategory union(List<SCMHeadCategory> categories)

Reduces a list of categories into a single composite category.

Parameters:

categories - the list of categories (must contain at least one element).

Returns:

a composite category.

simplify

public static Map<String,SCMHeadCategory> simplify(Iterable<SCMHeadCategory> categories)

Simplifies a collection of SCMHeadCategory replacing duplicates with their union(List).

Parameters:

categories - the collection of categories to simplify.

Returns:

the map of simplified categories keyed by SCMCategory.getName().

collectAndSimplify

public static Map<String,SCMHeadCategory> collectAndSimplify(@NonNull
                                                             Iterable<SCMSource> sources)

Collects the SCMHeadCategory instances from a set of SCMSource instances and simplifies the result.

Parameters:

sources - the SCMSource instances

Returns:

the map of simplified categories keyed by SCMCategory.getName().

See Also:

simplify(Iterable), addUncategorizedIfMissing(List), SCMCategory.group(Iterable), collect(Iterable)

defaultDisplayName

@NonNull
protected org.jvnet.localizer.Localizable defaultDisplayName()

The default display name.

Specified by:

defaultDisplayName in class SCMCategory<SCMHead>

Returns:

The generic term of a collection of things in this kind of SCMCategory.