Uses of Class
jenkins.scm.api.SCMHeadCategory
Package
Description
The public API contract of the SCM API plugin.
An API/SPI to allow the sharing of common traits between different
SCMSource
and
SCMNavigator
implementations.The common implementations of classes in the public API.
-
Uses of SCMHeadCategory in jenkins.scm.api
Modifier and TypeFieldDescriptionprotected Set<SCMHeadCategory>
SCMSourceDescriptor.categories
The set ofSCMHeadCategory
singletons for this type ofSCMSource
Modifier and TypeMethodDescriptionprotected SCMHeadCategory[]
SCMSourceDescriptor.createCategories()
Creates the singletonSCMHeadCategory
instances that this type ofSCMSource
is capable of producing.static SCMHeadCategory
SCMHeadCategory.union
(List<SCMHeadCategory> categories) Reduces a list of categories into a single composite category.Modifier and TypeMethodDescriptionstatic List<SCMHeadCategory>
SCMHeadCategory.addUncategorizedIfMissing
(List<SCMHeadCategory> categories) Ensures that the supplied list of categories includes theUncategorizedSCMHeadCategory
.static List<SCMHeadCategory>
IteratesSCMSource
instances collecting the unique list ofSCMHeadCategory
instances.static Map<String,
SCMHeadCategory> SCMHeadCategory.collectAndSimplify
(Iterable<SCMSource> sources) Collects theSCMHeadCategory
instances from a set ofSCMSource
instances and simplifies the result.final Set<? extends SCMHeadCategory>
SCMSource.getCategories()
Returns the set ofSCMHeadCategory
that thisSCMSource
supports.final Set<SCMHeadCategory>
SCMSourceDescriptor.getCategories()
Returns the set ofSCMHeadCategory
that thisSCMSource
supports.static Map<String,
SCMHeadCategory> SCMHeadCategory.simplify
(Iterable<SCMHeadCategory> categories) Simplifies a collection ofSCMHeadCategory
replacing duplicates with theirunion(List)
.Modifier and TypeMethodDescriptionprotected boolean
SCMSource.isCategoryEnabled
(SCMHeadCategory category) Sub-classes can override this method to filter the categories that are available from a specific source.Modifier and TypeMethodDescriptionstatic List<SCMHeadCategory>
SCMHeadCategory.addUncategorizedIfMissing
(List<SCMHeadCategory> categories) Ensures that the supplied list of categories includes theUncategorizedSCMHeadCategory
.static Map<String,
SCMHeadCategory> SCMHeadCategory.simplify
(Iterable<SCMHeadCategory> categories) Simplifies a collection ofSCMHeadCategory
replacing duplicates with theirunion(List)
.static SCMHeadCategory
SCMHeadCategory.union
(List<SCMHeadCategory> categories) Reduces a list of categories into a single composite category. -
Uses of SCMHeadCategory in jenkins.scm.api.trait
Modifier and TypeMethodDescriptionprotected boolean
SCMNavigatorTrait.includeCategory
(SCMHeadCategory category) SPI: Override this method to control whether specificSCMHeadCategory
instances are required.protected boolean
SCMSourceTrait.includeCategory
(SCMHeadCategory category) SPI: Override this method to control whether specificSCMHeadCategory
instances are required.final boolean
SCMNavigatorTrait.isCategoryEnabled
(SCMHeadCategory category) Checks if the supplied category is required by this trait.final boolean
SCMSourceTrait.isCategoryEnabled
(SCMHeadCategory category) Checks if the supplied category is required by this trait. -
Uses of SCMHeadCategory in jenkins.scm.impl
Modifier and TypeClassDescriptionfinal class
Standard category forSCMHead
instances that implementChangeRequestSCMHead
.final class
Standard category forSCMHead
instances that implementTagSCMHead
.final class
Standard category for uncategorized instances.