Class DefaultProcessingInstruction
- All Implemented Interfaces:
Serializable, Cloneable, Node, ProcessingInstruction
- Direct Known Subclasses:
DOMProcessingInstruction
DefaultProcessingInstruction
is the default Processing
Instruction implementation. It is a doubly linked node which supports the
parent relationship and can be modified in place.
- Version:
- $Revision: 1.13 $
- See Also:
-
Field Summary
FieldsFields inherited from class FlyweightProcessingInstruction
target, text, values
Fields inherited from class AbstractNode
NODE_TYPE_NAMES
Fields inherited from interface 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
ConstructorsConstructorDescriptionDefaultProcessingInstruction
(String target, String values) This will create a new PI with the given target and valuesDefaultProcessingInstruction
(String target, Map<String, String> values) This will create a new PI with the given target and valuesDefaultProcessingInstruction
(Element parent, String target, String values) This will create a new PI with the given target and values -
Method Summary
Modifier and TypeMethodDescriptiongetParent
returns the parentElement
if this node supports the parent relationship or null if it is the root element or does not support the parent relationship.boolean
isReadOnly
returns true if this node is read only and cannot be modified.void
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
This method is the equivalent to theNode.setName(String)
method.void
Sets the text data of this node or this method will throw anUnsupportedOperationException
if it is read-only.void
void
boolean
supportsParent
returns true if this node supports the parent relationship.Methods inherited from class FlyweightProcessingInstruction
createXPathResult, getTarget, getText, getValue, getValues
Methods inherited from class AbstractProcessingInstruction
accept, asXML, getName, getNodeType, getPath, getUniquePath, parseValues, removeValue, setName, toString, toString, write
Methods inherited from class 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 Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface Node
asXPathResult, clone, createXPath, detach, getDocument, getNodeTypeName, getPath, getStringValue, getUniquePath, hasContent, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, valueOf
-
Field Details
-
parent
The parent of this node
-
-
Constructor Details
-
DefaultProcessingInstruction
-
DefaultProcessingInstruction
-
DefaultProcessingInstruction
-
-
Method Details
-
setTarget
Description copied from interface:ProcessingInstruction
This method is the equivalent to theNode.setName(String)
method. It is added for clarity.- Specified by:
setTarget
in interfaceProcessingInstruction
- Overrides:
setTarget
in classFlyweightProcessingInstruction
- Parameters:
target
- DOCUMENT ME!
-
setText
Description copied from interface:Node
Sets the text data of this node or this method will throw an
UnsupportedOperationException
if it is read-only.- Specified by:
setText
in interfaceNode
- Overrides:
setText
in classAbstractNode
- Parameters:
text
- is the new textual value of this node
-
setValues
- Specified by:
setValues
in interfaceProcessingInstruction
- Overrides:
setValues
in classAbstractProcessingInstruction
-
setValue
- Specified by:
setValue
in interfaceProcessingInstruction
- Overrides:
setValue
in classAbstractProcessingInstruction
-
getParent
Description copied from interface:Node
getParent
returns the parentElement
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.- Specified by:
getParent
in interfaceNode
- Overrides:
getParent
in classAbstractNode
- Returns:
- the parent of this node or null if it is the root of the tree or the parent relationship is not supported.
-
setParent
Description copied from interface: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.- Specified by:
setParent
in interfaceNode
- Overrides:
setParent
in classAbstractNode
- Parameters:
parent
- is the new parent of this node.
-
supportsParent
public boolean supportsParent()Description copied from interface: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.
- Specified by:
supportsParent
in interfaceNode
- Overrides:
supportsParent
in classAbstractNode
- Returns:
- true if this node supports the parent relationship or false it is not supported
-
isReadOnly
public boolean isReadOnly()Description copied from interface:Node
isReadOnly
returns true if this node is read only and cannot be modified. Any attempt to modify a read-onlyNode
will result in anUnsupportedOperationException
being thrown.- Specified by:
isReadOnly
in interfaceNode
- Overrides:
isReadOnly
in classAbstractNode
- Returns:
- true if this
Node
is read only and cannot be modified otherwise false.
-