Top Description Fields Constructors Methods
org.codehaus.stax2.ri

public Class Stax2LocationAdapter

extends Object
implements XMLStreamLocation2
Class Inheritance
All Implemented Interfaces
org.codehaus.stax2.XMLStreamLocation2, javax.xml.stream.Location
Imports
javax.xml.stream.Location, org.codehaus.stax2.XMLStreamLocation2
Simple implementation of XMLStreamLocation2, which just wraps Stax 1.0 Location and adds no-operation implementation of the additions.

Field Summary

Modifier and TypeField and Description
protected final Location
mParentLocation

protected final Location
mWrappedLocation

Constructor Summary

AccessConstructor and Description
public
Stax2LocationAdapter(Location loc)

public
Stax2LocationAdapter(Location loc, Location parent)

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 XMLStreamLocation2
getContext()

Implements org.codehaus.stax2.XMLStreamLocation2.getContext.

Method that can be used to traverse nested locations, like ones created when expanding entities (especially external entities).
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

mParentLocationback to summary
protected final Location mParentLocation
mWrappedLocationback to summary
protected final Location mWrappedLocation

Constructor Detail

Stax2LocationAdapterback to summary
public Stax2LocationAdapter(Location loc)
Stax2LocationAdapterback to summary
public Stax2LocationAdapter(Location loc, Location parent)

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

Annotations
@Override
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

Annotations
@Override
getContextback to summary
public XMLStreamLocation2 getContext()

Implements org.codehaus.stax2.XMLStreamLocation2.getContext.

Doc from org.codehaus.stax2.XMLStreamLocation2.getContext.

Method that can be used to traverse nested locations, like ones created when expanding entities (especially external entities). If so, single location object only contains information about specific offsets and ids, and a link to its context. Outermost location will return null to indicate there is no more information to retrieve.

Returns:XMLStreamLocation2

Location in the context (parent input source), if any; null for locations in the outermost known context

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override