Package jadex.xml.stax

Class StaxLocationWrapper

  • All Implemented Interfaces:
    ILocation
    public class StaxLocationWrapper
extends java.lang.Object
implements ILocation
    Wraps a javax.xml.stream.Location Object to provide the jadex.xml.stax.ILocation API.

    • Constructor Summary

      Constructors 
      Constructor Description
      StaxLocationWrapper​(javax.xml.stream.Location loc)
      Constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ILocation fromLocation​(javax.xml.stream.Location loc)
      Static method to wrap a Location object
      int getCharacterOffset()
      Return the byte or character offset into the input source this location is pointing to.
      int getColumnNumber()
      Return the column number where the current event ends, returns -1 if none is available.
      int getLineNumber()
      Return the line number where the current event ends, returns -1 if none is available.
      java.lang.String getPublicId()
      Returns the public ID of the XML
      java.lang.String getSystemId()
      Returns the system ID of the XML

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • StaxLocationWrapper

        public StaxLocationWrapper​(javax.xml.stream.Location loc)
        Constructor.
        Parameters:
        loc - The location to be wrapped.

    • Method Detail

      • getLineNumber

        public int getLineNumber()
        Return the line number where the current event ends, returns -1 if none is available.
        Specified by:
        getLineNumber in interface ILocation
        Returns:
        the current line number

      • getColumnNumber

        public int getColumnNumber()
        Return the column number where the current event ends, returns -1 if none is available.
        Specified by:
        getColumnNumber in interface ILocation
        Returns:
        the current column number

      • getCharacterOffset

        public int 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.
        Specified by:
        getCharacterOffset in interface ILocation
        Returns:
        the current offset

      • getPublicId

        public java.lang.String getPublicId()
        Returns the public ID of the XML
        Specified by:
        getPublicId in interface ILocation
        Returns:
        the public ID, or null if not available

      • getSystemId

        public java.lang.String getSystemId()
        Returns the system ID of the XML
        Specified by:
        getSystemId in interface ILocation
        Returns:
        the system ID, or null if not available

      • fromLocation

        public static ILocation fromLocation​(javax.xml.stream.Location loc)
        Static method to wrap a Location object
        Parameters:
        loc - The location object to be wrapped
        Returns:
        the wrapped Location