Class LocatedProcessingInstruction

java.lang.Object

org.jdom2.Content

org.jdom2.ProcessingInstruction

org.jdom2.located.LocatedProcessingInstruction

All Implemented Interfaces:

Serializable, Cloneable, Located, NamespaceAware

public class LocatedProcessingInstruction
extends ProcessingInstruction
implements Located

An XML processing instruction. Methods allow the user to obtain the target of the PI as well as its data. The data can always be accessed as a String or, if the data appears akin to an attribute list, can be retrieved as name/value pairs.

Author:

Rolf Lear

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class Content

Content.CType

Field Summary

Fields inherited from class ProcessingInstruction

mapData, rawData, target

Fields inherited from class Content

ctype, parent

Constructor Summary

Constructors

Constructor	Description
LocatedProcessingInstruction(String target)	This will create a new ProcessingInstruction with the specified target.
LocatedProcessingInstruction(String target, String data)	This will create a new ProcessingInstruction with the specified target and data.
LocatedProcessingInstruction(String target, Map<String,String> data)	This will create a new ProcessingInstruction with the specified target and data.

Method Summary

Modifier and Type	Method	Description
int	getColumn()	Get the column (character on the line).
int	getLine()	Get the line number
void	setColumn(int col)	Set the column (character on the line).
void	setLine(int line)	Set the line number

Methods inherited from class ProcessingInstruction

clone, detach, getData, getPseudoAttributeNames, getPseudoAttributeValue, getTarget, getValue, removePseudoAttribute, setData, setData, setParent, setPseudoAttribute, setTarget, toString

Methods inherited from class Content

equals, getCType, getDocument, getNamespacesInherited, getNamespacesInScope, getNamespacesIntroduced, getParent, getParentElement, hashCode

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LocatedProcessingInstruction

public LocatedProcessingInstruction(String target)

This will create a new ProcessingInstruction with the specified target.

Parameters:

target - String target of PI.

Throws:

IllegalTargetException - if the given target is illegal as a processing instruction name.

LocatedProcessingInstruction

public LocatedProcessingInstruction(String target,
 Map<String,String> data)

This will create a new ProcessingInstruction with the specified target and data.

Parameters:

target - String target of PI.

data - Map data for PI, in name/value pairs

Throws:

IllegalTargetException - if the given target is illegal as a processing instruction name.

LocatedProcessingInstruction

public LocatedProcessingInstruction(String target,
 String data)

This will create a new ProcessingInstruction with the specified target and data.

Parameters:

target - String target of PI.

data - String data for PI.

Throws:

IllegalTargetException - if the given target is illegal as a processing instruction name.

Method Details

getLine

public int getLine()

Description copied from interface: Located

Get the line number

Specified by:

getLine in interface Located

Returns:

the line number

getColumn

public int getColumn()

Description copied from interface: Located

Get the column (character on the line).

Specified by:

getColumn in interface Located

Returns:

the column

setLine

public void setLine(int line)

Description copied from interface: Located

Set the line number

Specified by:

setLine in interface Located

Parameters:

line - the line.

setColumn

public void setColumn(int col)

Description copied from interface: Located

Set the column (character on the line).

Specified by:

setColumn in interface Located

Parameters:

col - The column