Module coneforest.psylla

Package coneforest.psylla.core

Class PsyInput

java.lang.Object

coneforest.psylla.core.PsyInput

All Implemented Interfaces:

PsyCloseable, PsyObject, PsyReadable, PsyReady, PsyResetable

@Type("input")
public class PsyInput
extends Object
implements PsyCloseable, PsyReadable, PsyReady, PsyResetable

The representation of input.

Field Summary

Fields inherited from interface coneforest.psylla.core.PsyCloseable

PSY_CLOSE

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

PSY_READ, 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
PsyInput(InputStream input)

Method Summary

Modifier and Type	Method	Description
InputStream	getInput()
void	psyClose()	Closes this object.
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.
void	psyReset()	Reset this resetable object.
PsyInteger	psySkip(PsyInteger oCount)	Skips characters.
int	read()
void	setInput(InputStream input)

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, psyToName, psyToString, psyType, toSyntaxString, typeName

Methods inherited from interface coneforest.psylla.core.PsyReadable

psyRead

Constructor Details

PsyInput

public PsyInput(InputStream input)

Method Details

setInput

public void setInput(InputStream input)

getInput

public InputStream getInput()

read

public int read()
         throws PsyIOErrorException

Specified by:

read in interface PsyReadable

Throws:

PsyIOErrorException

psyReadString

public PsyString psyReadString(PsyInteger oCount)
                        throws PsyUnsupportedException

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:

PsyUnsupportedException

psyReadLine

public PsyString psyReadLine()
                      throws PsyUnsupportedException

Description copied from interface: PsyReadable

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

Specified by:

psyReadLine in interface PsyReadable

Returns:

a line read.

Throws:

PsyUnsupportedException

psyClose

public void psyClose()
              throws PsyIOErrorException

Description copied from interface: PsyCloseable

Closes this object.

Specified by:

psyClose in interface PsyCloseable

Throws:

PsyIOErrorException - when I/O error occured during closing.

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.

psySkip

public PsyInteger psySkip(PsyInteger oCount)
                   throws PsyRangeCheckException,
PsyIOErrorException

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

psyReset

public void psyReset()
              throws PsyIOErrorException

Description copied from interface: PsyResetable

Reset this resetable object.

Specified by:

psyReset in interface PsyResetable

Throws:

PsyIOErrorException