Package jenkins.scm.api.trait

Class SCMNavigatorContext<C extends SCMNavigatorContext<C,R>,R extends SCMNavigatorRequest>

java.lang.Object

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

Type Parameters:

C - the type of SCMNavigatorContext

R - the type of SCMNavigatorRequest produced by this context.

public abstract class SCMNavigatorContext<C extends SCMNavigatorContext<C,R>,R extends SCMNavigatorRequest>
extends Object

Represents the context within which a SCMNavigator is processing requests. In general this is used as a builder for SCMNavigatorRequest instances through newRequest(SCMNavigator, SCMSourceObserver) but there are some cases (such as SCMSourceEvent processing) where only the context is required and as such this type will be instantiated to obtain the context but no SCMNavigatorRequest 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 SCMNavigatorContext 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	Description
SCMNavigatorContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
List<SCMSourceDecorator<?,?>>	decorators()	Returns the (possibly empty) list of SCMSourceDecorator instances to apply to discovered projects.
List<SCMSourceFilter>	filters()	Returns the (possibly empty) list of SCMNavigatorRequest dependent filters.
abstract R	newRequest(SCMNavigator navigator, SCMSourceObserver observer)	Creates a new SCMNavigatorRequest.
List<SCMSourcePrefilter>	prefilters()	Returns the (possibly empty) list of SCMNavigatorRequest independent pre-filters.
List<SCMSourceTrait>	traits()	Returns the (possibly empty) list of SCMSourceTrait instances to apply to discovered projects.
C	withDecorator(SCMSourceDecorator<?,?> decorator)	Adds the supplied SCMSourceDecorator.
C	withDecorators(Collection<? extends SCMSourceDecorator<?,?>> decorators)	Adds the supplied SCMSourceDecorator instances.
C	withDecorators(SCMSourceDecorator<?,?>... decorators)	Adds the supplied SCMSourceDecorator instances.
C	withFilter(SCMSourceFilter filter)	Adds the supplied SCMSourceFilter.
C	withPrefilter(SCMSourcePrefilter prefilter)	Adds the supplied SCMSourcePrefilter.
C	withTrait(SCMNavigatorTrait trait)	Applies the supplied SCMNavigatorTrait.
C	withTrait(SCMSourceTrait trait)	Adds the supplied SCMSourceTrait.
C	withTraits(Collection<? extends SCMTrait<?>> traits)	Adds / applies the supplied SCMTrait.
C	withTraits(SCMTrait<? extends SCMTrait<?>>... traits)	Adds / applies the supplied SCMTrait.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMNavigatorContext

public SCMNavigatorContext()

Constructor.

Method Detail

decorators

@NonNull
public final List<SCMSourceDecorator<?,?>> decorators()

Returns the (possibly empty) list of SCMSourceDecorator instances to apply to discovered projects.

Returns:

the (possibly empty) list of SCMSourceDecorator instances to apply to discovered projects.

filters

@NonNull
public final List<SCMSourceFilter> filters()

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

Returns:

the (possibly empty) list of SCMNavigatorRequest dependent filters.

prefilters

@NonNull
public final List<SCMSourcePrefilter> prefilters()

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

Returns:

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

traits

@NonNull
public final List<SCMSourceTrait> traits()

Returns the (possibly empty) list of SCMSourceTrait instances to apply to discovered projects.

Returns:

the (possibly empty) list of SCMSourceTrait instances to apply to discovered projects.

withFilter

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

Adds the supplied SCMSourceFilter.

Parameters:

filter - the additional SCMSourceFilter.

Returns:

this for method chaining.

withPrefilter

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

Adds the supplied SCMSourcePrefilter.

Parameters:

prefilter - the additional SCMSourcePrefilter.

Returns:

this for method chaining.

withTrait

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

Applies the supplied SCMNavigatorTrait.

Parameters:

trait - the additional SCMNavigatorTrait.

Returns:

this for method chaining.

withTrait

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

Adds the supplied SCMSourceTrait.

Parameters:

trait - the additional SCMSourceTrait.

Returns:

this for method chaining.

withTraits

@NonNull
public final C withTraits(@NonNull
                          SCMTrait<? extends SCMTrait<?>>... traits)

Adds / applies the supplied SCMTrait.

Parameters:

traits - the additional SCMTrait instances.

Returns:

this for method chaining.

withTraits

@NonNull
public final C withTraits(@NonNull
                          Collection<? extends SCMTrait<?>> traits)

Adds / applies the supplied SCMTrait.

Parameters:

traits - the additional SCMTrait instances.

Returns:

this for method chaining.

withDecorator

@NonNull
public final C withDecorator(@NonNull
                             SCMSourceDecorator<?,?> decorator)

Adds the supplied SCMSourceDecorator.

Parameters:

decorator - the additional SCMSourceDecorator.

Returns:

this for method chaining.

withDecorators

@NonNull
public final C withDecorators(@NonNull
                              SCMSourceDecorator<?,?>... decorators)

Adds the supplied SCMSourceDecorator instances.

Parameters:

decorators - the additional SCMSourceDecorator instances.

Returns:

this for method chaining.

withDecorators

@NonNull
public final C withDecorators(@NonNull
                              Collection<? extends SCMSourceDecorator<?,?>> decorators)

Adds the supplied SCMSourceDecorator instances.

Parameters:

decorators - the additional SCMSourceDecorator instances.

Returns:

this for method chaining.

newRequest

@NonNull
public abstract R newRequest(@NonNull
                             SCMNavigator navigator,
                             @NonNull
                             SCMSourceObserver observer)

Creates a new SCMNavigatorRequest.

Parameters:

navigator - the SCMNavigator.

observer - the SCMSourceObserver.

Returns:

the SCMNavigatorContext