Package coneforest.psylla.core

Interface PsyReadable

All Superinterfaces:

PsyConvertableToName, PsyConvertableToString, PsyObject, PsyReady

All Known Implementing Classes:

PsyFileReader, PsyInput, PsyReader, PsyStringReader

public interface PsyReadable
extends PsyReady

A representation of readable, an object that can be treated as a source of characters to read from.

Field Summary

Fields

Modifier and Type	Field	Description
static PsyOperator[]	OPERATORS

Method Summary

Modifier and Type	Method	Description
default PsyInteger	psyRead()	Read an integer character from this object and returns it.
PsyString	psyReadLine()	Read a line (string) from this object and returns it.
PsyString	psyReadString(PsyInteger oCount)	Read a string from this object and returns it.
PsyBoolean	psyReady()	Returns a boolean object indicating whether this object is ready to be read.
PsyInteger	psySkip(PsyInteger oCount)	Skips characters.
int	read()

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyClone, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToName, psyToString, psyType, toSyntaxString, typeName

Field Detail

OPERATORS

static final PsyOperator[] OPERATORS

Method Detail

read

int read()
  throws PsyErrorException

Throws:

PsyErrorException

psyRead

default PsyInteger psyRead()
                    throws PsyErrorException

Read an integer character from this object and returns it. Returns PsyInteger.MINUS_ONE when end of input has been reached.

Returns:

an integer representing the character read from this object.

Throws:

PsyErrorException - when error occurs.

psyReadString

PsyString psyReadString(PsyInteger oCount)
                 throws PsyErrorException

Read a string from this object and returns it.

Parameters:

oCount - an integer representing the length of the string.

Returns:

a string read.

Throws:

PsyErrorException - when error occurs.

psyReadLine

PsyString psyReadLine()
               throws PsyErrorException

Read a line (string) from this object and returns it.

Returns:

a line read,

Throws:

PsyErrorException - when error occurs.

psySkip

PsyInteger psySkip(PsyInteger oCount)
            throws PsyErrorException

Skips characters. This method will block until some characters are available, an I/O error occurs, or end of input is reached.

Parameters:

oCount - an integer representing the number of characters to be skipped.

Returns:

an integer representing the number of characters actually skipped.

Throws:

PsyErrorException - when an error occurs.

psyReady

PsyBoolean psyReady()
             throws PsyIOErrorException

Returns a boolean object indicating whether this object is ready to be read.

Specified by:

psyReady in interface PsyReady

Returns:

true if this object is ready to be read, and false otherwise.

Throws:

PsyIOErrorException - when I/O error occurs.