Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyReadable

All Superinterfaces:

PsyObject, PsyReady

All Known Implementing Classes:

PsyFileInput, 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 String	LINE_SEPARATOR	Line separator string.
static final ContextAction	PSY_READ	Context action of the read operator.
static final ContextAction	PSY_READLINE	Context action of the readline operator.
static final ContextAction	PSY_READSTRING	Context action of the readstring 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_TOSTRING, PSY_TOSTRINGBUFFER, 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.
default Optional<PsyString>	psyReadLine()	Read a line (string) from this object and returns it.
Optional<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()	Reads a single character.

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyClone, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToString, psyToStringBuffer, 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.

PSY_READLINE

@OperatorType("readline")
static final ContextAction PSY_READLINE

Context action of the readline operator.

PSY_READSTRING

@OperatorType("readstring")
static final ContextAction PSY_READSTRING

Context action of the readstring operator.

LINE_SEPARATOR

static final String LINE_SEPARATOR

Line separator string.

Method Details

read

int read()
  throws IOException,
IOError

Reads a single character.

Returns:

the character read, as an integer in the range 0 to 65535 (0x00–0xFFFF), or -1 if the end of the source has been reached.

Throws:

IOException - when an I/O error occurs.

IOError

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 an I/O error occurs.

psyReadString

Optional<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

default Optional<PsyString> psyReadLine()
                                 throws PsyIOErrorException

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

Returns:

a line read.

Throws:

PsyIOErrorException - when I/O error occurs.

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.