nu.xom
Class ProcessingInstruction

java.lang.Object
  extended bynu.xom.Node
      extended bynu.xom.LeafNode
          extended bynu.xom.ProcessingInstruction

public class ProcessingInstruction
extends LeafNode

Represents an XML processing instruction. Each processing instruction has two key properties:

Version:
1.0d23
Author:
Elliotte Rusty Harold

Constructor Summary
ProcessingInstruction(ProcessingInstruction instruction)
           Create a copy of a processing instruction.
ProcessingInstruction(java.lang.String target, java.lang.String data)
           Create a processing instruction with a certain target and data.
 
Method Summary
protected  void checkTarget(java.lang.String target)
           Subclasses can override this method to perform additional checks on the data beyond what XML 1.0 requires.
protected  void checkValue(java.lang.String data)
           Subclasses can override this method to perform additional checks on the data beyond what XML 1.0 requires.
 Node copy()
           Returns a deep copy of this processing instruction with no parent, that can be added to this document or a different one.
 java.lang.String getTarget()
           Returns the processing instruction target.
 java.lang.String getValue()
           Returns the processing instruction data.
 void setTarget(java.lang.String target)
           Sets the target.
 void setValue(java.lang.String data)
           Sets the data.
 java.lang.String toString()
           Returns a String representation of this processing instruction suitable for debugging and diagnosis.
 java.lang.String toXML()
           Returns the actual XML form of this processing instruction, such as might be copied and pasted from the original document.
 
Methods inherited from class nu.xom.LeafNode
getChild, getChildCount, hasChildren
 
Methods inherited from class nu.xom.Node
checkDetach, detach, equals, getBaseURI, getDocument, getParent, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProcessingInstruction

public ProcessingInstruction(java.lang.String target,
                             java.lang.String data)

Create a processing instruction with a certain target and data.

Parameters:
target - the target of the processing instruction
data - the processing instruction data
Throws:
IllegalTargetException - if the target is not a non-colonized name or is made of the string "xml" in any case.
IllegalDataException - if data contains "?>" or any other illegal characters

ProcessingInstruction

public ProcessingInstruction(ProcessingInstruction instruction)

Create a copy of a processing instruction.

Parameters:
instruction - the processing instruction to copy
Method Detail

getTarget

public final java.lang.String getTarget()

Returns the processing instruction target.

Returns:
the target

setTarget

public final void setTarget(java.lang.String target)

Sets the target.

Parameters:
target - the new target
Throws:
IllegalTargetException - if the proposed target is not an XML 1.0 non-colonized name
XMLException - if the proposed target does not satisfy the local constraints

checkTarget

protected void checkTarget(java.lang.String target)

Subclasses can override this method to perform additional checks on the data beyond what XML 1.0 requires. For example, an XMLStylesheet subclass might throw an exception if the target were not xml-stylesheet.

Parameters:
target - the potential target to check.
Throws:
XMLException - if the proposed target does not satisfy the local constraints

setValue

public final void setValue(java.lang.String data)

Sets the data.

Parameters:
data - the data to set
Throws:
IllegalDataException - if data is null or otherwise not legal XML processingInstrcution data
XMLException - if the proposed data does not satisfy the local constraints

getValue

public final java.lang.String getValue()

Returns the processing instruction data.

Specified by:
getValue in class Node
Returns:
the data of the processing instruction
See Also:
Node.getValue()

checkValue

protected void checkValue(java.lang.String data)

Subclasses can override this method to perform additional checks on the data beyond what XML 1.0 requires. For example, an XMLStylesheet subclass might throw an exception if the data did not have a pseudo-attribute format.

Parameters:
data - the potential data to check.
Throws:
XMLException - if the proposed data does not satisfy the local constraints

toXML

public final java.lang.String toXML()

Returns the actual XML form of this processing instruction, such as might be copied and pasted from the original document.

Specified by:
toXML in class Node
Returns:
an XML representation of this processing instruction as a String
See Also:
Node.toXML()

copy

public Node copy()

Returns a deep copy of this processing instruction with no parent, that can be added to this document or a different one.

Specified by:
copy in class Node
Returns:
a copy of this ProcessingInstruction with no parent
See Also:
Node.copy()

toString

public final java.lang.String toString()

Returns a String representation of this processing instruction suitable for debugging and diagnosis. This is not the XML representation of this processing instruction.

Specified by:
toString in class Node
Returns:
a non-XML string representation of this ProcessingInstruction
See Also:
Object.toString()


Copyright 2002-2004 Elliotte Rusty Harold
elharo@metalab.unc.edu