Top Description Fields Constructors Methods
org.apache.xerces.stax

public Class ImmutableLocation

extends Object
implements Location
Class Inheritance
All Implemented Interfaces
javax.xml.stream.Location
Imports
javax.xml.stream.Location

An immutable StAX Location.

Author
Michael Glavassevich, IBM
Version
$Id: ImmutableLocation.java 730445 2008-12-31 19:12:02Z mrglavas $

Field Summary

Modifier and TypeField and Description
private final int
fCharacterOffset

private final int
fColumnNumber

private final int
fLineNumber

private final String
fPublicId

private final String
fSystemId

Constructor Summary

AccessConstructor and Description
public
ImmutableLocation(Location location)

public
ImmutableLocation(int characterOffset, int columnNumber, int lineNumber, String publicId, String systemId)

Method Summary

Modifier and TypeMethod and Description
public int
getCharacterOffset()

Implements javax.xml.stream.Location.getCharacterOffset.

Return the byte or character offset into the input source this location is pointing to.
public int
getColumnNumber()

Implements javax.xml.stream.Location.getColumnNumber.

Return the column number where the current event ends, returns -1 if none is available.
public int
getLineNumber()

Implements javax.xml.stream.Location.getLineNumber.

Return the line number where the current event ends, returns -1 if none is available.
public String
getPublicId()

Implements javax.xml.stream.Location.getPublicId.

Returns the public ID of the XML
public String
getSystemId()

Implements javax.xml.stream.Location.getSystemId.

Returns the system ID of the XML
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fCharacterOffsetback to summary
private final int fCharacterOffset
fColumnNumberback to summary
private final int fColumnNumber
fLineNumberback to summary
private final int fLineNumber
fPublicIdback to summary
private final String fPublicId
fSystemIdback to summary
private final String fSystemId

Constructor Detail

ImmutableLocationback to summary
public ImmutableLocation(Location location)
ImmutableLocationback to summary
public ImmutableLocation(int characterOffset, int columnNumber, int lineNumber, String publicId, String systemId)

Method Detail

getCharacterOffsetback to summary
public int getCharacterOffset()

Implements javax.xml.stream.Location.getCharacterOffset.

Doc from javax.xml.stream.Location.getCharacterOffset.

Return the byte or character offset into the input source this location is pointing to. If the input source is a file or a byte stream then this is the byte offset into that stream, but if the input source is a character media then the offset is the character offset. Returns -1 if there is no offset available.

Returns:int

the current offset

getColumnNumberback to summary
public int getColumnNumber()

Implements javax.xml.stream.Location.getColumnNumber.

Doc from javax.xml.stream.Location.getColumnNumber.

Return the column number where the current event ends, returns -1 if none is available.

Returns:int

the current column number

getLineNumberback to summary
public int getLineNumber()

Implements javax.xml.stream.Location.getLineNumber.

Doc from javax.xml.stream.Location.getLineNumber.

Return the line number where the current event ends, returns -1 if none is available.

Returns:int

the current line number

getPublicIdback to summary
public String getPublicId()

Implements javax.xml.stream.Location.getPublicId.

Doc from javax.xml.stream.Location.getPublicId.

Returns the public ID of the XML

Returns:String

the public ID, or null if not available

getSystemIdback to summary
public String getSystemId()

Implements javax.xml.stream.Location.getSystemId.

Doc from javax.xml.stream.Location.getSystemId.

Returns the system ID of the XML

Returns:String

the system ID, or null if not available