public class GCVRef extends GCValue
ShimParams
instance. This is
implemented as a GCValue
so that the reference can easily be manipulated via
the GCDefinitions
and GCParent
classes.
Note that gcv-ref types cannot appear on base GCV definitions (i.e., in GCDefinitions
).
Note that only a single reference to a give GCV can exist in a single ShimParams instance.
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 |
---|
GCVRef(java.lang.String name)
Constructor for use by
GCValue construct() method. |
GCVRef(java.lang.String name,
java.lang.String driverParamName)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
GCValue |
cloneValue(java.lang.String name)
Clone this
GCValue instance and return the cloned instance. |
java.lang.String |
getDriverParamName()
Get the driver parameter name override, if any.
|
java.lang.String |
getValue()
Return the current value of this instance.
|
void |
parseValue(java.lang.String value)
Implement GCValue abstract.
|
void |
setDriverParamName(java.lang.String driverParamName)
Set the driver parameter name override.
|
void |
setValue(java.lang.String value)
Implement GCValue abstract.
|
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 GCVRef(java.lang.String name) throws GCVArgumentException
GCValue
construct()
method.name
- name of GCV to referenceGCVArgumentException
- thrown if name is invalidpublic GCVRef(java.lang.String name, java.lang.String driverParamName) throws GCVArgumentException
name
- name of GCV to referencedriverParamName
- driver parameter name (overrides GCV name when converting
to driver parameter). May be null
; if non-null
, value must a valid XML Name;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
parseValue
in class GCValue
value
- ignorednone
GCVException
- thrown if value is not correct for this value instance.public java.lang.String getValue()
public void setValue(java.lang.String value) throws GCVException
setValue
in class GCValue
value
- ignorednone
GCVException
- thrown if value is not correct for this value instance.public java.lang.String getDriverParamName()
null
,
- or driver parameter name to use.public void setDriverParamName(java.lang.String driverParamName) throws GCVArgumentException
driverParamName
- name of driver parameter to use, or null
.
If non-null
, value must be a valid XML Name.GCVArgumentException