Package com.xebialabs.xlrelease.domain.variables

Class Variable

  • All Implemented Interfaces:
    com.xebialabs.deployit.plugin.api.udm.ConfigurationItem, VisitableItem, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem>
    Direct Known Subclasses:
    Variable.VariableWithValue
    @Metadata(virtual=true,
          versioned=false)
public abstract class Variable
extends BaseConfiguration
implements java.lang.Cloneable, VisitableItem
    See Also:
    Serialized Form

    • Constructor Detail

      • Variable

        public Variable()

    • Method Detail

      • getValue

        public abstract java.lang.Object getValue()
        Gets underlying value of this variable, or default value for templates. The specific type of value depends on the type of variable.
        Returns:
        the underlying value of this variable, or default value for templates.

      • getEmptyValue

        public abstract java.lang.Object getEmptyValue()
        Returns empty value for the specific sub type. Empty value is used when replacing unset optional variables.
        Returns:
        empty value for the specific sub type.

      • isValueEmpty

        public boolean isValueEmpty()
        Test if value is unset or empty. Rely on the getEmptyValue() implementation.
        Returns:
        true if value is null or empty.

      • setUntypedValue

        public abstract void setUntypedValue​(java.lang.Object newValue)
                              throws java.lang.IllegalArgumentException
        Sets the underlying value of this variable from given object. If a conversion happens to be needed and fails, then an IllegalArgumentException will be thrown.
        Parameters:
        newValue - the value to set: either of the type needed by this variable type, or one of convertible types.
        Throws:
        java.lang.IllegalArgumentException - if conversion of the value fails.

      • getKey

        public java.lang.String getKey()

      • setKey

        public void setKey​(java.lang.String key)

      • getRequiresValue

        public boolean getRequiresValue()

      • setRequiresValue

        public void setRequiresValue​(boolean requiresValue)

      • getShowOnReleaseStart

        public boolean getShowOnReleaseStart()

      • setShowOnReleaseStart

        public void setShowOnReleaseStart​(boolean showOnReleaseStart)

      • getLabel

        public java.lang.String getLabel()

      • setLabel

        public void setLabel​(java.lang.String label)

      • getDescription

        public java.lang.String getDescription()

      • setDescription

        public void setDescription​(java.lang.String description)

      • checkValidity

        public void checkValidity()

      • checkGlobalVariableValidity

        public void checkGlobalVariableValidity()

      • checkFolderVariableValidity

        public void checkFolderVariableValidity()

      • getInternalValue

        public java.lang.Object getInternalValue()

      • isPassword

        public abstract boolean isPassword()

      • getValueAsString

        public abstract java.lang.String getValueAsString()

      • getEmptyValueAsString

        public abstract java.lang.String getEmptyValueAsString()

      • isValueAssignableFrom

        public abstract boolean isValueAssignableFrom​(java.lang.Object value)

      • isInherited

        public boolean isInherited()

      • setInherited

        public void setInherited​(boolean inherited)

      • clone

        public Variable clone()
               throws java.lang.CloneNotSupportedException
        Throws:
        java.lang.CloneNotSupportedException