public class GCStringValue extends GCValue
"string"
type Global Configuration Values.
Lexical value representations of "string" GCVs must match the following production:
String ::= Char*
The default value of a newly-constructed GCStringValue
object is the empty string ""
.
GCValue.IllegalCloneStateException, GCValue.XmlComment, GCValue.XmlItem, GCValue.XmlProcessingInstruction
modified, parent, TYPE_BOOLEAN, TYPE_DN, TYPE_DN_REF, TYPE_ENUM, TYPE_GCV_REF, TYPE_GROUP, TYPE_HEADER, TYPE_INTEGER, TYPE_LIST, TYPE_PASSWORD_REF, TYPE_REAL, TYPE_STRING, TYPE_STRUCTURED, TYPE_SUBORDINATES, xmlItems
Constructor and Description |
---|
GCStringValue(java.lang.String name)
Constructor for use by
GCValue construct() method. |
Modifier and Type | Method and Description |
---|---|
GCValue |
cloneValue(java.lang.String name)
Clone this
GCValue instance and return the cloned instance. |
boolean |
getMultiline()
Return
true if this value is a multi-lined valued. |
java.lang.String |
getValue()
Return the current value of this instance.
|
void |
parseValue(java.lang.String value)
Parse the passed value based on the type lexical rules
for
"string" GCVs. |
void |
setMultiline(boolean multiline)
Set whether or not this value is multi-lined.
|
void |
setValue(java.lang.String value)
Set the value for this instance.
|
addXmlComment, addXmlItems, addXmlProcessingInstruction, cloneCommon, construct, construct, constructGCVRef, constructGCVRef, constructGroup, constructHeader, constructStructuredValue, constructSubordinates, getDescription, getDescriptionRef, getDisplayName, getDisplayNameRef, getHidden, getMandatory, getName, getOwner, getParent, getType, getTypeString, getXmlItemsIterator, getXMLValue, hasBeenModified, localize, resetModified, setDescription, setDescriptionRef, setDisplayName, setDisplayNameRef, setHidden, setMandatory, toXML, typeFromString
public GCStringValue(java.lang.String name) throws GCVArgumentException
GCValue
construct()
method.name
- Name of string GCV.GCVArgumentException
- thrown if name is invalidpublic GCValue cloneValue(java.lang.String name)
GCValue
instance and return the cloned instance.cloneValue
in class GCValue
the
- name for the cloned value.public void parseValue(java.lang.String value) throws GCVException
"string"
GCVs.
The passed value must match the production described in the description of this class.
parseValue
in class GCValue
value
- Value String
to parseGCVException
- thrown if value does not match "string"
constraints.public java.lang.String getValue()
public void setValue(java.lang.String value) throws GCVException
The passed value must conform to the rules noted under parseValue()
.
setValue
in class GCValue
value
- Value String
for this instance.GCVException
- thrown if value is doesn't not parse correctly.parseValue(java.lang.String)
public boolean getMultiline()
true
if this value is a multi-lined valued.
This doesn't indicate whether the value itself has multiple lines, only
that it should be presented in a multi-line editing control and that the user
should be able to specify line breaks.true
if multi-linedpublic void setMultiline(boolean multiline)
multiline
- true
if value is multi-lined.