Locator

Interface for associating a SAX event with a document location.

<p>If a SAX parser provides location information to the SAX application, it does so by implementing this interface and then passing an instance to the application using the content handler's {@link org.xml.sax.ContentHandler#setDocumentLocator setDocumentLocator} method. The application can use the object to obtain the location of any other SAX event in the XML source document.</p>

<p>Note that the results returned by the object will be valid only during the scope of each callback method: the application will receive unpredictable results if it attempts to use the locator at any other time, or after parsing completes.</p>

<p>SAX parsers are not required to supply a locator, but they are very strongly encouraged to do so. If the parser supplies a locator, it must do so before reporting any other document events. If no locator has been set by the time the application receives the {@link org.xml.sax.ContentHandler#startDocument startDocument} event, the application should assume that a locator is not available.</p>

@since SAX 1.0 @author David Megginson @version 2.0.1 (sax2r2) @see org.xml.sax.ContentHandler#setDocumentLocator

Members

Functions

getColumnNumber
int getColumnNumber()

Return the column number where the current document event ends. This is one-based number of Java <code>char</code> values since the last line end.

getLineNumber
int getLineNumber()

Return the line number where the current document event ends. Lines are delimited by line ends, which are defined in the XML specification.

getPublicId
const(Ch)[] getPublicId()

Return the public identifier for the current document event.

getSystemId
const(Ch)[] getSystemId()

Return the system identifier for the current document event.

Meta