jenkins.scm.api.trait

Class SCMBuilder<B extends SCMBuilder<B,S>,S extends SCM>

java.lang.Object

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

Type Parameters:

B - the type of SCMBuilder so that subclasses can chain correctly in their withHead(SCMHead) etc methods.

S - the type of SCM returned by build()

public abstract class SCMBuilder<B extends SCMBuilder<B,S>,S extends SCM>
extends Object

Builder for a SCM instance. Typically instantiated in SCMSource.build(SCMHead, SCMRevision) or SCMSource.build(SCMHead) and then decorated by SCMSourceTrait.applyToBuilder(SCMBuilder) 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));

Constructor Summary

Constructors

Constructor and Description
SCMBuilder(Class<S> clazz, SCMHead head, SCMRevision revision) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract S	build() Instantiates the SCM.
SCMHead	head() Returns the SCMHead to produce the SCM for.
SCMRevision	revision() Returns the SCMRevision to produce the SCM for or null to produce the SCM for the head revision.
Class<S>	scmClass() Returns the base class of SCM that will be produced by the SCMBuilder.
B	withHead(SCMHead head) Replace the head() with a new SCMHead.
B	withRevision(SCMRevision revision) Replace the revision() with a new SCMRevision
B	withTrait(SCMSourceTrait trait) Apply the SCMSourceTrait to this SCMBuilder.
B	withTraits(Collection<SCMSourceTrait> traits) Apply the SCMSourceTrait instances to this SCMBuilder.
B	withTraits(SCMSourceTrait... traits) Apply the SCMSourceTrait instances to this SCMBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMBuilder

public SCMBuilder(Class<S> clazz,
                  @NonNull
                  SCMHead head,
                  @CheckForNull
                  SCMRevision revision)

Constructor.

Parameters:

clazz - The base class of SCM that will be produced by the SCMBuilder.

head - The SCMHead to produce the SCM for.

revision - The SCMRevision to produce the SCM for or null to produce the SCM for the head revision.

Method Detail

head

@NonNull
public final SCMHead head()

Returns the SCMHead to produce the SCM for.

Returns:

the SCMHead to produce the SCM for.

revision

@CheckForNull
public final SCMRevision revision()

Returns the SCMRevision to produce the SCM for or null to produce the SCM for the head revision.

Returns:

the SCMRevision to produce the SCM for or null to produce the SCM for the head revision.

scmClass

@NonNull
public final Class<S> scmClass()

Returns the base class of SCM that will be produced by the SCMBuilder.

Returns:

the base class of SCM that will be produced by the SCMBuilder.

withHead

@NonNull
public final B withHead(@NonNull
                                 SCMHead head)

Replace the head() with a new SCMHead.

Parameters:

head - the SCMHead to produce the SCM for.

Returns:

this for method chaining.

withRevision

@NonNull
public final B withRevision(@CheckForNull
                                     SCMRevision revision)

Replace the revision() with a new SCMRevision

Parameters:

revision - the SCMRevision to produce the SCM for or null to produce the SCM for the head revision.

Returns:

this for method chaining.

withTrait

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

Apply the SCMSourceTrait to this SCMBuilder.

Parameters:

trait - the SCMSourceTrait.

Returns:

this for method chaining.

withTraits

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

Apply the SCMSourceTrait instances to this SCMBuilder.

Parameters:

traits - the SCMSourceTrait instances.

Returns:

this for method chaining.

withTraits

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

Apply the SCMSourceTrait instances to this SCMBuilder.

Parameters:

traits - the SCMSourceTrait instances.

Returns:

this for method chaining.

build

@NonNull
public abstract S build()

Instantiates the SCM.

Returns:

the S instance