Class StringVariable
java.lang.Object
com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
com.xebialabs.xlrelease.domain.BaseConfiguration
com.xebialabs.xlrelease.domain.variables.Variable
com.xebialabs.xlrelease.domain.variables.Variable.VariableWithValue<String>
com.xebialabs.xlrelease.domain.variables.StringVariable
- All Implemented Interfaces:
ConfigurationItem
,VisitableItem
,Serializable
,Cloneable
,Comparable<BaseConfigurationItem>
- Direct Known Subclasses:
ReferenceVariable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.xebialabs.xlrelease.domain.variables.Variable
Variable.VariableWithValue<V>
-
Field Summary
FieldsFields inherited from class com.xebialabs.xlrelease.domain.variables.Variable
description, inherited, key, label, requiresValue, showOnReleaseStart, valueProvider
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 TypeMethodDescriptionReturns empty value for the specific sub type.boolean
getValue()
Gets underlying value of this variable, or default value for templates.boolean
boolean
boolean
isValueAssignableFrom
(Object value) void
setMultiline
(boolean multiline) void
setPreventInterpolation
(boolean preventInterpolation) void
setUntypedValue
(Object newValue) Sets the underlying value of this variable from given object.void
Methods inherited from class com.xebialabs.xlrelease.domain.variables.Variable
accept, checkFolderVariableValidity, checkGlobalVariableValidity, checkValidity, clone, escapeQuotes, getDescription, getInternalValue, getKey, getLabel, getRequiresValue, getShowOnReleaseStart, getValueProvider, isInherited, isValueEmpty, setDescription, setInherited, setKey, setLabel, setRequiresValue, setShowOnReleaseStart, setValueProvider
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
-
value
@Property(required=false, description="Value of the release variable or default value of the template variable") protected String value -
multiline
@Property(required=false, defaultValue="false", description="If checked variable value will be multiline text ") protected boolean multiline -
preventInterpolation
@Property(required=false, description="Set this to true if you don\'t want the contents of this variable scanned for other variables and updated after the variables are resolved.") protected boolean preventInterpolation
-
-
Constructor Details
-
StringVariable
public StringVariable()
-
-
Method Details
-
getValue
Description copied from class:Variable
Gets underlying value of this variable, or default value for templates. The specific type of value depends on the type of variable.- Specified by:
getValue
in classVariable.VariableWithValue<String>
- Returns:
- the underlying value of this variable, or default value for templates.
-
getMultiline
public boolean getMultiline() -
setMultiline
public void setMultiline(boolean multiline) -
getEmptyValue
Description copied from class:Variable
Returns empty value for the specific sub type. Empty value is used when replacing unset optional variables.- Specified by:
getEmptyValue
in classVariable
- Returns:
- empty value for the specific sub type.
-
setValue
- Specified by:
setValue
in classVariable.VariableWithValue<String>
-
setUntypedValue
Description copied from class:Variable
Sets the underlying value of this variable from given object. If a conversion happens to be needed and fails, then anIllegalArgumentException
will be thrown.- Specified by:
setUntypedValue
in classVariable
- Parameters:
newValue
- the value to set: either of the type needed by this variable type, or one of convertible types.
-
isPassword
public boolean isPassword()- Specified by:
isPassword
in classVariable
-
getValueAsString
- Specified by:
getValueAsString
in classVariable
-
getEmptyValueAsString
- Specified by:
getEmptyValueAsString
in classVariable
-
isValueAssignableFrom
- Specified by:
isValueAssignableFrom
in classVariable
-
isPreventInterpolation
public boolean isPreventInterpolation() -
setPreventInterpolation
public void setPreventInterpolation(boolean preventInterpolation)
-