Package jenkins.scm.api.trait

Class SCMNavigatorRequest

java.lang.Object

jenkins.scm.api.trait.SCMNavigatorRequest

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class SCMNavigatorRequest
extends Object
implements Closeable

Represents the context of an individual request for a call to SCMNavigator.visitSources(SCMSourceObserver) or an equivalent method.

Since:

2.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SCMNavigatorRequest.AttributeLambda	A lambda that will create the map of attributes for a specific project name.
static interface	SCMNavigatorRequest.SourceLambda	A lambda that will create the SCMSource instance for a specific project name.
static interface	SCMNavigatorRequest.Witness	Callback lambda to track the results of process(String, SourceLambda, AttributeLambda, Witness...) or process(String, List, List, Witness...)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SCMNavigatorRequest(SCMNavigator source, SCMNavigatorContext<?,?> context, SCMSourceObserver observer)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
List<SCMSourceDecorator<?,?>>	decorators()	Returns the SCMSourceDecorator instances to apply to SCMSource instances.
boolean	isExcluded(String projectName)	Tests if the project name is excluded from the request.
void	manage(Closeable closeable)	Adds managing a Closeable into the scope of the SCMNavigatorRequest
boolean	process(String projectName, List<SCMNavigatorRequest.SourceLambda> sourceFactories, List<SCMNavigatorRequest.AttributeLambda> attributeFactories, SCMNavigatorRequest.Witness... witnesses)	Processes a named project in the scope of the current request.
boolean	process(String projectName, SCMNavigatorRequest.SourceLambda sourceFactory, SCMNavigatorRequest.AttributeLambda attributeFactory, SCMNavigatorRequest.Witness... witnesses)	Processes a named project in the scope of the current request.
List<SCMSourceTrait>	traits()	Returns the SCMSourceTrait instances to apply to every SCMSource.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMNavigatorRequest

protected SCMNavigatorRequest(@NonNull
                              SCMNavigator source,
                              @NonNull
                              SCMNavigatorContext<?,?> context,
                              @NonNull
                              SCMSourceObserver observer)

Constructor.

Parameters:

source - the source.

context - the context.

observer - the observer.

Method Detail

traits

@NonNull
public final List<SCMSourceTrait> traits()

Returns the SCMSourceTrait instances to apply to every SCMSource.

Returns:

the SCMSourceTrait instances to apply to every SCMSource.

decorators

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

Returns the SCMSourceDecorator instances to apply to SCMSource instances.

Returns:

the SCMSourceDecorator instances to apply to SCMSource instances.

isExcluded

public final boolean isExcluded(@NonNull
                                String projectName)
                         throws IOException,
                                InterruptedException

Tests if the project name is excluded from the request.

Parameters:

projectName - the project name.

Returns:

true if the SCMHead is excluded.

Throws:

IOException - if there is an I/O error.

InterruptedException - if the operation was interrupted.

process

public boolean process(@NonNull
                       String projectName,
                       @NonNull
                       SCMNavigatorRequest.SourceLambda sourceFactory,
                       @CheckForNull
                       SCMNavigatorRequest.AttributeLambda attributeFactory,
                       SCMNavigatorRequest.Witness... witnesses)
                throws IllegalArgumentException,
                       IOException,
                       InterruptedException

Processes a named project in the scope of the current request.

Parameters:

projectName - the name of the project.

sourceFactory - the factory for instantiating a SCMSource.

attributeFactory - (optional) factory for instantiating the attribute map.

witnesses - the witnesses to record the processing result.

Returns:

true if and only if the request is completed, false if the request can process additional named projects.

Throws:

IllegalArgumentException - if the attribute factory provides attribute names that are unrecognized, or repeats already added attributes.

IOException - if there is an I/O error.

InterruptedException - if the operation was interrupted.

process

public boolean process(@NonNull
                       String projectName,
                       @NonNull
                       List<SCMNavigatorRequest.SourceLambda> sourceFactories,
                       @CheckForNull
                       List<SCMNavigatorRequest.AttributeLambda> attributeFactories,
                       SCMNavigatorRequest.Witness... witnesses)
                throws IllegalArgumentException,
                       IOException,
                       InterruptedException

Processes a named project in the scope of the current request.

Parameters:

projectName - the name of the project.

sourceFactories - the factories for instantiating the SCMSource instances.

attributeFactories - (optional) factories for instantiating the attribute maps.

witnesses - the witnesses to record the processing result.

Returns:

true if and only if the request is completed, false if the request can process additional named projects.

Throws:

IllegalArgumentException - if an attribute factory provides attribute names that are unrecognized, or repeats already added attributes.

IOException - if there is an I/O error.

InterruptedException - if the operation was interrupted.

manage

public void manage(@CheckForNull
                   Closeable closeable)

Adds managing a Closeable into the scope of the SCMNavigatorRequest

Parameters:

closeable - the Closeable to manage.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException