jenkins.scm.api.trait

Class SCMSourceBuilder<B extends SCMSourceBuilder<B,S>,S extends SCMSource>

java.lang.Object

jenkins.scm.api.trait.SCMSourceBuilder<B,S>

Type Parameters:

B - the type of SCMSourceBuilder so that subclasses can chain correctly in their withTrait(SCMSourceTrait) etc methods.

S - the type of SCMSource returned by build(). In general this should be a type that has SCMSourceTrait support.

public abstract class SCMSourceBuilder<B extends SCMSourceBuilder<B,S>,S extends SCMSource>
extends Object

Builder for a SCMSource instance. Typically instantiated in SCMNavigator.visitSources(SCMSourceObserver) and then decorated by SCMNavigatorTrait.applyToBuilder(SCMSourceBuilder) before calling build() to generate the return value. Conventions:

• The builder 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 B 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));

When applying SCMTrait instances to the builder, the SCMNavigatorTrait instances will modify the builder itself while the SCMSourceTrait instances will be retained to be added to the SCMSource during build()

Constructor Summary

Constructors

Constructor and Description
SCMSourceBuilder(Class<S> clazz, String projectName) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract S	build() Instantiates the SCMSource.
String	projectName() Returns the project name.
Class<S>	sourceClass() Returns the base class of SCMSource that will be produced by the SCMSourceBuilder.
List<SCMSourceTrait>	traits() Returns the SCMSourceTrait instances to provide to the SCMSource (assuming the SCMSource is SCMSourceTrait aware.
B	withRequest(SCMNavigatorRequest request) Apply the SCMNavigatorRequest to this SCMSourceBuilder.
B	withTrait(SCMNavigatorTrait trait) Apply the SCMNavigatorTrait to this SCMSourceBuilder.
B	withTrait(SCMSourceTrait trait) Apply the SCMSourceTrait to this SCMSourceBuilder (that is add to traits()).
B	withTraits(Collection<? extends SCMTrait<?>> traits) Apply the SCMTrait instances to this SCMSourceBuilder.
B	withTraits(SCMTrait<? extends SCMTrait<?>>... traits) Apply the SCMTrait instances to this SCMSourceBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMSourceBuilder

public SCMSourceBuilder(@NonNull
                        Class<S> clazz,
                        @NonNull
                        String projectName)

Constructor.

Parameters:

clazz - the base class of SCMSource that will be produced by the SCMSourceBuilder.

projectName - the project name.

Method Detail

sourceClass

@NonNull
public final Class<S> sourceClass()

Returns the base class of SCMSource that will be produced by the SCMSourceBuilder.

Returns:

the base class of SCMSource that will be produced by the SCMSourceBuilder.

projectName

@NonNull
public final String projectName()

Returns the project name.

Returns:

the project name.

traits

@NonNull
public final List<SCMSourceTrait> traits()

Returns the SCMSourceTrait instances to provide to the SCMSource (assuming the SCMSource is SCMSourceTrait aware.

Returns:

the SCMSourceTrait instances to provide to the SCMSource (assuming the SCMSource is SCMSourceTrait aware.

withTrait

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

Apply the SCMNavigatorTrait to this SCMSourceBuilder.

Parameters:

trait - the SCMNavigatorTrait.

Returns:

this for method chaining.

withTrait

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

Apply the SCMSourceTrait to this SCMSourceBuilder (that is add to traits()).

Parameters:

trait - the SCMSourceTrait.

Returns:

this for method chaining.

withTraits

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

Apply the SCMTrait instances to this SCMSourceBuilder.

Parameters:

traits - the SCMTrait instances.

Returns:

this for method chaining.

withTraits

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

Apply the SCMTrait instances to this SCMSourceBuilder.

Parameters:

traits - the SCMTrait instances.

Returns:

this for method chaining.

withRequest

public B withRequest(@NonNull
                     SCMNavigatorRequest request)

Apply the SCMNavigatorRequest to this SCMSourceBuilder.

Parameters:

request - the SCMNavigatorRequest instance.

Returns:

this for method chaining.

build

@NonNull
public abstract S build()

Instantiates the SCMSource. The implementation is responsible to ensure that the traits() are provided to the SCMSource.

Returns:

the S instance