Package jenkins.scm.api.trait
Interface SCMSourceRequest.ProbeLambda<H extends SCMHead,I>
- Type Parameters:
H
- the type ofSCMHead
I
- the type of side-value used to create the probe (typically aSCMRevision
but if that is costly to instantiate it may be the return value from aSCMSourceRequest.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
.-
Method Summary
Modifier and TypeMethodDescriptionCreates aSCMSourceCriteria.Probe
(ideally aSCMProbe
) for the specifiedSCMHead
andSCMRevision
produced bySCMSourceRequest.RevisionLambda
or intermediate produced bySCMSourceRequest.IntermediateLambda
-
Method Details
-
create
@NonNull SCMSourceCriteria.Probe create(@NonNull H head, @Nullable I revisionInfo) throws IOException, InterruptedException Creates aSCMSourceCriteria.Probe
(ideally aSCMProbe
) for the specifiedSCMHead
andSCMRevision
produced bySCMSourceRequest.RevisionLambda
or intermediate produced bySCMSourceRequest.IntermediateLambda
- Parameters:
head
- theSCMHead
.revisionInfo
- depending on the type ofSCMSourceRequest.ProbeLambda
this is either aSCMRevision
produced by aSCMSourceRequest.RevisionLambda
or an intermediate produced by aSCMSourceRequest.IntermediateLambda
. It could also benull
if the implementation has captured sufficient information to create theSCMSourceCriteria.Probe
.- Returns:
- ideally a
SCMProbe
. - Throws:
IOException
- if there is an I/O error.InterruptedException
- if the operation was interrupted.
-