com.ctc.wstx.io
Class WstxInputLocation

java.lang.Object
  extended by com.ctc.wstx.io.WstxInputLocation
All Implemented Interfaces:
Serializable, Location, XMLStreamLocation2

public class WstxInputLocation
extends Object
implements Serializable, XMLStreamLocation2

Basic implementation of Location, used by Wstx readers.

See Also:
Serialized Form

Field Summary
protected  int mCharOffset
           
protected  int mCol
           
protected  WstxInputLocation mContext
          Enclosing (parent) input location; location from which current location is derived.
protected  String mDesc
           
protected  String mPublicId
           
protected  int mRow
           
protected  String mSystemId
           
 
Fields inherited from interface org.codehaus.stax2.XMLStreamLocation2
NOT_AVAILABLE
 
Constructor Summary
WstxInputLocation(WstxInputLocation ctxt, String pubId, String sysId, int charOffset, int row, int col)
           
 
Method Summary
 boolean equals(Object o)
           
 int getCharacterOffset()
           
 int getColumnNumber()
           
 XMLStreamLocation2 getContext()
          Method that can be used to traverse nested locations, like ones created when expanding entities (especially external entities).
static WstxInputLocation getEmptyLocation()
           
 int getLineNumber()
           
 String getPublicId()
           
 String getSystemId()
           
 int hashCode()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

mContext

protected final WstxInputLocation mContext
Enclosing (parent) input location; location from which current location is derived.


mPublicId

protected final String mPublicId

mSystemId

protected final String mSystemId

mCharOffset

protected final int mCharOffset

mCol

protected final int mCol

mRow

protected final int mRow

mDesc

protected transient String mDesc
Constructor Detail

WstxInputLocation

public WstxInputLocation(WstxInputLocation ctxt,
                         String pubId,
                         String sysId,
                         int charOffset,
                         int row,
                         int col)
Parameters:
ctxt - Enclosing input location, if any
Method Detail

getEmptyLocation

public static WstxInputLocation getEmptyLocation()

getCharacterOffset

public int getCharacterOffset()
Specified by:
getCharacterOffset in interface Location

getColumnNumber

public int getColumnNumber()
Specified by:
getColumnNumber in interface Location

getLineNumber

public int getLineNumber()
Specified by:
getLineNumber in interface Location

getPublicId

public String getPublicId()
Specified by:
getPublicId in interface Location

getSystemId

public String getSystemId()
Specified by:
getSystemId in interface Location

getContext

public XMLStreamLocation2 getContext()
Description copied from interface: XMLStreamLocation2
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.

Specified by:
getContext in interface XMLStreamLocation2
Returns:
Location in the context (parent input source), if any; null for locations in the outermost known context

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object o)
Overrides:
equals in class Object