Class Variable
java.lang.Object
com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
com.xebialabs.xlrelease.domain.BaseConfiguration
com.xebialabs.xlrelease.domain.variables.Variable
- All Implemented Interfaces:
ConfigurationItem
,VisitableItem
,Serializable
,Cloneable
,Comparable<BaseConfigurationItem>
- Direct Known Subclasses:
Variable.VariableWithValue
@Metadata(virtual=true,
versioned=false)
public abstract class Variable
extends BaseConfiguration
implements Cloneable, VisitableItem
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
protected boolean
protected String
protected String
protected boolean
protected boolean
protected ValueProviderConfiguration
Fields inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
id, syntheticProperties, type
Fields inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem
SYNTHETIC_PROPERTIES_FIELD, TYPE_FIELD
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(ReleaseVisitor visitor) void
void
void
clone()
protected String
escapeQuotes
(String value) abstract Object
Returns empty value for the specific sub type.abstract String
getKey()
getLabel()
boolean
boolean
abstract Object
getValue()
Gets underlying value of this variable, or default value for templates.abstract String
boolean
abstract boolean
abstract boolean
isValueAssignableFrom
(Object value) boolean
Test if value is unset or empty.void
setDescription
(String description) void
setInherited
(boolean inherited) void
void
void
setRequiresValue
(boolean requiresValue) void
setShowOnReleaseStart
(boolean showOnReleaseStart) abstract void
setUntypedValue
(Object newValue) Sets the underlying value of this variable from given object.void
setValueProvider
(ValueProviderConfiguration valueProvider) Methods inherited from class com.xebialabs.xlrelease.domain.BaseConfiguration
getFolderId, getTitle, hasId, isSupportedOn, setFolderId, setTitle
Methods inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
compareTo, equals, get$ciAttributes, get$directoryReference, get$externalProperties, get$internalId, get$referenceId, get$securedCi, get$securedDirectoryReference, get$token, get$validationMessages, getId, getName, getProperty, getPropertyDescriptor, getType, hashCode, hasProperty, set$ciAttributes, set$directoryReference, set$externalProperties, set$internalId, set$referenceId, set$securedCi, set$securedDirectoryReference, set$token, set$validationMessages, setId, setProperty, setType, toString
-
Field Details
-
key
@Property(description="The unique name of the variable in the way it is used in template or release, without curly braces") protected String key -
requiresValue
@Property(required=false, defaultValue="true", description="Shows if an empty value is a valid value for this variable") protected boolean requiresValue -
showOnReleaseStart
@Property(required=false, defaultValue="true", description="Shows if this variable will be shown on create release page") protected boolean showOnReleaseStart -
label
-
description
-
valueProvider
@Property(required=false, description="Configuration of the variable values provider") protected ValueProviderConfiguration valueProvider -
inherited
@Property(required=false, description="Determines whether the variable value is inherited from the template variable. Used in the Create Release Task only.") protected boolean inherited
-
-
Constructor Details
-
Variable
public Variable()
-
-
Method Details
-
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
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 thegetEmptyValue()
implementation.- Returns:
- true if value is null or empty.
-
setUntypedValue
Sets the underlying value of this variable from given object. If a conversion happens to be needed and fails, then anIllegalArgumentException
will be thrown.- Parameters:
newValue
- the value to set: either of the type needed by this variable type, or one of convertible types.- Throws:
IllegalArgumentException
- if conversion of the value fails.
-
getKey
-
setKey
-
getRequiresValue
public boolean getRequiresValue() -
setRequiresValue
public void setRequiresValue(boolean requiresValue) -
getShowOnReleaseStart
public boolean getShowOnReleaseStart() -
setShowOnReleaseStart
public void setShowOnReleaseStart(boolean showOnReleaseStart) -
getLabel
-
setLabel
-
getDescription
-
setDescription
-
checkValidity
public void checkValidity() -
checkGlobalVariableValidity
public void checkGlobalVariableValidity() -
checkFolderVariableValidity
public void checkFolderVariableValidity() -
getInternalValue
-
isPassword
public abstract boolean isPassword() -
getValueAsString
-
getEmptyValueAsString
-
isValueAssignableFrom
-
escapeQuotes
-
getValueProvider
-
setValueProvider
-
accept
- Specified by:
accept
in interfaceVisitableItem
-
isInherited
public boolean isInherited() -
setInherited
public void setInherited(boolean inherited) -
clone
- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-