Top Description Fields Methods
org.dom4j

public Interface ProcessingInstruction

extends Node
Known Direct Implementers
org.dom4j.tree.AbstractProcessingInstruction
Annotations
@SuppressWarnings:unused
Imports
java.util.Map
ProcessingInstruction defines an XML processing instruction. The Node#getNamemethod will return the target of the PI and the Node#getTextmethod will return the data from all of the instructions.
Author
James Strachan
Version
$Revision: 1.10 $

Field Summary

Inherited from org.dom4j.Node:
ANY_NODEATTRIBUTE_NODECDATA_SECTION_NODECOMMENT_NODEDOCUMENT_NODEDOCUMENT_TYPE_NODEELEMENT_NODEENTITY_REFERENCE_NODEMAX_NODE_TYPENAMESPACE_NODEPROCESSING_INSTRUCTION_NODETEXT_NODEUNKNOWN_NODE

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the target of this PI
getTarget()

This method is the equivalent to the getNamemethod.

public String

Returns:

the text for all the data associated with the processing instruction
getText()

Redeclares org.dom4j.Node.getText.

DOCUMENT ME!
public String

Returns:

the value of the named attribute
getValue(String
is the name of the attribute to lookup.
name)

Returns the value of a specific name in the PI.

public Map<String, String>

Returns:

the values for this processing instruction as a Map
getValues()

DOCUMENT ME!

public boolean
removeValue(String name)

public void
setTarget(String
DOCUMENT ME!
target)

This method is the equivalent to the setNamemethod.

public void
setValue(String name, String value)

public void
setValues(Map<String, String> data)

Inherited from org.dom4j.Node:
acceptasXMLasXPathResultclonecreateXPathdetachgetDocumentgetNamegetNodeTypegetNodeTypeNamegetParentgetPathgetPathgetStringValuegetUniquePathgetUniquePathhasContentisReadOnlymatchesnumberValueOfselectNodesselectNodesselectNodesselectObjectselectSingleNodesetDocumentsetNamesetParentsetTextsupportsParentvalueOfwrite

Method Detail

getTargetback to summary
public String getTarget()

This method is the equivalent to the getNamemethod. It is added for clarity.

Returns:String

the target of this PI

getTextback to summary
public String getText()

Redeclares org.dom4j.Node.getText.

DOCUMENT ME!

Returns:String

the text for all the data associated with the processing instruction

getValueback to summary
public String getValue(String name)

Returns the value of a specific name in the PI.

Parameters
name:String

is the name of the attribute to lookup.

Returns:String

the value of the named attribute

getValuesback to summary
public Map<String, String> getValues()

DOCUMENT ME!

Returns:Map<String, String>

the values for this processing instruction as a Map

removeValueback to summary
public boolean removeValue(String name)
setTargetback to summary
public void setTarget(String target)

This method is the equivalent to the setNamemethod. It is added for clarity.

Parameters
target:String

DOCUMENT ME!

setValueback to summary
public void setValue(String name, String value)
setValuesback to summary
public void setValues(Map<String, String> data)