jenkins.scm.api.trait

Class SCMNavigatorTrait

java.lang.Object

hudson.model.AbstractDescribableImpl<T>

jenkins.scm.api.trait.SCMTrait<SCMNavigatorTrait>

jenkins.scm.api.trait.SCMNavigatorTrait

All Implemented Interfaces:

Describable<SCMNavigatorTrait>

Direct Known Subclasses:

RegexSCMSourceFilterTrait, WildcardSCMSourceFilterTrait

public abstract class SCMNavigatorTrait
extends SCMTrait<SCMNavigatorTrait>

Represents a trait of behaviour or configuration that can be applied to a SCMSource.

Since:

2.2.0

Constructor Summary

Constructors

Constructor and Description
SCMNavigatorTrait()

Method Summary

Modifier and Type	Method and Description
static List<SCMNavigatorTraitDescriptor>	_for(Class<? extends SCMNavigatorContext> contextClass, Class<? extends SCMSourceBuilder> builderClass) Returns the subset of SCMNavigatorTraitDescriptor instances that are applicable to the specified types of SCMNavigatorContext and SCMSourceBuilder.
static List<SCMNavigatorTraitDescriptor>	_for(SCMNavigatorDescriptor scmNavigator, Class<? extends SCMNavigatorContext> contextClass, Class<? extends SCMSourceBuilder> builderClass) Returns the subset of SCMNavigatorTraitDescriptor instances that are applicable to the specified SCMNavigatorDescriptor and specified types of SCMNavigatorContext and SCMSourceBuilder.
static DescriptorExtensionList<SCMNavigatorTrait,SCMNavigatorTraitDescriptor>	all() Returns all the SCMNavigatorTraitDescriptor instances.
void	applyToBuilder(SCMSourceBuilder<?,?> builder) Applies this trait to the SCMBuilder.
void	applyToContext(SCMNavigatorContext<?,?> context) Applies this trait to the SCMNavigatorContext.
SCMSourceObserver	applyToObserver(SCMSourceObserver observer) Applies this trait to an observer for use during a SCMNavigatorRequest.
protected void	decorateBuilder(SCMSourceBuilder<?,?> builder) SPI: Override this method to decorate a SCMBuilder.
protected void	decorateContext(SCMNavigatorContext<?,?> context) SPI: Override this method to decorate a SCMNavigatorContext.
protected SCMSourceObserver	decorateObserver(SCMSourceObserver observer) SPI: Override this method to decorate the SCMSourceObserver used during a SCMNavigatorRequest.
SCMNavigatorTraitDescriptor	getDescriptor()
protected boolean	includeCategory(SCMHeadCategory category) SPI: Override this method to control whether specific SCMHeadCategory instances are required.
boolean	isCategoryEnabled(SCMHeadCategory category) Checks if the supplied category is required by this trait.

Methods inherited from class jenkins.scm.api.trait.SCMTrait

asSetList, asSetList, find

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMNavigatorTrait

public SCMNavigatorTrait()

Method Detail

applyToContext

public final void applyToContext(SCMNavigatorContext<?,?> context)

Applies this trait to the SCMNavigatorContext.

Parameters:

context - the context.

decorateContext

protected void decorateContext(SCMNavigatorContext<?,?> context)

SPI: Override this method to decorate a SCMNavigatorContext. You can assume that your SCMNavigatorTraitDescriptor.isApplicableToContext(Class) is true within this method and that the provided context is an instance of SCMNavigatorTraitDescriptor.getContextClass().

Parameters:

context - the context (invariant: SCMNavigatorTraitDescriptor.isApplicableToContext(Class) is true and SCMNavigatorTraitDescriptor.getContextClass() Class.isInstance(Object)) is true)

applyToObserver

@NonNull
public final SCMSourceObserver applyToObserver(@NonNull
                                                        SCMSourceObserver observer)

Applies this trait to an observer for use during a SCMNavigatorRequest.

Parameters:

observer - the observer.

Returns:

the supplied observer or a wrapped variant of it.

decorateObserver

@NonNull
protected SCMSourceObserver decorateObserver(@NonNull
                                                      SCMSourceObserver observer)

SPI: Override this method to decorate the SCMSourceObserver used during a SCMNavigatorRequest.

Parameters:

observer - the observer.

Returns:

the supplied observer or a wrapped variant of it.

applyToBuilder

public final void applyToBuilder(SCMSourceBuilder<?,?> builder)

Applies this trait to the SCMBuilder.

Parameters:

builder - the builder.

decorateBuilder

protected void decorateBuilder(SCMSourceBuilder<?,?> builder)

SPI: Override this method to decorate a SCMBuilder. You can assume that your SCMNavigatorTraitDescriptor.isApplicableToBuilder(SCMSourceBuilder) is true within this method and that the provided builder is an instance of SCMNavigatorTraitDescriptor.getBuilderClass().

Parameters:

builder - the builder (invariant: SCMNavigatorTraitDescriptor.isApplicableToBuilder(SCMSourceBuilder) is true and SCMNavigatorTraitDescriptor.getBuilderClass() Class.isInstance(Object)) is true)

isCategoryEnabled

public final boolean isCategoryEnabled(@NonNull
                                       SCMHeadCategory category)

Checks if the supplied category is required by this trait.

Parameters:

category - the category.

Returns:

true if this trait requires the supplied category.

includeCategory

protected boolean includeCategory(@NonNull
                                  SCMHeadCategory category)

SPI: Override this method to control whether specific SCMHeadCategory instances are required.

Parameters:

category - the category.

Returns:

true to require the category.

getDescriptor

public SCMNavigatorTraitDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<SCMNavigatorTrait>

Overrides:

getDescriptor in class SCMTrait<SCMNavigatorTrait>

all

public static DescriptorExtensionList<SCMNavigatorTrait,SCMNavigatorTraitDescriptor> all()

Returns all the SCMNavigatorTraitDescriptor instances.

Returns:

all the SCMNavigatorTraitDescriptor instances.

_for

public static List<SCMNavigatorTraitDescriptor> _for(@CheckForNull
                                                     Class<? extends SCMNavigatorContext> contextClass,
                                                     @CheckForNull
                                                     Class<? extends SCMSourceBuilder> builderClass)

Returns the subset of SCMNavigatorTraitDescriptor instances that are applicable to the specified types of SCMNavigatorContext and SCMSourceBuilder.

Parameters:

contextClass - (optional) type of SCMNavigatorContext.

builderClass - (optional) type of SCMSourceBuilder.

Returns:

the list of matching SCMNavigatorTraitDescriptor instances.

_for

public static List<SCMNavigatorTraitDescriptor> _for(@CheckForNull
                                                     SCMNavigatorDescriptor scmNavigator,
                                                     @CheckForNull
                                                     Class<? extends SCMNavigatorContext> contextClass,
                                                     @CheckForNull
                                                     Class<? extends SCMSourceBuilder> builderClass)

Returns the subset of SCMNavigatorTraitDescriptor instances that are applicable to the specified SCMNavigatorDescriptor and specified types of SCMNavigatorContext and SCMSourceBuilder.

Parameters:

scmNavigator - (optional) SCMNavigatorDescriptor.

contextClass - (optional) type of SCMNavigatorContext.

builderClass - (optional) type of SCMSourceBuilder.

Returns:

the list of matching SCMNavigatorTraitDescriptor instances.