|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.nds.dirxml.engine.gcv.GCValue
com.novell.nds.dirxml.engine.gcv.GCVRef
public class GCVRef
Class representing a reference to a GCV from a 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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.novell.nds.dirxml.engine.gcv.GCValue |
---|
GCValue.IllegalCloneStateException, GCValue.XmlComment, GCValue.XmlItem, GCValue.XmlProcessingInstruction |
Field Summary |
---|
Fields inherited from class com.novell.nds.dirxml.engine.gcv.GCValue |
---|
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 Summary | |
---|---|
GCVRef(String name)
Constructor for use by GCValue construct() method. |
|
GCVRef(String name,
String driverParamName)
Constructor. |
Method Summary | |
---|---|
GCValue |
cloneValue(String name)
Clone this GCValue instance and return the cloned instance. |
String |
getDriverParamName()
Get the driver parameter name override, if any. |
String |
getValue()
Return the current value of this instance. |
void |
parseValue(String value)
Implement GCValue abstract. |
void |
setDriverParamName(String driverParamName)
Set the driver parameter name override. |
void |
setValue(String value)
Implement GCValue abstract. |
Methods inherited from class com.novell.nds.dirxml.engine.gcv.GCValue |
---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GCVRef(String name) throws GCVArgumentException
GCValue
construct()
method.
name
- name of GCV to reference
GCVArgumentException
- thrown if name is invalidpublic GCVRef(String name, 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 invalidMethod Detail |
---|
public GCValue cloneValue(String name)
GCValue
instance and return the cloned instance.
cloneValue
in class GCValue
the
- name for the cloned value.
public void parseValue(String value) throws GCVException
parseValue
in class GCValue
value
- ignored
none
GCVException
- thrown if value is not correct for this value instance.public String getValue()
getValue
in class GCValue
public void setValue(String value) throws GCVException
setValue
in class GCValue
value
- ignored
none
GCVException
- thrown if value is not correct for this value instance.public String getDriverParamName()
null
,
- or driver parameter name to use.public void setDriverParamName(String driverParamName) throws GCVArgumentException
driverParamName
- name of driver parameter to use, or null
.
If non-null
, value must be a valid XML Name.
GCVArgumentException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |