jenkins.scm.api.trait

Class SCMHeadAuthorityDescriptor

java.lang.Object

hudson.model.Descriptor<SCMHeadAuthority<?,?,?>>

jenkins.scm.api.trait.SCMHeadAuthorityDescriptor

All Implemented Interfaces:

Saveable, OnMaster

public abstract class SCMHeadAuthorityDescriptor
extends Descriptor<SCMHeadAuthority<?,?,?>>

Descriptor base class for SCMHeadAuthority implementations.

Since:

3.4.0

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SCMHeadAuthorityDescriptor() Infers the type of the corresponding SCMHeadAuthority from the outer class.
protected	SCMHeadAuthorityDescriptor(Class<? extends SCMHeadAuthority<?,?,?>> clazz, Class<? extends SCMSourceRequest> requestClass, Class<? extends SCMHeadMixin> headClass, Class<? extends SCMRevision> revisionClass) Constructor to use when type inference using SCMHeadAuthorityDescriptor() does not work.

Method Summary

Modifier and Type	Method and Description
boolean	isApplicableToHead(Class<? extends SCMHeadMixin> headClass) Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied type of SCMHead.
boolean	isApplicableToHead(SCMHead head) Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMHead.
boolean	isApplicableToOrigin(Class<? extends SCMHeadOrigin> originClass) Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMHeadOrigin.
boolean	isApplicableToOrigin(SCMHeadOrigin origin) Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMHeadOrigin.
boolean	isApplicableToRequest(Class<? extends SCMSourceRequest> requestClass) Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied type of SCMSourceRequest.
boolean	isApplicableToRequest(SCMSourceRequest request) Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMSourceRequest.
boolean	isApplicableToRevision(Class<? extends SCMRevision> revisionClass) Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied type of SCMRevision.
boolean	isApplicableToRevision(SCMRevision revision) Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMRevision.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMHeadAuthorityDescriptor

protected SCMHeadAuthorityDescriptor(Class<? extends SCMHeadAuthority<?,?,?>> clazz,
                                     Class<? extends SCMSourceRequest> requestClass,
                                     Class<? extends SCMHeadMixin> headClass,
                                     Class<? extends SCMRevision> revisionClass)

Constructor to use when type inference using SCMHeadAuthorityDescriptor() does not work.

Parameters:

clazz - Pass in the type of SCMHeadAuthority

requestClass - the type of SCMSourceRequest.

headClass - the type of SCMHead.

revisionClass - the type of SCMRevision.

SCMHeadAuthorityDescriptor

protected SCMHeadAuthorityDescriptor()

Infers the type of the corresponding SCMHeadAuthority from the outer class. This version works when you follow the common convention, where a descriptor is written as the static nested class of the describable class.

Method Detail

isApplicableToHead

@OverrideMustInvoke
public boolean isApplicableToHead(@NonNull
                                                      SCMHead head)

Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMHead.

Parameters:

head - the SCMHead.

Returns:

true if applicable.

isApplicableToHead

@OverrideMustInvoke
public boolean isApplicableToHead(@NonNull
                                                      Class<? extends SCMHeadMixin> headClass)

Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied type of SCMHead.

Parameters:

headClass - the type of SCMHead.

Returns:

true if applicable.

isApplicableToRevision

@OverrideMustInvoke
public boolean isApplicableToRevision(@NonNull
                                                          SCMRevision revision)

Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMRevision.

Parameters:

revision - the SCMRevision.

Returns:

true if applicable.

isApplicableToRevision

@OverrideMustInvoke
public boolean isApplicableToRevision(@NonNull
                                                          Class<? extends SCMRevision> revisionClass)

Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied type of SCMRevision.

Parameters:

revisionClass - the type of SCMRevision.

Returns:

true if applicable.

isApplicableToRequest

@OverrideMustInvoke
public boolean isApplicableToRequest(@NonNull
                                                         SCMSourceRequest request)

Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMSourceRequest.

Parameters:

request - the SCMSourceRequest.

Returns:

true if applicable.

isApplicableToRequest

@OverrideMustInvoke
public boolean isApplicableToRequest(@NonNull
                                                         Class<? extends SCMSourceRequest> requestClass)

Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied type of SCMSourceRequest.

Parameters:

requestClass - the type of SCMSourceRequest.

Returns:

true if applicable.

isApplicableToOrigin

public boolean isApplicableToOrigin(@NonNull
                                    SCMHeadOrigin origin)

Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMHeadOrigin.

Parameters:

origin - the SCMHeadOrigin.

Returns:

true if applicable.

isApplicableToOrigin

public boolean isApplicableToOrigin(@NonNull
                                    Class<? extends SCMHeadOrigin> originClass)

Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMHeadOrigin.

Parameters:

originClass - the type of SCMHeadOrigin.

Returns:

true if applicable.