org.columba.ristretto.io

Interface Source

All Superinterfaces:

java.lang.CharSequence

All Known Implementing Classes:

ByteBufferSource, CharSequenceSource

public interface Source
extends java.lang.CharSequence

Interface definition of Sources. These are the basic data units that the parsers of Ristretto work on.

Author:

tstich

Method Summary

Modifier and Type	Method and Description
void	close() Closes the source.
void	deepClose() Does a deep close of all sources and subsources associated with this source.
Source	fromActualPosition() Creates a sub source starting from the actual position.
int	getPosition() Get the actual read position of the source.
boolean	isEOF() Checks if the end of the Source is reached.
char	next() Returns the character at the given position and increases the position.
void	seek(int position) Seek to the given position
Source	subSource(int start, int end) Creates a sub source of this source.

Methods inherited from interface java.lang.CharSequence

charAt, chars, codePoints, length, subSequence, toString

Method Detail

subSource

Source subSource(int start,
                 int end)

Creates a sub source of this source.

Parameters:

start - the start position

end - the end position

Returns:

the subsource

fromActualPosition

Source fromActualPosition()

Creates a sub source starting from the actual position.

Returns:

the subsource

getPosition

int getPosition()

Get the actual read position of the source.

Returns:

the actual read position

seek

void seek(int position)
   throws java.io.IOException

Seek to the given position

Parameters:

position -

Throws:

java.io.IOException

next

char next()
   throws java.io.IOException

Returns the character at the given position and increases the position.

Returns:

the character at the actual position

Throws:

java.io.IOException

isEOF

boolean isEOF()

Checks if the end of the Source is reached.

Returns:

true if the end of the source is reached

close

void close()
    throws java.io.IOException

Closes the source.

Throws:

java.io.IOException

deepClose

void deepClose()
        throws java.io.IOException

Does a deep close of all sources and subsources associated with this source.

Throws:

java.io.IOException