Top Description Fields Methods
org.codehaus.stax2

public Interface XMLStreamLocation2

extends Location
Known Direct Implementers
org.codehaus.stax2.ri.Stax2LocationAdapter
Imports
javax.xml.stream.Location

Extension of Location that adds accessor to retrieve nested location information.

Field Summary

Modifier and TypeField and Description
public static final XMLStreamLocation2
NOT_AVAILABLE

"Dummy" Location implementation and instance that can be return instead of null, when no location information is available.

Method Summary

Modifier and TypeMethod and Description
public XMLStreamLocation2

Returns:

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

Method that can be used to traverse nested locations, like ones created when expanding entities (especially external entities).

Inherited from javax.xml.stream.Location:
getCharacterOffsetgetColumnNumbergetLineNumbergetPublicIdgetSystemId

Field Detail

NOT_AVAILABLEback to summary
public static final XMLStreamLocation2 NOT_AVAILABLE

"Dummy" Location implementation and instance that can be return instead of null, when no location information is available.

Method Detail

getContextback to summary
public 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