com.novell.nds.dirxml.engine.gcv

Class GCListValue

java.lang.Object

com.novell.nds.dirxml.engine.gcv.GCValue

com.novell.nds.dirxml.engine.gcv.GCListValue

All Implemented Interfaces:

ConfigElement

public class GCListValue
extends GCValue

Class representing "list" type Global Configuration Values.

GCVs of type "list" have a value that corresponds to the items in the list.

The value is represented in different ways depending on where the GCV is referenced. In text-replacement, the list is represented in one of two ways:

• In XML attribute values or other string contexts, the list is represented by a concatenation of the list items, each separated from the next by the separator string.
• In XML contexts (i.e., where XML elements can appear) the list is represented by a top-level <list> element containing one <item> element for each list item.

Items in the list have a defined order based on the order in which the items appear in the definition.

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

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SEPARATOR

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

Method Summary

Modifier and Type	Method and Description
void	appendListItem(java.lang.String item) Append a new list item.
GCValue	cloneValue(java.lang.String name) Clone this GCValue instance and return the cloned instance.
java.lang.String	getSeparator() Return the separator string for this list.
java.lang.String	getValue() Return the current value of this instance.
org.w3c.dom.Node	getXMLValue(org.w3c.dom.Document document) Return an XML node representing this GCV's value.
void	insertListItem(java.lang.String item, int insertionPoint) Insert a new item into this list.
java.util.Iterator	iterator() Return an Iterator for use in iterating through the list item Strings in this instance.
void	parseValue(java.lang.String value) Parse the passed value based on the type and instance rules for "list" GCVs.
boolean	removeListItem(int index) Remove an item from this list
boolean	removeListItem(java.lang.String item, boolean removeAll) Remove an item from this list
void	setSeparator(java.lang.String separator) Set the separator string for this list.
void	setTypeHint(java.lang.String hint) Programmatically set the type-hint value.
void	setValue(java.lang.String value) Set the value for this instance.

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, 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

Field Detail

DEFAULT_SEPARATOR

public static final java.lang.String DEFAULT_SEPARATOR

See Also:

Constant Field Values

Method Detail

cloneValue

public GCValue cloneValue(java.lang.String name)

Clone this GCValue instance and return the cloned instance.

Specified by:

cloneValue in class GCValue

Parameters:

the - name for the cloned value.

Returns:

the cloned instance

setTypeHint

public void setTypeHint(java.lang.String hint)

Programmatically set the type-hint value.

Parameters:

hint - null, or one of GCVDtd.VAL_STRING, GCVDtd.VAL_BOOLEAN, GCVDtd.VAL_INTEGER, GCVDtd.VAL_REAL, GCVDtd.VAL_DN

Throws:

java.lang.IllegalArgumentException - thrown if hint isn't null or one of the allowed values.

parseValue

public void parseValue(java.lang.String value)
                throws GCVException

Parse the passed value based on the type and instance rules for "list" GCVs.

The passed value must be in the form <item><separator><item>, etc.

Specified by:

parseValue in class GCValue

Parameters:

value - Value String to parse

Throws:

GCVException - thrown if value is not correct for this value instance.

getValue

public java.lang.String getValue()

Return the current value of this instance.

This will return a string containing all of the list items, each separated by the separator string.

Specified by:

getValue in class GCValue

Returns:

Value String.

getXMLValue

public org.w3c.dom.Node getXMLValue(org.w3c.dom.Document document)

Return an XML node representing this GCV's value. The default implementation simply returns a Text node containing the value returned by getValue(). Certain GCV types (e.g., list) may return more structured data.

Overrides:

getXMLValue in class GCValue

Parameters:

document - the Document to use to create nodes.

Returns:

the Node that is the root of the XML representation.

setValue

public void setValue(java.lang.String value)
              throws GCVException

Set the value for this instance.

The passed value must be in the form <item><separator><item>, etc.

Specified by:

setValue in class GCValue

Parameters:

value - Value string for this instance.

Throws:

GCVException - thrown if value is not correct for this value instance.

getSeparator

public java.lang.String getSeparator()

Return the separator string for this list.

Returns:

String containing separator used to separate items in single-string representation of the list.

setSeparator

public void setSeparator(java.lang.String separator)

Set the separator string for this list.

The separator string separates list items in the flat, single-string representation of the list.

Parameters:

separator - The separator string.

appendListItem

public void appendListItem(java.lang.String item)

Append a new list item. The item may be empty or null, which will result in an empty list item.

Parameters:

item - The String value of the item.

insertListItem

public void insertListItem(java.lang.String item,
                           int insertionPoint)

Insert a new item into this list.

Parameters:

item - The item to insert.

insertionPoint - the index at which to insert the new item.

removeListItem

public boolean removeListItem(int index)

Remove an item from this list

Parameters:

index - The index of the item to remove.

Returns:

true if an item existed at the passed index and was removed.

removeListItem

public boolean removeListItem(java.lang.String item,
                              boolean removeAll)

Remove an item from this list

Parameters:

item - The string value of the item to remove.

removeAll - if true, remove all items with the passed value.

Returns:

true if one or more items was removed.

iterator

public java.util.Iterator iterator()

Return an Iterator for use in iterating through the list item Strings in this instance.

Returns:

Iterator that returns String objects.