SCMSourceCriteria (SCM API Plugin 689.v237b_6d3a_ef7f API)

All Superinterfaces:

Serializable
```
public interface SCMSourceCriteria
extends Serializable
```
Filter that selects heads picked up by SCMSource out of all the branches and other heads found in the repository. Implementations should provide a correct implementation of Object.equals(Object) and Object.hashCode()

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class SCMSourceCriteria.Probe
A probe for a branch candidate.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isHead(SCMSourceCriteria.Probe probe, TaskListener listener)`	Validates if a potential head is actually a head.

- Method Detail
  - isHead
```
boolean isHead(@NonNull
               SCMSourceCriteria.Probe probe,
               @NonNull
               TaskListener listener)
        throws IOException
```
    Validates if a potential head is actually a head.
    
    Parameters:
    
    probe - the SCMSourceCriteria.Probe for the head candidate.
    
    listener - a listener which may receive informational messages explaining why a head was accepted or rejected
    
    Returns:
    
    true iff the candidate should be included in the list of heads built by Jenkins.
    
    Throws:
    
    IOException - if an error occurs while performing the operation.