    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Interface com.jclark.xml.parse.ParseLocation

public interface ParseLocation

Information about the location of the parse of an XML document.

##

getByteIndex()
  Returns the byte index of the first byte of the character being parsed or -1 if no byte index is available.
getColumnNumber()
  Returns the column number of the character being parsed or -1 if no column number is available.
getEntityBase()
  Returns the URL to use as the base URL for resolving relative URLs contained in the entity being parsed.
getEntityLocation()
  Returns the location of the external entity being parsed in a form suitable for use in a message.
getLineNumber()
  Returns the line number of the character being parsed or -1 if no line number is available.

##

getEntityLocation

     public abstract String getEntityLocation()

  Returns the location of the external entity being parsed in a form suitable for use in a message. Returns null if no location is available. This is typically a URI or a filename.

getEntityBase

     public abstract URL getEntityBase()

  Returns the URL to use as the base URL for resolving relative URLs contained in the entity being parsed.

getLineNumber

     public abstract int getLineNumber()

  Returns the line number of the character being parsed or -1 if no line number is available. The number of the first line is 1.

getColumnNumber

     public abstract int getColumnNumber()

  Returns the column number of the character being parsed or -1 if no column number is available. The number of the first column in a line is 0. A tab character is not treated specially.

getByteIndex

     public abstract long getByteIndex()

  Returns the byte index of the first byte of the character being parsed or -1 if no byte index is available. The index of the first byte is 0.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index