com.xmlmind.xml.doc

Class ProcessingInstruction

java.lang.Object

com.xmlmind.xml.doc.Node

com.xmlmind.xml.doc.TextNode

com.xmlmind.xml.doc.ProcessingInstruction

All Implemented Interfaces:

TextAccess, XNode, Serializable, Comparable<XNode>

public final class ProcessingInstruction
extends TextNode

A processing instruction node.

A processing instruction may contain characters and always has a target, which is treated as a pseudo-attribute (that is, it is not part of the textual content of the pseudo-instruction).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.xmlmind.xml.doc.Node

Node.PropertyIterator, Node.Type

Field Summary

Fields inherited from class com.xmlmind.xml.doc.TextNode

chars

Fields inherited from class com.xmlmind.xml.doc.Node

ALL_PROPERTIES, EMPTY_LIST, FALSE, listenerData, next, NO_PROPERTY_ITERATOR, parent, previous, properties, readOnly, TRUE, UNSET

Constructor Summary

Constructors

Constructor and Description
ProcessingInstruction(String target) Constructs a empty processing instruction node.
ProcessingInstruction(String target, char[] text, int offset, int length) Constructs a processing instruction node containing specified characters.
ProcessingInstruction(String target, String text) Constructs a processing instruction node containing specified characters.

Method Summary

Modifier and Type	Method and Description
Node	copy() Returns a deep copy of this node.
static String	formatPseudoAttributes(String[] nameValuePairs) Formats specified pseudo-attribute name/value pairs.
String[]	getPseudoAttributes() Returns the textual content of this processing instruction parsed as pseudo-attributes.
static String[]	getRegisteredTargets() Returns the (possibly empty) array of all registered PI targets.
String	getTarget() Returns the target of this processing instruction
Node.Type	getType() Returns the type of this node.
static boolean	isRegisteredTarget(String target) Tests whether specified target is a registered PI target.
Name	name() Returns the name of this element node, the name of this attribute node or the target of this processing-instruction node.
static String[]	parsePseudoAttributes(String text) Parses specified text as if it was the XML representation of a list of attributes.
static void	registerTarget(String target) Registers specified PI target.
void	setPseudoAttributes(String[] nameValuePairs) Changes the text contained in this processing instruction to specified pseudo-attribute name/value pairs.
void	setTarget(String target) Changes the target of this processing instruction.
static void	unregisterTarget(String target) Unregisters specified PI target.

Methods inherited from class com.xmlmind.xml.doc.TextNode

appendText, data, deleteText, getText, getTextChar, getTextChars, getTextLength, insertText, isXMLSpace, replaceText, setText

Methods inherited from class com.xmlmind.xml.doc.Node

attributes, attributeValue, canInsertBefore, canReplace, compareTo, copyProperties, deepCopy, document, doGetBaseURL, equals, findCommonAncestor, firstChild, following, getBaseURL, getDocument, getDocumentListenerData, getFirstSibling, getInclusion, getLabel, getLastSibling, getNextElement, getNextSibling, getParent, getParentElement, getPosition, getPreviousElement, getPreviousSibling, getProperties, getProperty, getPropertyCount, getPropertyNames, getShortLabel, getSourceURL, getXPath, hasProperty, indexOfDocumentListenerData, isAncestorOf, isDescendantOf, isEditable, isReadOnly, isSiblingOf, lastChild, lookupInclusion, lookupInclusion, lookupProperty, namespacePrefixMap, parent, preceding, putProperty, removeProperties, removeProperty, sameInclusion, setDocumentListenerData, toString, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcessingInstruction

public ProcessingInstruction(String target)

Constructs a empty processing instruction node.

Parameters:

target - the target of this processing instruction

ProcessingInstruction

public ProcessingInstruction(String target,
                             String text)

Constructs a processing instruction node containing specified characters.

The target must be a NAME which does not begin with "xml". This is not checked by the constructors.

Parameters:

target - the target of this processing instruction

text - contains characters used to initialize this processing instruction node

ProcessingInstruction

public ProcessingInstruction(String target,
                             char[] text,
                             int offset,
                             int length)

Constructs a processing instruction node containing specified characters.

Parameters:

target - the target of this processing instruction

text - contains characters used to initialize this processing instruction node

offset - index of first character within text used to initialize this processing instruction node

length - number of characters in text used to initialize this processing instruction node

Method Detail

registerTarget

public static void registerTarget(String target)

Registers specified PI target. This target may end with a "*" (example "xxe-*") which means that what's being registered is in fact a prefix.

When a PI having a registered prefix is inserted (just inserted, not deleted or replaced) in a Document, a PITargetEvent document event is sent to all DocumentListeners. The goal is to make it easy activating code in the application handling the registered PI.

See Also:

unregisterTarget(java.lang.String), getRegisteredTargets()

unregisterTarget

public static void unregisterTarget(String target)

Unregisters specified PI target.

See Also:

registerTarget(java.lang.String), getRegisteredTargets()

getRegisteredTargets

public static String[] getRegisteredTargets()

Returns the (possibly empty) array of all registered PI targets.

See Also:

registerTarget(java.lang.String), unregisterTarget(java.lang.String)

isRegisteredTarget

public static boolean isRegisteredTarget(String target)

Tests whether specified target is a registered PI target.

See Also:

registerTarget(java.lang.String)

copy

public Node copy()

Description copied from class: Node

Returns a deep copy of this node.

Note that node properties are automatically copied too. See Node.copyProperties(com.xmlmind.xml.doc.Node).

Specified by:

copy in class Node

getType

public Node.Type getType()

Description copied from class: Node

Returns the type of this node.

Specified by:

getType in class Node

getTarget

public String getTarget()

Returns the target of this processing instruction

setTarget

public void setTarget(String target)

Changes the target of this processing instruction.

Parameters:

target - the new target

getPseudoAttributes

public String[] getPseudoAttributes()

Returns the textual content of this processing instruction parsed as pseudo-attributes.

See Also:

parsePseudoAttributes(java.lang.String)

parsePseudoAttributes

public static String[] parsePseudoAttributes(String text)

Parses specified text as if it was the XML representation of a list of attributes.

Example:

from="me" to='you'

is parsed as:

from
me
to
you

Important: this method does not unescape parsed pseudo-attribute values. It merely "unprotects" (using a proprietary method) the apostrophe character (U+0027) in case formatPseudoAttributes(java.lang.String[]) "protected" this character.

Parameters:

text - parsed text

Returns:

an array of String pairs: pseudo-attribute name followed by pseudo-attribute value or null if text has syntax errors.

See Also:

XMLText.unescapeXML(java.lang.String)

setPseudoAttributes

public void setPseudoAttributes(String[] nameValuePairs)

Changes the text contained in this processing instruction to specified pseudo-attribute name/value pairs.

See Also:

formatPseudoAttributes(java.lang.String[])

formatPseudoAttributes

public static String formatPseudoAttributes(String[] nameValuePairs)

Formats specified pseudo-attribute name/value pairs. This is the inverse operation of parsePseudoAttributes(java.lang.String).

Example:

from
me
to
you

is formatted as:

from="me" to="you"

Important: this method does not escape passed pseudo-attribute values. It merely "protects" (using a proprietary method) the apostrophe character (U+0027) to let parsePseudoAttributes(java.lang.String) function in all cases.

Parameters:

nameValuePairs - an array of String pairs: pseudo-attribute name followed by pseudo-attribute value.

A null value is equivalent to the empty string.

Returns:

formatted text

See Also:

XMLText.escapeXML(java.lang.String)

name

public Name name()

Description copied from interface: XNode

Returns the name of this element node, the name of this attribute node or the target of this processing-instruction node. Returns null for all other types of nodes.

The target of a processing-instruction has no namespace.

Specified by:

name in interface XNode

Overrides:

name in class Node