Module com.maroontress.clione

Package com.maroontress.clione.impl

Class Eof

java.lang.Object

com.maroontress.clione.impl.Eof

All Implemented Interfaces:

SourceChar

public abstract class Eof
extends Object
implements SourceChar

Represents the abstract EOF.

Field Summary

Fields inherited from interface com.maroontress.clione.SourceChar

EMPTY_LIST, STATIC_EOF

Constructor Summary

Constructors

Constructor	Description
Eof()

Method Summary

Modifier and Type	Method	Description
abstract List<SourceChar>	getChildren()	Returns the child characters.
abstract SourceSpan	getSpan()	Returns location of this object in the source file.
final boolean	isEof()	Returns whether this object represents EOF.
final char	toChar()	Returns a char value corresponding to this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Eof

public Eof()

Method Details

isEof

public final boolean isEof()

Returns whether this object represents EOF.

Specified by:

isEof in interface SourceChar

Returns:

true if this represents EOF.

toChar

public final char toChar()

Returns a char value corresponding to this object.

This method throws an IllegalStateException if this object represents EOF.

Specified by:

toChar in interface SourceChar

Returns:

The char value.

getSpan

public abstract SourceSpan getSpan()

Returns location of this object in the source file.

If this object has its child characters, its location depends on their location. So, its location may represent a range of the characters.

This method throws an IllegalStateException if this object represents EOF.

Specified by:

getSpan in interface SourceChar

Returns:

The location.

getChildren

public abstract List<SourceChar> getChildren()

Returns the child characters.

Specified by:

getChildren in interface SourceChar

Returns:

The unmodifiable list containing the child characters, or SourceChar.EMPTY_LIST if this object has no child characters.