com.joelj.jenkins.eztemplates.exclusion

Interface Exclusion

All Known Implementing Classes:

AbstractExclusion, AssignedLabelExclusion, DescriptionExclusion, DisabledExclusion, DiscardExclusion, EzTemplatesExclusion, JobParametersExclusion, JobPropertyExclusion, MatrixAxisExclusion, OwnershipExclusion, PromotedBuildsExclusion, ScmExclusion, TriggersExclusion

public interface Exclusion

A template cloning exclusion (usually meaning "retain something on the implementation"). It is expected all usages extend AbstractExclusion.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() User-visible description of the exclusion
java.lang.String	getDisabledText() Determine if this exclusion is possible in the current installation
java.lang.String	getId() ez-templates id for this Exclusion.
void	postClone(EzContext context, hudson.model.AbstractProject implementationProject) Restore content we kept - usually via reflection to prevent infinite save recursion.
void	preClone(EzContext context, hudson.model.AbstractProject implementationProject) Capture content we want to keep.

Method Detail

getId

java.lang.String getId()

ez-templates id for this Exclusion. Generally expected to be a plugin's id.

Returns:

never null

getDescription

java.lang.String getDescription()

User-visible description of the exclusion

Returns:

Something like "Retain local XYZ"

getDisabledText

java.lang.String getDisabledText()

Determine if this exclusion is possible in the current installation

Returns:

Description of why disabled or null

preClone

void preClone(EzContext context,
              hudson.model.AbstractProject implementationProject)

Capture content we want to keep.

Parameters:

context - Templating execution, Exclusions must check if they are selected in this execution!

implementationProject - The child project before and any processing.

postClone

void postClone(EzContext context,
               hudson.model.AbstractProject implementationProject)

Restore content we kept - usually via reflection to prevent infinite save recursion.

Parameters:

context - Templating execution, Exclusions must check if they are selected in this execution!

implementationProject - The child project immediately after it has been XML-cloned from its template. Note it will be amended by successive Exclusions so the overall state is indeterminate although each individual Exclusion can presume its personal view of the Job currently looks exactly like the template.

See Also:

EzReflectionUtils