uk.ac.sheffield.jast.xml

Class Instruction

java.lang.Object

uk.ac.sheffield.jast.xml.Content

uk.ac.sheffield.jast.xml.Markup

uk.ac.sheffield.jast.xml.Descriptor

uk.ac.sheffield.jast.xml.Instruction

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<Content>

public class Instruction
extends Descriptor

Instruction is a an XML processing instruction for an XML processor. Instruction is a kind of Descriptor that may appear anywhere in an XML document and names a particular target program, which the XML processor may invoke to carry out special actions. A common example target is "xml-stylesheet", a target requesting stylesheet processing using CSS or XML stylesheets. Other targets are possible, but there is no consensus on names, such that these may only be interpreted by XML processors that were designed for them. Apart from the target, W3C defines no specific syntax for the contents of an Instruction, although it is common practice to use an attribute-value format. The tag delimiters for an Instruction are printed in a special way, using <? and ?>.

The JAST implementation of Instruction stores the target as a field; and other properties of an Instruction must be encoded as named Attributes and stored in the inherited attribute list. Technically this is more restrictive than the W3C syntax, which allows more liberal free-format text after the target. However, since the attribute-value format is a common style, it was convenient to adopt this restriction.

Version:

2.5

Author:

Anthony J H Simons

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	target The target of this Instruction, whether "xml-stylesheet" or some other target.

Fields inherited from class uk.ac.sheffield.jast.xml.Descriptor

attributeList

Fields inherited from class uk.ac.sheffield.jast.xml.Content

ATTRIBUTE, COMMENT, DATA, DECLARATION, DOCTYPE, DOCUMENT, ELEMENT, INSTRUCTION, TEXT, UNDEFINED

Constructor Summary

Constructors

Constructor and Description
Instruction(java.lang.String target) Creates an XML processing instruction with the specified target.

Method Summary

Modifier and Type	Method and Description
Instruction	addAttribute(Attribute node) Sets a named property of this Instruction.
Instruction	clone() Clones this Instruction node.
java.lang.String	getTarget() Returns the target of this Instruction.
int	getType() Returns the type of this Instruction.
Instruction	setValue(java.lang.String identifier, java.lang.String value) Sets the value of a named Attribute of this Instruction.

Methods inherited from class uk.ac.sheffield.jast.xml.Descriptor

getAttribute, getAttribute, getAttributes, getAttributes, getValue, hasAttributes, removeAttribute, removeAttribute

Methods inherited from class uk.ac.sheffield.jast.xml.Markup

getIdentifier, getName, getNamespace, getPrefix

Methods inherited from class uk.ac.sheffield.jast.xml.Content

addContent, addContent, descendants, descendants, detach, getComment, getContent, getContent, getContent, getContents, getContents, getDocument, getParent, getText, hasContents, iterator, iterator, removeContent, removeContent, removeContents, setParent, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

target

private java.lang.String target

The target of this Instruction, whether "xml-stylesheet" or some other target.

Constructor Detail

Instruction

public Instruction(java.lang.String target)

Creates an XML processing instruction with the specified target. The most common target is "xml-stylesheet", an instruction to use a Cascading Style Sheet (CSS), whose details are given in attributes.

Parameters:

target - the target of the Instruction.

Method Detail

clone

public Instruction clone()

Clones this Instruction node. Returns a deep copy of this Instruction, in which the attribute list has been recursively cloned.

Overrides:

clone in class Descriptor

Returns:

a clone of this Instruction node.

getType

public int getType()

Returns the type of this Instruction. Returns the integer constant, DECLARATION, denoting that this is a Instruction node.

Overrides:

getType in class Content

Returns:

the integer constant DECLARATION.

addAttribute

public Instruction addAttribute(Attribute node)

Sets a named property of this Instruction. If this Instruction already has an Attribute with the given name, replaces its value. Otherwise, adds the new Attribute object to this Instruction's list of attributes.

Overrides:

addAttribute in class Descriptor

Parameters:

node - the Attribute to set.

Returns:

this Instruction.

setValue

public Instruction setValue(java.lang.String identifier,
                            java.lang.String value)

Sets the value of a named Attribute of this Instruction.

Overrides:

setValue in class Descriptor

Parameters:

identifier - the Attribute's long identifier, or short name.

value - the Attribute value.

Returns:

this Instruction.

getTarget

public java.lang.String getTarget()

Returns the target of this Instruction. This is an identifier denoting the kind of program that will process this instruction. A common example target is "xml-stylesheet".

Returns:

the target of this Instruction.