net.n3.nanoxml

Interface IXMLReader

public interface IXMLReader

IXMLReader reads the data to be parsed.

Version: $Name: RELEASE_2_2_1 $, $Revision: 1.4 $

Author: Marc De Scheemaecker

Method Summary
boolean	atEOF() Returns true if there are no more characters left to be read.
boolean	atEOFOfCurrentStream() Returns true if the current stream has no more characters left to be read.
int	getLineNr() Returns the line number of the data in the current stream.
String	getPublicID() Returns the current public ID.
int	getStreamLevel() Returns the current "level" of the stream on the stack of streams.
String	getSystemID() Returns the current system ID.
Reader	openStream(String publicID, String systemID) Opens a stream from a public and system ID.
char	read() Reads a character.
void	setPublicID(String publicID) Sets the public ID of the current stream.
void	setSystemID(String systemID) Sets the system ID of the current stream.
void	startNewStream(Reader reader) Starts a new stream from a Java reader.
void	startNewStream(Reader reader, boolean isInternalEntity) Starts a new stream from a Java reader.
void	unread(char ch) Pushes the last character read back to the stream.

Method Detail

atEOF

public boolean atEOF()

Returns true if there are no more characters left to be read.

Throws: java.io.IOException If an I/O error occurred.

atEOFOfCurrentStream

public boolean atEOFOfCurrentStream()

Returns true if the current stream has no more characters left to be read.

Throws: java.io.IOException If an I/O error occurred.

getLineNr

public int getLineNr()

Returns the line number of the data in the current stream.

getPublicID

public String getPublicID()

Returns the current public ID.

getStreamLevel

public int getStreamLevel()

Returns the current "level" of the stream on the stack of streams.

getSystemID

public String getSystemID()

Returns the current system ID.

openStream

public Reader openStream(String publicID, String systemID)

Opens a stream from a public and system ID.

Parameters: publicID the public ID, which may be null. systemID the system ID, which is never null.

Throws: java.net.MalformedURLException If the system ID does not contain a valid URL. java.io.FileNotFoundException If the system ID refers to a local file which does not exist. java.io.IOException If an error occurred opening the stream.

read

public char read()

Reads a character.

Returns: the character

Throws: java.io.IOException If no character could be read.

setPublicID

public void setPublicID(String publicID)

Sets the public ID of the current stream.

Parameters: publicID the public ID.

setSystemID

public void setSystemID(String systemID)

Sets the system ID of the current stream.

Parameters: systemID the system ID.

Throws: java.net.MalformedURLException If the system ID does not contain a valid URL.

startNewStream

public void startNewStream(Reader reader)

Starts a new stream from a Java reader. The new stream is used temporary to read data from. If that stream is exhausted, control returns to the "parent" stream.

Parameters: reader the reader to read the new data from.

startNewStream

public void startNewStream(Reader reader, boolean isInternalEntity)

Starts a new stream from a Java reader. The new stream is used temporary to read data from. If that stream is exhausted, control returns to the parent stream.

Parameters: reader the non-null reader to read the new data from isInternalEntity true if the reader is produced by resolving an internal entity

unread

public void unread(char ch)

Pushes the last character read back to the stream.

Parameters: ch the character to push back.

Throws: java.io.IOException If an I/O error occurred.