com.xmlmind.xml.validate

Class Structure

java.lang.Object

com.xmlmind.xml.validate.Structure

public final class Structure
extends Object

Specifies an element content as a list of attribute fields and a list of child node items.

Field Summary

Fields

Modifier and Type	Field and Description
int	attributeFieldCount Number of fields available in array returned by attributeFields.
Field[]	attributeFields List of attribute fields of this structure.
Name[]	attributeNames List of attribute names in the element content.
int	childNodeItemCount Number of items available in array returned by childNodeItems.
Item[]	childNodeItems List of child node items of this structure.
static Field[]	NO_FIELDS
static Item[]	NO_ITEMS
static Name[]	NO_NAMES

Constructor Summary

Constructors

Constructor and Description
Structure() Constructs an empty structure.

Method Summary

Modifier and Type	Method and Description
void	addAttributeField(Name name, Field field) Appends an attribute field to the list of attribute fields.
void	addChildNodeItem(Item item) Appends an child node item to the list of child node items.
void	addCommentItem() Adds CommentItem.INSTANCE to this structure.
void	addProcessingInstructionItem() Adds ProcessingInstructionItem.INSTANCE to this structure.
void	addTextItem() Adds TextItem.INSTANCE to this structure.
void	clear() Removes all names, fields, items contained in this structure.
Structure	copy() Copies this structure.

Methods inherited from class java.lang.Object

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

Field Detail

NO_NAMES

public static final Name[] NO_NAMES

NO_FIELDS

public static final Field[] NO_FIELDS

NO_ITEMS

public static final Item[] NO_ITEMS

attributeNames

public Name[] attributeNames

List of attribute names in the element content.

This list is available because unlike child elements, attributes are not ordered. Without this list, for example, there is no way to know to which attribute corresponds first field returned by attributeFields.

This instance variable is read-only. Do not directly modify it..

attributeFields

public Field[] attributeFields

List of attribute fields of this structure.

This instance variable is read-only. Do not directly modify it..

attributeFieldCount

public int attributeFieldCount

Number of fields available in array returned by attributeFields.

This instance variable is read-only. Do not directly modify it..

childNodeItems

public Item[] childNodeItems

List of child node items of this structure.

This instance variable is read-only. Do not directly modify it..

childNodeItemCount

public int childNodeItemCount

Number of items available in array returned by childNodeItems.

This instance variable is read-only. Do not directly modify it..

Constructor Detail

Structure

public Structure()

Constructs an empty structure.

Method Detail

addAttributeField

public void addAttributeField(Name name,
                              Field field)

Appends an attribute field to the list of attribute fields.

The fact that this attribute is already contained in this structure is not checked.

addChildNodeItem

public void addChildNodeItem(Item item)

Appends an child node item to the list of child node items.

addTextItem

public void addTextItem()

Adds TextItem.INSTANCE to this structure.

This is a convenience method.

addCommentItem

public void addCommentItem()

Adds CommentItem.INSTANCE to this structure.

This is a convenience method.

addProcessingInstructionItem

public void addProcessingInstructionItem()

Adds ProcessingInstructionItem.INSTANCE to this structure.

This is a convenience method.

clear

public void clear()

Removes all names, fields, items contained in this structure.

copy

public Structure copy()

Copies this structure. The returned copy is garanteed to be as compact as possible. That is: attributeFields.length == attributeFieldCount and childNodeItems.length == childNodeItemCount