Module com.maroontress.clione

Package com.maroontress.clione.impl

Interface Source

All Known Implementing Classes:

PhaseOneSource, PhaseTwoSource, ReaderSource

public interface Source

Provides the stream of the source file.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this source and its upstream Source or Reader.
SourceChar	getChar()	Returns a new SourceChar object at the current location of this source or EOF.
SourceLocation	getLocation()	Returns the current location of this source.
void	ungetChar(SourceChar c)	Pushes back the specified SourceChar object.

Method Details

close

void close()
    throws IOException

Closes this source and its upstream Source or Reader.

Throws:

IOException - If an I/O error occurs.

getLocation

SourceLocation getLocation()

Returns the current location of this source.

Returns:

The current location.

getChar

SourceChar getChar()
            throws IOException

Returns a new SourceChar object at the current location of this source or EOF.

This method does not change the current location either if the return value represents EOF or is the object that has been pushed back. Otherwise, the current location proceeds the next one.

This method may read two or more characters from the upstream Source or Reader. It may also replace one or more SourceChar objects with another SourceChar object and return it.

The return value representing EOF may differ from SourceChar.STATIC_EOF. Do not compare it with SourceChar.STATIC_EOF, use SourceChar.isEof() method instead.

Returns:

The new SourceChar object.

Throws:

IOException - If an I/O error occurs.

See Also:

• SourceChar.isEof()

ungetChar

void ungetChar(SourceChar c)

Pushes back the specified SourceChar object.

The SourceChar object to push back must not represent EOF.

This method does not change the current location.

Parameters:

c - The SourceChar object to push back.

Throws:

IllegalArgumentException - If the object represents EOF.