jenkins.scm.api.trait

Interface SCMSourceRequest.ProbeLambda<H extends SCMHead,I>

Type Parameters:

H - the type of SCMHead

I - the type of side-value used to create the probe (typically a SCMRevision but if that is costly to instantiate it may be the return value from a SCMSourceRequest.IntermediateLambda.

Enclosing class:

SCMSourceRequest

public static interface SCMSourceRequest.ProbeLambda<H extends SCMHead,I>

A lambda that will create a SCMSourceCriteria.Probe (ideally a SCMProbe but for legacy code migration we use SCMSourceCriteria.Probe) for a specified SCMHead and either a SCMRevision or some other type created by a SCMSourceRequest.IntermediateLambda.

See Also:

SCMSourceRequest.RevisionLambda, SCMSourceRequest.IntermediateLambda

Method Summary

Modifier and Type	Method and Description
SCMSourceCriteria.Probe	create(H head, I revisionInfo) Creates a SCMSourceCriteria.Probe (ideally a SCMProbe) for the specified SCMHead and SCMRevision produced by SCMSourceRequest.RevisionLambda or intermediate produced by SCMSourceRequest.IntermediateLambda

Method Detail

create

@NonNull
SCMSourceCriteria.Probe create(@NonNull
                                        H head,
                                        @Nullable
                                        I revisionInfo)
                                 throws IOException,
                                        InterruptedException

Creates a SCMSourceCriteria.Probe (ideally a SCMProbe) for the specified SCMHead and SCMRevision produced by SCMSourceRequest.RevisionLambda or intermediate produced by SCMSourceRequest.IntermediateLambda

Parameters:

head - the SCMHead.

revisionInfo - depending on the type of I this is either a SCMRevision produced by a SCMSourceRequest.RevisionLambda or an intermediate produced by a SCMSourceRequest.IntermediateLambda. It could also be null if the implementation has captured sufficient information to create the SCMSourceCriteria.Probe.

Returns:

ideally a SCMProbe.

Throws:

IOException - if there is an I/O error.

InterruptedException - if the operation was interrupted.