jenkins.scm.api.trait

Class SCMSourceContext<C extends SCMSourceContext<C,R>,R extends SCMSourceRequest>

java.lang.Object

jenkins.scm.api.trait.SCMSourceContext<C,R>

Type Parameters:

C - the type of SCMSourceContext

R - the type of SCMSourceRequest produced by this context.

public abstract class SCMSourceContext<C extends SCMSourceContext<C,R>,R extends SCMSourceRequest>
extends Object

Represents the context within which a SCMSource is processing requests. In general this is used as a builder for SCMSourceRequest instances through newRequest(SCMSource, TaskListener) but there are some cases (such as SCMHeadEvent processing) where only the context is required and as such this type will be instantiated to obtain the context but no SCMSourceRequest will be created. Conventions:

• The context is not designed to be shared by multiple threads.
• All methods should be either final or abstract unless there is a documented reason for allowing overrides
• All "setter" methods will return C and be called "withXxx"
• All "getter" methods will be called "xxx()". Callers should not assume that the returned value is resistant from concurrent changes. Implementations should ensure that the returned value is immutable by the caller. In other words, it is intentional for implementations to reduce intermediate allocations by return Collections.unmodifiableList(theList); rather than the concurrency safe return Collections.unmodifiableList(new ArrayList<>(theList));

Since:

2.2.0

Constructor Summary

Constructors

Constructor and Description
SCMSourceContext(SCMSourceCriteria criteria, SCMHeadObserver observer) Constructor.

Method Summary

Modifier and Type	Method and Description
List<SCMHeadAuthority<?,?,?>>	authorities() Returns the (possibly empty) list of SCMHeadAuthority instances that can define trust.
List<SCMSourceCriteria>	criteria() Returns the (possibly empty) list of criteria that must be met by a candidate SCMHead.
List<SCMHeadFilter>	filters() Returns the (possibly empty) list of SCMSourceRequest dependent filters.
abstract R	newRequest(SCMSource source, TaskListener listener) Creates a new SCMSourceRequest.
SCMHeadObserver	observer() Returns the SCMHeadObserver.
List<SCMHeadPrefilter>	prefilters() Returns the (possibly empty) list of SCMSourceRequest independent pre-filters.
C	withAuthority(SCMHeadAuthority authority) Adds an additional SCMHeadAuthority.
C	withCriteria(SCMSourceCriteria criteria) Adds an additional SCMSourceCriteria.
C	withFilter(SCMHeadFilter filter) Adds an additional SCMHeadFilter.
C	withPrefilter(SCMHeadPrefilter prefilter) Adds an additional SCMHeadPrefilter.
C	withTrait(SCMSourceTrait trait) Adds an additional SCMSourceTrait.
C	withTraits(Collection<SCMSourceTrait> traits) Adds additional SCMSourceTraits.
C	withTraits(SCMSourceTrait... traits) Adds additional SCMSourceTraits.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMSourceContext

public SCMSourceContext(@CheckForNull
                        SCMSourceCriteria criteria,
                        @NonNull
                        SCMHeadObserver observer)

Constructor.

Parameters:

criteria - (optional) criteria.

observer - the SCMHeadObserver.

Method Detail

authorities

@NonNull
public final List<SCMHeadAuthority<?,?,?>> authorities()

Returns the (possibly empty) list of SCMHeadAuthority instances that can define trust.

Returns:

the (possibly empty) list of SCMHeadAuthority instances that can define trust.

criteria

@NonNull
public final List<SCMSourceCriteria> criteria()

Returns the (possibly empty) list of criteria that must be met by a candidate SCMHead.

Returns:

the (possibly empty) list of criteria that must be met by a candidate SCMHead.

filters

@NonNull
public final List<SCMHeadFilter> filters()

Returns the (possibly empty) list of SCMSourceRequest dependent filters.

Returns:

the (possibly empty) list of SCMSourceRequest dependent filters.

prefilters

@NonNull
public final List<SCMHeadPrefilter> prefilters()

Returns the (possibly empty) list of SCMSourceRequest independent pre-filters.

Returns:

the (possibly empty) list of SCMSourceRequest independent pre-filters.

observer

@NonNull
public final SCMHeadObserver observer()

Returns the SCMHeadObserver.

Returns:

the SCMHeadObserver.

withAuthority

@NonNull
public final C withAuthority(@CheckForNull
                                      SCMHeadAuthority authority)

Adds an additional SCMHeadAuthority.

Parameters:

authority - the SCMHeadAuthority.

Returns:

this for method chaining.

withCriteria

@NonNull
public final C withCriteria(@CheckForNull
                                     SCMSourceCriteria criteria)

Adds an additional SCMSourceCriteria.

Parameters:

criteria - the SCMSourceCriteria.

Returns:

this for method chaining.

withFilter

@NonNull
public final C withFilter(@CheckForNull
                                   SCMHeadFilter filter)

Adds an additional SCMHeadFilter.

Parameters:

filter - the SCMHeadFilter.

Returns:

this for method chaining.

withPrefilter

@NonNull
public final C withPrefilter(@CheckForNull
                                      SCMHeadPrefilter prefilter)

Adds an additional SCMHeadPrefilter.

Parameters:

prefilter - the SCMHeadPrefilter.

Returns:

this for method chaining.

withTrait

@NonNull
public final C withTrait(@NonNull
                                  SCMSourceTrait trait)

Adds an additional SCMSourceTrait.

Parameters:

trait - the SCMSourceTrait.

Returns:

this for method chaining.

withTraits

@NonNull
public final C withTraits(@NonNull
                                   SCMSourceTrait... traits)

Adds additional SCMSourceTraits.

Parameters:

traits - the SCMSourceTraits.

Returns:

this for method chaining.

withTraits

@NonNull
public final C withTraits(@NonNull
                                   Collection<SCMSourceTrait> traits)

Adds additional SCMSourceTraits.

Parameters:

traits - the SCMSourceTraits.

Returns:

this for method chaining.

newRequest

@NonNull
public abstract R newRequest(@NonNull
                                      SCMSource source,
                                      @CheckForNull
                                      TaskListener listener)

Creates a new SCMSourceRequest.

Parameters:

source - the SCMSource.

listener - the (optional) TaskListener.

Returns:

the R