javolution.xml.stream.Location Maven / Gradle / Ivy
/*
* Javolution - Java(TM) Solution for Real-Time and Embedded Systems
* Copyright (C) 2012 - Javolution (http://javolution.org/)
* All rights reserved.
*
* Permission to use, copy, modify, and distribute this software is
* freely granted, provided that this notice is preserved.
*/
package javolution.xml.stream;
/**
* Provides information on the location of an event.
*
* @author Jean-Marie Dautelle
* @version 3.8, May 22, 2006
*/
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();
}