jenkins.scm.api.trait

Class SCMSourceTrait

java.lang.Object

hudson.model.AbstractDescribableImpl<T>

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

jenkins.scm.api.trait.SCMSourceTrait

All Implemented Interfaces:

Describable<SCMSourceTrait>

Direct Known Subclasses:

RegexSCMHeadFilterTrait, WildcardSCMHeadFilterTrait

public abstract class SCMSourceTrait
extends SCMTrait<SCMSourceTrait>

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

Since:

2.2.0

Constructor Summary

Constructors

Constructor and Description
SCMSourceTrait()

Method Summary

Modifier and Type	Method and Description
static List<SCMSourceTraitDescriptor>	_for(Class<? extends SCMSourceContext> contextClass, Class<? extends SCMBuilder> builderClass) Returns the subset of SCMSourceTraitDescriptor instances that are applicable to the specified types of SCMSourceContext and SCMSourceBuilder.
static List<SCMSourceTraitDescriptor>	_for(SCMSourceDescriptor scmSource, Class<? extends SCMSourceContext> contextClass, Class<? extends SCMBuilder> builderClass) Returns the subset of SCMSourceTraitDescriptor instances that are applicable to the specified SCMSourceDescriptor and specified types of SCMNavigatorContext and SCMSourceBuilder.
static DescriptorExtensionList<SCMSourceTrait,SCMSourceTraitDescriptor>	all() Returns all the SCMSourceTraitDescriptor instances.
void	applyToBuilder(SCMBuilder<?,?> builder) Applies this trait to the SCMBuilder.
void	applyToContext(SCMSourceContext<?,?> context) Applies this trait to the SCMSourceContext.
SCMHeadObserver	applyToObserver(SCMHeadObserver observer) Applies this trait to an observer for use during a SCMSourceRequest.
protected void	decorateBuilder(SCMBuilder<?,?> builder) SPI: Override this method to decorate a SCMBuilder.
protected void	decorateContext(SCMSourceContext<?,?> context) SPI: Override this method to decorate a SCMSourceContext.
protected SCMHeadObserver	decorateObserver(SCMHeadObserver observer) SPI: Override this method to decorate the SCMHeadObserver used during a SCMSourceRequest.
SCMSourceTraitDescriptor	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

SCMSourceTrait

public SCMSourceTrait()

Method Detail

applyToContext

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

Applies this trait to the SCMSourceContext.

Parameters:

context - the context.

decorateContext

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

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

Parameters:

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

applyToObserver

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

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

Parameters:

observer - the observer.

Returns:

the supplied observer or a wrapped variant of it.

decorateObserver

@NonNull
protected SCMHeadObserver decorateObserver(@NonNull
                                                    SCMHeadObserver observer)

SPI: Override this method to decorate the SCMHeadObserver used during a SCMSourceRequest.

Parameters:

observer - the observer.

Returns:

the supplied observer or a wrapped variant of it.

applyToBuilder

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

Applies this trait to the SCMBuilder.

Parameters:

builder - the builder.

decorateBuilder

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

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

Parameters:

builder - the builder (invariant: SCMSourceTraitDescriptor.isApplicableToBuilder(SCMBuilder) is true and SCMSourceTraitDescriptor.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 SCMSourceTraitDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<SCMSourceTrait>

Overrides:

getDescriptor in class SCMTrait<SCMSourceTrait>

all

public static DescriptorExtensionList<SCMSourceTrait,SCMSourceTraitDescriptor> all()

Returns all the SCMSourceTraitDescriptor instances.

Returns:

all the SCMSourceTraitDescriptor instances.

_for

public static List<SCMSourceTraitDescriptor> _for(@CheckForNull
                                                  Class<? extends SCMSourceContext> contextClass,
                                                  @CheckForNull
                                                  Class<? extends SCMBuilder> builderClass)

Returns the subset of SCMSourceTraitDescriptor instances that are applicable to the specified types of SCMSourceContext and SCMSourceBuilder.

Parameters:

contextClass - (optional) type of SCMSourceContext.

builderClass - (optional) type of SCMBuilder.

Returns:

the list of matching SCMSourceTraitDescriptor instances.

_for

public static List<SCMSourceTraitDescriptor> _for(@CheckForNull
                                                  SCMSourceDescriptor scmSource,
                                                  @CheckForNull
                                                  Class<? extends SCMSourceContext> contextClass,
                                                  @CheckForNull
                                                  Class<? extends SCMBuilder> builderClass)

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

Parameters:

scmSource - (optional) SCMSourceDescriptor.

contextClass - (optional) type of SCMSourceContext.

builderClass - (optional) type of SCMBuilder.

Returns:

the list of matching SCMSourceTraitDescriptor instances.