Package jenkins.plugins.git.traits

Class RefSpecsSCMSourceTrait

java.lang.Object

hudson.model.AbstractDescribableImpl<T>

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

jenkins.scm.api.trait.SCMSourceTrait

jenkins.plugins.git.traits.RefSpecsSCMSourceTrait

All Implemented Interfaces:

ExtensionPoint, Describable<jenkins.scm.api.trait.SCMSourceTrait>

public class RefSpecsSCMSourceTrait
extends jenkins.scm.api.trait.SCMSourceTrait

Exposes the ref specs of a AbstractGitSCMSource as a SCMSourceTrait. The ref specs are stored as templates which are intended to be realised by applying String.replaceAll(String, String) with the AbstractGitSCMSource.REF_SPEC_REMOTE_NAME_PLACEHOLDER pattern to inject the remote name (which should default to AbstractGitSCMSource.DEFAULT_REMOTE_NAME

Since:

3.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RefSpecsSCMSourceTrait.DescriptorImpl	Our Descriptor
static class	RefSpecsSCMSourceTrait.RefSpecTemplate	Represents a single wrapped template for easier form binding.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
RefSpecsSCMSourceTrait(String... templates)	Utility constructor.
RefSpecsSCMSourceTrait(List<RefSpecsSCMSourceTrait.RefSpecTemplate> templates)	Stapler constructor.

Method Summary

Modifier and Type	Method	Description
List<String>	asStrings()	Unwraps the templates.
protected void	decorateBuilder(jenkins.scm.api.trait.SCMBuilder<?,?> builder)
protected void	decorateContext(jenkins.scm.api.trait.SCMSourceContext<?,?> context)
List<RefSpecsSCMSourceTrait.RefSpecTemplate>	getTemplates()	Gets the templates.

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

_for, _for, all, applyToBuilder, applyToContext, applyToObserver, decorateObserver, getDescriptor, includeCategory, isCategoryEnabled

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 Details

RefSpecsSCMSourceTrait

@DataBoundConstructor
public RefSpecsSCMSourceTrait(@CheckForNull
 List<RefSpecsSCMSourceTrait.RefSpecTemplate> templates)

Stapler constructor.

Parameters:

templates - the templates.

RefSpecsSCMSourceTrait

public RefSpecsSCMSourceTrait(String... templates)

Utility constructor.

Parameters:

templates - the template strings.

Method Details

getTemplates

@NonNull
public List<RefSpecsSCMSourceTrait.RefSpecTemplate> getTemplates()

Gets the templates.

Returns:

the templates.

asStrings

public List<String> asStrings()

Unwraps the templates.

Returns:

the templates.

decorateContext

protected void decorateContext(jenkins.scm.api.trait.SCMSourceContext<?,?> context)

Overrides:

decorateContext in class jenkins.scm.api.trait.SCMSourceTrait

decorateBuilder

protected void decorateBuilder(jenkins.scm.api.trait.SCMBuilder<?,?> builder)

Overrides:

decorateBuilder in class jenkins.scm.api.trait.SCMSourceTrait