com.uc4.api.objects

Class XMLDocumentation

java.lang.Object

com.uc4.api.objects.AbstractDocumentation

com.uc4.api.objects.XMLDocumentation

public class XMLDocumentation
extends AbstractDocumentation

This class represents a structured documenation.

Method Summary

Modifier and Type	Method and Description
String	getAttributeDefaultValue(String elementName, String attributeName) Returns the default value of an attribute.
String[]	getAttributeEnumValues(String elementName, String attributeName) Returns the enumeration values of a specified attribute.
void	modifyAttributeDTD(String elementName, String attributeName, String[] values, String defValue) Modifies the DTD of an attribute.
boolean	removeAttributeDTD(String elementName, String attributeName) Removes an attribute for the specified element.
XMLDocuNode	root()

Methods inherited from class com.uc4.api.objects.AbstractDocumentation

getName, getType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

root

public XMLDocuNode root()

Returns:

Root node

removeAttributeDTD

public boolean removeAttributeDTD(String elementName,
                                  String attributeName)

Removes an attribute for the specified element. The attribute is removed from the DTD of this XML documentation

Parameters:

elementName - Name of the element

attributeName - Name of the attribute

Returns:

true if the attribute was removed or false if not found

getAttributeEnumValues

public String[] getAttributeEnumValues(String elementName,
                                       String attributeName)

Returns the enumeration values of a specified attribute.

Parameters:

elementName - Name of element

attributeName - Name of the attribute

Returns:

String array containing the valid values for this attribute or null if the attribute was not found or does not contain enum values

getAttributeDefaultValue

public String getAttributeDefaultValue(String elementName,
                                       String attributeName)

Returns the default value of an attribute.

Parameters:

elementName - Name of the element

attributeName - Name of the attribute

Returns:

default value or an empty String if no default value has been set

modifyAttributeDTD

public void modifyAttributeDTD(String elementName,
                               String attributeName,
                               String[] values,
                               String defValue)

Modifies the DTD of an attribute. If the attribute does not exist it is added to the DTD.

Parameters:

elementName - Name of the element

attributeName - Name of the attribute

values - Enumeration values or null if this attribute can contain any values

defValue - Default value