Package jenkins.branch

Class BranchProperty

java.lang.Object

hudson.model.AbstractDescribableImpl<BranchProperty>

jenkins.branch.BranchProperty

All Implemented Interfaces:

ExtensionPoint, Describable<BranchProperty>

Direct Known Subclasses:

BuildRetentionBranchProperty, NoTriggerBranchProperty, ParameterDefinitionBranchProperty, RateLimitBranchProperty, UntrustedBranchProperty

public abstract class BranchProperty
extends AbstractDescribableImpl<BranchProperty>
implements ExtensionPoint

Additional information associated with Branch.

SCMSources can use properties to convey additional implementation/SCM specific information that's not captured in the base Branch class.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BranchProperty()

Method Summary

Modifier and Type	Method	Description
protected static <T> ArrayList<T>	asArrayList(List<T> list)	Utility helper method that ensures you have an ArrayList but avoids copying unless required.
final ProjectDecorator	decorator(AbstractProject project)	Deprecated. Should have been typed to take Project and Build rather than AbstractProject and AbstractBuild.
ProjectDecorator	decorator(Class clazz)	Deprecated. Should have been typed to take Project and Build rather than AbstractProject and AbstractBuild.
BranchPropertyDescriptor	getDescriptor()
<P extends Job<P, B>, B extends Run<P, B>> JobDecorator<P,B>	jobDecorator(Class<P> clazz)	Returns a JobDecorator for the specific job type.

Methods inherited from class java.lang.Object

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

Constructor Details

BranchProperty

public BranchProperty()

Method Details

decorator

@CheckForNull
@Deprecated
public final ProjectDecorator decorator(AbstractProject project)

Deprecated.

Should have been typed to take Project and Build rather than AbstractProject and AbstractBuild.

Returns a ProjectDecorator for the supplied project instance.

Parameters:

project - the project instance.

Returns:

a ProjectDecorator or null if none appropriate to this type of project.

decorator

@CheckForNull
@Deprecated
public ProjectDecorator decorator(Class clazz)

Deprecated.

Should have been typed to take Project and Build rather than AbstractProject and AbstractBuild.

Returns a ProjectDecorator for the specific project type.

Parameters:

clazz - the project class.

Returns:

a ProjectDecorator or null if none appropriate to this type of project.

jobDecorator

@CheckForNull
public <P extends Job<P,
B>,
B extends Run<P,
B>>
JobDecorator<P,B> jobDecorator(Class<P> clazz)

Returns a JobDecorator for the specific job type.

Type Parameters:

P - the type of job.

B - the type of run of the job.

Parameters:

clazz - the job class.

Returns:

a JobDecorator or null if none appropriate to this type of job.

getDescriptor

@NonNull
public BranchPropertyDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<BranchProperty>

Overrides:

getDescriptor in class AbstractDescribableImpl<BranchProperty>

asArrayList

protected static <T> ArrayList<T> asArrayList(List<T> list)

Utility helper method that ensures you have an ArrayList but avoids copying unless required.

Type Parameters:

T - the type of elements in the list.

Parameters:

list - the list that may or may not be an ArrayList.

Returns:

either the supplied List if it was an ArrayList or a copy of the supplied list in a newly created ArrayList.