jenkins.scm.impl.trait

Class RegexSCMHeadFilterTrait

java.lang.Object

hudson.model.AbstractDescribableImpl<T>

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

jenkins.scm.api.trait.SCMSourceTrait

jenkins.scm.impl.trait.RegexSCMHeadFilterTrait

All Implemented Interfaces:

ExtensionPoint, Describable<SCMSourceTrait>

public class RegexSCMHeadFilterTrait
extends SCMSourceTrait

Decorates a SCMSource with a SCMHeadPrefilter that excludes SCMHead instances with names that do not match a user supplied regular expression.

Since:

2.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegexSCMHeadFilterTrait.DescriptorImpl Our descriptor.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
RegexSCMHeadFilterTrait(String regex) Stapler constructor.

Method Summary

Modifier and Type	Method and Description
protected void	decorateContext(SCMSourceContext<?,?> context) SPI: Override this method to decorate a SCMSourceContext.
String	getRegex() Gets the regular expression.

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

_for, _for, all, applyToBuilder, applyToContext, applyToObserver, decorateBuilder, 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 Detail

RegexSCMHeadFilterTrait

@DataBoundConstructor
public RegexSCMHeadFilterTrait(@NonNull
                                                     String regex)

Stapler constructor.

Parameters:

regex - the regular expression.

Method Detail

getRegex

@NonNull
public String getRegex()

Gets the regular expression.

Returns:

the regular expression.

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().

Overrides:

decorateContext in class SCMSourceTrait

Parameters:

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