com.joelj.jenkins.eztemplates.exclusion

Class AbstractExclusion

java.lang.Object

com.joelj.jenkins.eztemplates.exclusion.AbstractExclusion

All Implemented Interfaces:

Exclusion

Direct Known Subclasses:

AssignedLabelExclusion, DescriptionExclusion, DisabledExclusion, DiscardExclusion, EzTemplatesExclusion, JobPropertyExclusion, MatrixAxisExclusion, ScmExclusion, TriggersExclusion

public abstract class AbstractExclusion
extends java.lang.Object
implements Exclusion

It is expected that all Exclusions extend this. Implementations should use the inherited logger for any messages!

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.logging.Logger	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExclusion(java.lang.String id, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() User-visible description of the exclusion
java.lang.String	getDisabledText() Default implementation assumes the Exclusion's getId() is the plugin id so just checks to see if it is currently installed.
java.lang.String	getId() ez-templates id for this Exclusion.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.joelj.jenkins.eztemplates.exclusion.Exclusion

postClone, preClone

Field Detail

LOG

protected static final java.util.logging.Logger LOG

Constructor Detail

AbstractExclusion

protected AbstractExclusion(java.lang.String id,
                            java.lang.String description)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Exclusion

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

Specified by:

getId in interface Exclusion

Returns:

never null

getDescription

public java.lang.String getDescription()

Description copied from interface: Exclusion

User-visible description of the exclusion

Specified by:

getDescription in interface Exclusion

Returns:

Something like "Retain local XYZ"

getDisabledText

public java.lang.String getDisabledText()

Default implementation assumes the Exclusion's getId() is the plugin id so just checks to see if it is currently installed.

Specified by:

getDisabledText in interface Exclusion

Returns:

non-null if plugin is unavailable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object