Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyReadable

All Superinterfaces:

PsyObject, PsyReady

All Known Implementing Classes:

PsyFileReader, PsyInput, PsyReader, PsyStringReader

@Type("readable")
public interface PsyReadable
extends PsyReady

The 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 final ContextAction	PSY_READ	Context action of the read operator.
static final ContextAction	PSY_SKIP	Context action of the skip operator.

Fields inherited from interface coneforest.psylla.core.PsyObject

PSY_CLONE, PSY_EQ, PSY_HASHCODE, PSY_INSTANCEOF, PSY_NE, PSY_TONAME, PSY_TOSTRING, PSY_TYPE

Fields inherited from interface coneforest.psylla.core.PsyReady

PSY_READY

Method Summary

Modifier and Type	Method	Description
default Optional<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 Details

PSY_SKIP

@OperatorType("skip")
static final ContextAction PSY_SKIP

Context action of the skip operator.

PSY_READ

@OperatorType("read")
static final ContextAction PSY_READ

Context action of the read operator.

Method Details

read

int read()
  throws PsyIOErrorException

Throws:

PsyIOErrorException

psyRead

default Optional<PsyInteger> psyRead()
                              throws PsyIOErrorException

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

Returns:

an integer representing the character read from this object.

Throws:

PsyIOErrorException - when I/O error occurs.

psyReadString

PsyString psyReadString(PsyInteger oCount)
                 throws PsyIOErrorException,
PsyLimitCheckException,
PsyRangeCheckException,
PsyUnsupportedException

Read a string from this object and returns it.

Parameters:

oCount - an integer representing the length of the string.

Returns:

a string read.

Throws:

PsyIOErrorException - when I/O error occurs.

PsyLimitCheckException

PsyRangeCheckException

PsyUnsupportedException

psyReadLine

PsyString psyReadLine()
               throws PsyIOErrorException,
PsyUnsupportedException

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

Returns:

a line read.

Throws:

PsyIOErrorException - when I/O error occurs.

PsyUnsupportedException

psySkip

PsyInteger psySkip(PsyInteger oCount)
            throws PsyIOErrorException,
PsyRangeCheckException

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:

PsyIOErrorException - when I/O error occurs.

PsyRangeCheckException

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.