jenkins.branch

Class JobDecorator<P extends Job<P,B>,B extends Run<P,B>>

java.lang.Object

jenkins.branch.JobDecorator<P,B>

Direct Known Subclasses:

ProjectDecorator

public class JobDecorator<P extends Job<P,B>,B extends Run<P,B>>
extends Object

Something that can decorate a job. Decorations can include manipulating the list of JobPropertys of the project as well as custom tweaks that are specific to the project instance type itself.

Constructor Summary

Constructors

Constructor and Description
JobDecorator()

Method Summary

Modifier and Type	Method and Description
List<JobProperty<? super P>>	jobProperties(List<JobProperty<? super P>> properties) This method is an extension point whereby a BranchProperty can filter or enhance the set of JobProperty to be used by the branch specific project.
P	project(P project) This method is an extension point whereby a BranchProperty can apply final tweaks to the project for the branch specific project.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobDecorator

public JobDecorator()

Method Detail

jobProperties

@NonNull
public List<JobProperty<? super P>> jobProperties(@NonNull
                                                           List<JobProperty<? super P>> properties)

This method is an extension point whereby a BranchProperty can filter or enhance the set of JobProperty to be used by the branch specific project.

Parameters:

properties - the proposed JobPropertys.

Returns:

the resulting JobPropertys.

project

@NonNull
public P project(@NonNull
                          P project)

This method is an extension point whereby a BranchProperty can apply final tweaks to the project for the branch specific project. Implementations should try to obey the following rules:

• Don't trigger a save of the job
• Don't try to manipulate the JobProperty instances in the job, use jobProperties(List) instead.
• Don't try to manipulate the BuildWrapper instances in the job, use ProjectDecorator.buildWrappers(List) instead.
• Don't try to manipulate the Publisher instances in the job, use ProjectDecorator.publishers(java.util.List) instead.

In general, this method should be seen as a final hook for use in those cases where the existing hooks prove insufficient.

Parameters:

project - the project.

Returns:

the supplied project for method chaining.