|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.dom4j.tree.AbstractNode org.dom4j.tree.AbstractProcessingInstruction org.dom4j.tree.FlyweightProcessingInstruction org.dom4j.tree.DefaultProcessingInstruction
DefaultProcessingInstruction
is the default Processing
Instruction implementation. It is a doubly linked node which supports the
parent relationship and can be modified in place.
Field Summary |
Fields inherited from class org.dom4j.tree.FlyweightProcessingInstruction |
target, text, values |
Fields inherited from class org.dom4j.tree.AbstractNode |
NODE_TYPE_NAMES |
Fields inherited from interface org.dom4j.Node |
ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE |
Constructor Summary | |
DefaultProcessingInstruction(Element parent,
String target,
String values)
This will create a new PI with the given target and values |
|
DefaultProcessingInstruction(String target,
Map values)
This will create a new PI with the given target and values |
|
DefaultProcessingInstruction(String target,
String values)
This will create a new PI with the given target and values |
Method Summary | |
Element |
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.
|
boolean |
isReadOnly()
isReadOnly returns true if this node is read only and
cannot be modified. |
void |
setParent(Element parent)
setParent sets the parent relationship of this node if the
parent relationship is supported or does nothing if the parent
relationship is not supported.
|
void |
setTarget(String target)
This method is the equivalent to the AbstractProcessingInstruction.setName(java.lang.String) method. |
void |
setText(String text)
Sets the text data of this node or this method will throw an UnsupportedOperationException if it is read-only.
|
void |
setValue(String name,
String value)
|
void |
setValues(Map values)
|
boolean |
supportsParent()
supportsParent returns true if this node supports the
parent relationship.
|
Methods inherited from class org.dom4j.tree.FlyweightProcessingInstruction |
createXPathResult, getTarget, getText, getValue, getValues |
Methods inherited from class org.dom4j.tree.AbstractProcessingInstruction |
accept, asXML, getName, getNodeType, getPath, getUniquePath, parseValues, removeValue, setName, toString, toString, write |
Methods inherited from class org.dom4j.tree.AbstractNode |
asXPathResult, clone, createPattern, createXPath, createXPathFilter, detach, getDocument, getDocumentFactory, getNodeTypeName, getPath, getStringValue, getUniquePath, hasContent, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, valueOf |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.dom4j.Node |
asXPathResult, clone, createXPath, detach, getDocument, getNodeTypeName, getPath, getStringValue, getUniquePath, hasContent, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, valueOf |
Constructor Detail |
public DefaultProcessingInstruction(String target, Map values)
This will create a new PI with the given target and values
target
- is the name of the PIvalues
- is the Map
values for the PIpublic DefaultProcessingInstruction(String target, String values)
This will create a new PI with the given target and values
target
- is the name of the PIvalues
- is the values for the PIpublic DefaultProcessingInstruction(Element parent, String target, String values)
This will create a new PI with the given target and values
parent
- is the parent elementtarget
- is the name of the PIvalues
- is the values for the PIMethod Detail |
public void setTarget(String target)
ProcessingInstruction
Node.setName(java.lang.String)
method. It is added
for clarity.
setTarget
in interface ProcessingInstruction
setTarget
in class FlyweightProcessingInstruction
public void setText(String text)
Node
Sets the text data of this node or this method will throw an
UnsupportedOperationException
if it is read-only.
setText
in interface Node
setText
in class AbstractNode
public void setValues(Map values)
setValues
in interface ProcessingInstruction
setValues
in class AbstractProcessingInstruction
public void setValue(String name, String value)
setValue
in interface ProcessingInstruction
setValue
in class AbstractProcessingInstruction
public Element getParent()
Node
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.
getParent
in interface Node
getParent
in class AbstractNode
public void setParent(Element parent)
Node
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.
setParent
in interface Node
setParent
in class AbstractNode
public boolean supportsParent()
Node
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.
supportsParent
in interface Node
supportsParent
in class AbstractNode
public boolean isReadOnly()
Node
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.
isReadOnly
in interface Node
isReadOnly
in class AbstractNode
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |