javax.xml.stream.Location Maven / Gradle / Ivy
Go to download
StAX is a standard XML processing API that allows you to stream XML data from and to your application.
package javax.xml.stream;
/**
* Provides information on the location of an event.
*
* All the information provided by a Location is optional. For example
* an application may only report line numbers.
*
* @version 1.0
* @author Copyright (c) 2003 by BEA Systems. All Rights Reserved.
*/
public interface Location {
/**
* Return the line number where the current event ends,
* returns -1 if none is available.
* @return the current line number
*/
int getLineNumber();
/**
* Return the column number where the current event ends,
* returns -1 if none is available.
* @return the current column number
*/
int getColumnNumber();
/**
* 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.
* @return the current offset
*/
int getCharacterOffset();
/**
* Returns the public ID of the XML
* @return the public ID, or null if not available
*/
public String getPublicId();
/**
* Returns the system ID of the XML
* @return the system ID, or null if not available
*/
public String getSystemId();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy