Module coneforest.psylla

Package coneforest.psylla.core

Class PsyReader

java.lang.Object

coneforest.psylla.core.PsyReader

All Implemented Interfaces:

PsyCloseable, PsyEvaluable, PsyObject, PsyReadable, PsyReady, PsyResetable

Direct Known Subclasses:

PsyFileReader, PsyStringReader

@Type("reader")
public class PsyReader
extends Object
implements PsyCloseable, PsyEvaluable, PsyReadable, PsyResetable

The representation of reader.

Field Summary

Fields inherited from interface coneforest.psylla.core.PsyCloseable

PSY_CLOSE

Fields inherited from interface coneforest.psylla.core.PsyEvaluable

PSY_EVAL

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.PsyReadable

LINE_SEPARATOR, PSY_READ, PSY_READLINE, PSY_READSTRING, PSY_SKIP

Fields inherited from interface coneforest.psylla.core.PsyReady

PSY_READY

Fields inherited from interface coneforest.psylla.core.PsyResetable

PSY_RESET

Constructor Summary

Constructors

Constructor	Description
PsyReader(InputStream is)	Constructs a new reader object from the input stream.
PsyReader(Reader reader)	Constructs a new reader object from the reader.

Method Summary

Modifier and Type	Method	Description
void	psyClose()	Closes this object.
void	psyEval(PsyContext oContext)	Evaluate this object in the current context.
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.
void	psyReset()	Reset this resetable object.
PsyInteger	psySkip(PsyInteger oCount)	Skips characters.
int	read()	Reads a single character.
Reader	reader()	Returns the Reader object backed by this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface coneforest.psylla.core.PsyObject

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

Methods inherited from interface coneforest.psylla.core.PsyReadable

psyRead, psyReadLine

Constructor Details

PsyReader

public PsyReader(Reader reader)

Constructs a new reader object from the reader.

Parameters:

reader - the reader.

PsyReader

public PsyReader(InputStream is)

Constructs a new reader object from the input stream.

Parameters:

is - the input stream.

Method Details

psyEval

public void psyEval(PsyContext oContext)
             throws PsyErrorException

Description copied from interface: PsyEvaluable

Evaluate this object in the current context.

Specified by:

psyEval in interface PsyEvaluable

Throws:

PsyErrorException - when an error occurs durind evaluation of this object.

reader

public Reader reader()

Returns the Reader object backed by this object.

Returns:

the Reader object backed by this object

read

public int read()
         throws IOException,
IOError

Description copied from interface: PsyReadable

Reads a single character.

Specified by:

read in interface PsyReadable

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

psyReadString

public Optional<PsyString> psyReadString(PsyInteger oCount)
                                  throws PsyIOErrorException,
PsyLimitCheckException,
PsyRangeCheckException

Description copied from interface: PsyReadable

Read a string from this object and returns it.

Specified by:

psyReadString in interface PsyReadable

Parameters:

oCount - an integer representing the length of the string.

Returns:

a string read.

Throws:

PsyIOErrorException - when I/O error occurs.

PsyLimitCheckException

PsyRangeCheckException

psySkip

public PsyInteger psySkip(PsyInteger oCount)
                   throws PsyIOErrorException,
PsyRangeCheckException

Description copied from interface: PsyReadable

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

Specified by:

psySkip in interface PsyReadable

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

public PsyBoolean psyReady()
                    throws PsyIOErrorException

Description copied from interface: PsyReadable

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

Specified by:

psyReady in interface PsyReadable

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.

psyClose

public void psyClose()
              throws PsyIOErrorException

Description copied from interface: PsyCloseable

Closes this object.

Specified by:

psyClose in interface PsyCloseable

Throws:

PsyIOErrorException

psyReset

public void psyReset()
              throws PsyIOErrorException

Description copied from interface: PsyResetable

Reset this resetable object.

Specified by:

psyReset in interface PsyResetable

Throws:

PsyIOErrorException