Package org.dom4j
Interface ProcessingInstruction
-
- All Superinterfaces:
java.lang.Cloneable
,Node
- All Known Implementing Classes:
AbstractProcessingInstruction
,DefaultProcessingInstruction
,DOMProcessingInstruction
,FlyweightProcessingInstruction
public interface ProcessingInstruction extends Node
ProcessingInstruction
defines an XML processing instruction. TheNode.getName()
method will return the target of the PI and theNode.getText()
method will return the data from all of the instructions.
-
-
Field Summary
-
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getTarget()
This method is the equivalent to theNode.getName()
method.java.lang.String
getText()
DOCUMENT ME!java.lang.String
getValue(java.lang.String name)
Returns the value of a specific name in the PI.java.util.Map<java.lang.String,java.lang.String>
getValues()
DOCUMENT ME!boolean
removeValue(java.lang.String name)
void
setTarget(java.lang.String target)
This method is the equivalent to theNode.setName(java.lang.String)
method.void
setValue(java.lang.String name, java.lang.String value)
void
setValues(java.util.Map<java.lang.String,java.lang.String> data)
-
Methods inherited from interface org.dom4j.Node
accept, asXML, asXPathResult, clone, createXPath, detach, getDocument, getName, getNodeType, getNodeTypeName, getParent, getPath, getPath, getStringValue, getUniquePath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf, write
-
-
-
-
Method Detail
-
getTarget
java.lang.String getTarget()
This method is the equivalent to theNode.getName()
method. It is added for clarity.- Returns:
- the target of this PI
-
setTarget
void setTarget(java.lang.String target)
This method is the equivalent to theNode.setName(java.lang.String)
method. It is added for clarity.- Parameters:
target
- DOCUMENT ME!
-
getText
java.lang.String getText()
DOCUMENT ME!
-
getValue
java.lang.String getValue(java.lang.String name)
Returns the value of a specific name in the PI.
- Parameters:
name
- is the name of the attribute to lookup.- Returns:
- the value of the named attribute
-
getValues
java.util.Map<java.lang.String,java.lang.String> getValues()
DOCUMENT ME!- Returns:
- the values for this processing instruction as a Map
-
setValue
void setValue(java.lang.String name, java.lang.String value)
-
setValues
void setValues(java.util.Map<java.lang.String,java.lang.String> data)
-
removeValue
boolean removeValue(java.lang.String name)
-
-