Top Description Fields Constructors Methods
org.jdom2.located

public Class LocatedProcessingInstruction

extends ProcessingInstruction
implements Located
Class Inheritance
All Implemented Interfaces
org.jdom2.located.Located
Imports
java.util.Map, org.jdom2.IllegalTargetException, .ProcessingInstruction

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

Field Summary

Modifier and TypeField and Description
private int
private int
private static final long
Inherited from org.jdom2.ProcessingInstruction:
mapDatarawDatatarget

Constructor Summary

AccessConstructor and Description
public
LocatedProcessingInstruction(String
String target of PI.
target
)

This will create a new ProcessingInstruction with the specified target.

public
LocatedProcessingInstruction(String
String target of PI.
target
,
Map<String, String>
Map data for PI, in name/value pairs
data
)

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

public
LocatedProcessingInstruction(String
String target of PI.
target
,
String
String data for PI.
data
)

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

Method Summary

Modifier and TypeMethod and Description
public int
getColumn()

Implements org.jdom2.located.Located.getColumn.

Get the column (character on the line).
public int
getLine()

Implements org.jdom2.located.Located.getLine.

Get the line number
public void
setColumn(int
The column
col
)

Implements org.jdom2.located.Located.setColumn.

Set the column (character on the line).
public void
setLine(int
the line.
line
)

Implements org.jdom2.located.Located.setLine.

Set the line number
Inherited from org.jdom2.ProcessingInstruction:
clonedetachgetDatagetPseudoAttributeNamesgetPseudoAttributeValuegetTargetgetValueremovePseudoAttributesetDatasetDatasetParentsetPseudoAttributesetTargettoString

Field Detail

colback to summary
private int col
lineback to summary
private int line
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jdom2.ProcessingInstruction.serialVersionUID.

JDOM2 Serialization. In this case, DocType is simple.

Constructor Detail

LocatedProcessingInstructionback to summary
public LocatedProcessingInstruction(String target)

This will create a new ProcessingInstruction with the specified target.

Parameters
target:String

String target of PI.

Exceptions
IllegalTargetException:
if the given target is illegal as a processing instruction name.
LocatedProcessingInstructionback to summary
public LocatedProcessingInstruction(String target, Map<String, String> data)

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

Parameters
target:String

String target of PI.

data:Map<String, String>

Map data for PI, in name/value pairs

Exceptions
IllegalTargetException:
if the given target is illegal as a processing instruction name.
LocatedProcessingInstructionback to summary
public LocatedProcessingInstruction(String target, String data)

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

Parameters
target:String

String target of PI.

data:String

String data for PI.

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

Method Detail

getColumnback to summary
public int getColumn()

Implements org.jdom2.located.Located.getColumn.

Doc from org.jdom2.located.Located.getColumn.

Get the column (character on the line).

Returns:int

the column

Annotations
@Override
getLineback to summary
public int getLine()

Implements org.jdom2.located.Located.getLine.

Doc from org.jdom2.located.Located.getLine.

Get the line number

Returns:int

the line number

Annotations
@Override
setColumnback to summary
public void setColumn(int col)

Implements org.jdom2.located.Located.setColumn.

Doc from org.jdom2.located.Located.setColumn.

Set the column (character on the line).

Parameters
col:int

The column

Annotations
@Override
setLineback to summary
public void setLine(int line)

Implements org.jdom2.located.Located.setLine.

Doc from org.jdom2.located.Located.setLine.

Set the line number

Parameters
line:int

the line.

Annotations
@Override