Interface XMLStreamLocation2

All Superinterfaces:
Location
All Known Implementing Classes:
Stax2LocationAdapter

public interface XMLStreamLocation2 extends Location
Extension of Location that adds accessor to retrieve nested location information.
  • Field Details

    • NOT_AVAILABLE

      static final XMLStreamLocation2 NOT_AVAILABLE
      "Dummy" Location implementation and instance that can be return instead of null, when no location information is available.
  • Method Details

    • getContext

      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:
      Location in the context (parent input source), if any; null for locations in the outermost known context