Top Description Fields Constructors Methods
org.jdom2.located

public Class LocatedEntityRef

extends EntityRef
implements Located
Class Inheritance
All Implemented Interfaces
org.jdom2.located.Located
Imports
org.jdom2.EntityRef, .IllegalDataException, .IllegalNameException

An XML entity reference. Methods allow the user to manage its name, public id, and system id.
Author
Rolf Lear

Field Summary

Modifier and TypeField and Description
private int
private int
private static final long
Inherited from org.jdom2.EntityRef:
namepublicIDsystemID

Constructor Summary

AccessConstructor and Description
public
LocatedEntityRef(String
String name of element.
name
)

This will create a new EntityRef with the supplied name.

public
LocatedEntityRef(String
String name of element.
name
,
String
system id of the entity reference being constructed
systemID
)

This will create a new EntityRef with the supplied name and system id.

public
LocatedEntityRef(String
String name of element.
name
,
String
public id of the entity reference being constructed
publicID
,
String
system id of the entity reference being constructed
systemID
)

This will create a new EntityRef with the supplied name, public id, and system id.

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.EntityRef:
clonedetachgetNamegetParentgetPublicIDgetSystemIDgetValuesetNamesetParentsetPublicIDsetSystemIDtoString

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.EntityRef.serialVersionUID.

JDOM2 Serialization. In this case, DocType is simple.

Constructor Detail

LocatedEntityRefback to summary
public LocatedEntityRef(String name)

This will create a new EntityRef with the supplied name.

Parameters
name:String

String name of element.

Exceptions
IllegalNameException:
if the given name is not a legal XML name.
LocatedEntityRefback to summary
public LocatedEntityRef(String name, String systemID)

This will create a new EntityRef with the supplied name and system id.

Parameters
name:String

String name of element.

systemID:String

system id of the entity reference being constructed

Exceptions
IllegalNameException:
if the given name is not a legal XML name.
IllegalDataException:
if the given system ID is not a legal system literal.
LocatedEntityRefback to summary
public LocatedEntityRef(String name, String publicID, String systemID)

This will create a new EntityRef with the supplied name, public id, and system id.

Parameters
name:String

String name of element.

publicID:String

public id of the entity reference being constructed

systemID:String

system id of the entity reference being constructed

Exceptions
IllegalDataException:
if the given system ID is not a legal system literal or the the given public ID is not a legal public ID
IllegalNameException:
if the given name is not a legal XML 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