dom4j 2.1.4 · org.dom4j.tree.DefaultEntity

Modifier and Type	Field and Description
private Element	parent The parent of this node

Access	Constructor and Description
public	DefaultEntity(String is the name of the entity name) Creates the `Entity` with the specified name
public	DefaultEntity(String is the name of the entity name, String is the text of the entity text) Creates the `Entity` with the specified name and text.
public	DefaultEntity(Element is the parent element parent, String is the name of the entity name, String is the text of the entity text) Creates the `Entity` with the specified name and text.

Method Summary

Modifier and Type	Method and Description
public Element	getParent() Overrides org.dom4j.tree.AbstractNode.getParent. Implements org.dom4j.Node.getParent. `getParent` returns the parent `Element` if this node supports the parent relationship or null if it is the root element or does not support the parent relationship.
public boolean	isReadOnly() Overrides org.dom4j.tree.AbstractNode.isReadOnly. Implements org.dom4j.Node.isReadOnly. `isReadOnly` returns true if this node is read only and cannot be modified.
public void	setName(String is the new name of this node name) Overrides org.dom4j.tree.AbstractNode.setName. Implements org.dom4j.Node.setName. Sets the text data of this node or this method will throw an `UnsupportedOperationException` if it is read-only.
public void	setParent(Element is the new parent of this node. parent) Overrides org.dom4j.tree.AbstractNode.setParent. Implements org.dom4j.Node.setParent. `setParent` sets the parent relationship of this node if the parent relationship is supported or does nothing if the parent relationship is not supported.
public void	setText(String DOCUMENT ME! text) Overrides org.dom4j.tree.FlyweightEntity.setText. Implements org.dom4j.Node.setText. sets the value of the entity if it is not defined yet otherwise an `UnsupportedOperationException` is thrown as this class is read only.
public boolean	supportsParent() Overrides org.dom4j.tree.AbstractNode.supportsParent. Implements org.dom4j.Node.supportsParent. `supportsParent` returns true if this node supports the parent relationship.

Inherited from org.dom4j.tree.FlyweightEntity:: createXPathResult getName getText

Field Detail

parent	back to summary
private Element parent The parent of this node

Constructor Detail

DefaultEntity back to summary

DefaultEntity	back to summary
public DefaultEntity(String name) Creates the `Entity` with the specified name Parameters name:String is the name of the entity

public DefaultEntity(String name)

Creates the Entity with the specified name

Parameters

name:String: is the name of the entity

DefaultEntity back to summary

DefaultEntity	back to summary
public DefaultEntity(String name, String text) Creates the `Entity` with the specified name and text. Parameters name:String is the name of the entity text:String is the text of the entity

public DefaultEntity(String name, String text)

Creates the Entity with the specified name and text.

Parameters

name:String: is the name of the entity
text:String: is the text of the entity

DefaultEntity back to summary

DefaultEntity	back to summary
public DefaultEntity(Element parent, String name, String text) Creates the `Entity` with the specified name and text. Parameters parent:Element is the parent element name:String is the name of the entity text:String is the text of the entity

public DefaultEntity(Element parent, String name, String text)

Creates the Entity with the specified name and text.

Parameters

parent:Element: is the parent element
name:String: is the name of the entity
text:String: is the text of the entity

Method Detail

getParent back to summary

getParent	back to summary
public Element getParent() Overrides org.dom4j.tree.AbstractNode.getParent. Implements org.dom4j.Node.getParent. Doc from org.dom4j.Node.getParent. `getParent` returns the parent `Element` if this node supports the parent relationship or null if it is the root element or does not support the parent relationship. This method is an optional feature and may not be supported for all `Node` implementations. Returns:Element the parent of this node or null if it is the root of the tree or the parent relationship is not supported.

public Element getParent()

Overrides org.dom4j.tree.AbstractNode.getParent.

Implements org.dom4j.Node.getParent.

Doc from org.dom4j.Node.getParent.

getParent returns the parent Element if this node supports the parent relationship or null if it is the root element or does not support the parent relationship.

This method is an optional feature and may not be supported for all Node implementations.

Returns:Element: the parent of this node or null if it is the root of the tree or the parent relationship is not supported.

isReadOnly back to summary

isReadOnly	back to summary
public boolean isReadOnly() Overrides org.dom4j.tree.AbstractNode.isReadOnly. Implements org.dom4j.Node.isReadOnly. Doc from org.dom4j.Node.isReadOnly. `isReadOnly` returns true if this node is read only and cannot be modified. Any attempt to modify a read-only `Node` will result in an `UnsupportedOperationException` being thrown. Returns:boolean true if this `Node` is read only and cannot be modified otherwise false.

public boolean isReadOnly()

Overrides org.dom4j.tree.AbstractNode.isReadOnly.

Implements org.dom4j.Node.isReadOnly.

Doc from org.dom4j.Node.isReadOnly.

isReadOnly returns true if this node is read only and cannot be modified. Any attempt to modify a read-only Node will result in an UnsupportedOperationException being thrown.

Returns:boolean: true if this Node is read only and cannot be modified otherwise false.

setName back to summary

setName	back to summary
public void setName(String name) Overrides org.dom4j.tree.AbstractNode.setName. Implements org.dom4j.Node.setName. Doc from org.dom4j.Node.setName. Sets the text data of this node or this method will throw an `UnsupportedOperationException` if it is read-only. Parameters name:String is the new name of this node

public void setName(String name)

Overrides org.dom4j.tree.AbstractNode.setName.

Implements org.dom4j.Node.setName.

Doc from org.dom4j.Node.setName.

Sets the text data of this node or this method will throw an UnsupportedOperationException if it is read-only.

Parameters

name:String: is the new name of this node

setParent back to summary

setParent	back to summary
public void setParent(Element parent) Overrides org.dom4j.tree.AbstractNode.setParent. Implements org.dom4j.Node.setParent. Doc from org.dom4j.Node.setParent. `setParent` sets the parent relationship of this node if the parent relationship is supported or does nothing if the parent relationship is not supported. This method should only be called from inside an `Element` implementation method and is not intended for general use. Parameters parent:Element is the new parent of this node.

public void setParent(Element parent)

Overrides org.dom4j.tree.AbstractNode.setParent.

Implements org.dom4j.Node.setParent.

Doc from org.dom4j.Node.setParent.

setParent sets the parent relationship of this node if the parent relationship is supported or does nothing if the parent relationship is not supported.

This method should only be called from inside an Element implementation method and is not intended for general use.

Parameters

parent:Element: is the new parent of this node.

setText back to summary

setText	back to summary
public void setText(String text) Overrides org.dom4j.tree.FlyweightEntity.setText. Implements org.dom4j.Node.setText. Doc from org.dom4j.tree.FlyweightEntity.setText. sets the value of the entity if it is not defined yet otherwise an `UnsupportedOperationException` is thrown as this class is read only. Parameters text:String DOCUMENT ME!

public void setText(String text)

Overrides org.dom4j.tree.FlyweightEntity.setText.

Implements org.dom4j.Node.setText.

Doc from org.dom4j.tree.FlyweightEntity.setText.

sets the value of the entity if it is not defined yet otherwise an UnsupportedOperationException is thrown as this class is read only.

Parameters

text:String: DOCUMENT ME!

supportsParent back to summary

supportsParent	back to summary
public boolean supportsParent() Overrides org.dom4j.tree.AbstractNode.supportsParent. Implements org.dom4j.Node.supportsParent. Doc from org.dom4j.Node.supportsParent. `supportsParent` returns true if this node supports the parent relationship. Some XML tree implementations are singly linked and only support downward navigation through children relationships. The default case is that both parent and children relationships are supported though for memory and performance reasons the parent relationship may not be supported. Returns:boolean true if this node supports the parent relationship or false it is not supported

public boolean supportsParent()

Overrides org.dom4j.tree.AbstractNode.supportsParent.

Implements org.dom4j.Node.supportsParent.

Doc from org.dom4j.Node.supportsParent.

supportsParent returns true if this node supports the parent relationship.

Some XML tree implementations are singly linked and only support downward navigation through children relationships. The default case is that both parent and children relationships are supported though for memory and performance reasons the parent relationship may not be supported.

Returns:boolean: true if this node supports the parent relationship or false it is not supported

public Class DefaultEntity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail