com.canto.cumulus

Class InputDataStream

java.lang.Object

java.io.InputStream

com.canto.cumulus.InputDataStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class InputDataStream
extends java.io.InputStream
implements java.lang.AutoCloseable

The InputDataStream object allows you to read bytes from a data stream.

See Also:

Asset.openInputDataStream(), Asset.openInputRsrcStream()

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Returns the number of bytes that can be read (or skipped over) from the current position.
void	close() Closes this input stream and releases any system resources associated with the stream.
CumulusSession	getCumulusSession() Returns the current CumulusSession object.
long	getPos() Returns the current position in this input stream.
long	getSize() Returns the number of bytes that can be read from this input stream.
void	movePos(long delta) Sets the current position in this input stream relative to the current position.
int	read() Reads the next byte of data from the input stream.
int	read(byte[] data, int off, int len) Reads up to len bytes of data into an array of bytes from this input stream.
void	setPos(long pos) Sets the current position in this input stream.
long	skip(long bytesToSkip) Skips bytesToSkip bytes of input from this input stream.

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset

Methods inherited from class java.lang.Object

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

Method Detail

getCumulusSession

public CumulusSession getCumulusSession()

Returns the current CumulusSession object.

Returns:

the current CumulusSession object

read

public int read()

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Specified by:

read in class java.io.InputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached.

read

public int read(byte[] data,
       int off,
       int len)

Reads up to len bytes of data into an array of bytes from this input stream. If pos equals count, then -1 is returned to indicate end of file. Otherwise, the number k of bytes read is equal to the smaller of len and count-pos.

Overrides:

read in class java.io.InputStream

Parameters:

data - the buffer into which the data is read.

off - the start offset in array data at which the data is written.

len - the maximum number of bytes to read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

skip

public long skip(long bytesToSkip)

Skips bytesToSkip bytes of input from this input stream. Fewer bytes might be skipped if the end of the input stream is reached. The actual number k of bytes to be skipped is equal to the smaller of bytesToSkip and count-pos. The value k is added into pos and k is returned.

Overrides:

skip in class java.io.InputStream

Returns:

the actual number of bytes skipped.

available

public int available()

Returns the number of bytes that can be read (or skipped over) from the current position.

Overrides:

available in class java.io.InputStream

Returns:

the number of bytes that can be read from this input stream without blocking.

close

public void close()

Closes this input stream and releases any system resources associated with the stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

getSize

public long getSize()

Returns the number of bytes that can be read from this input stream.

Returns:

the number of bytes that can be read from this input stream.

getPos

public long getPos()

Returns the current position in this input stream.

Returns:

the current position in this input stream.

setPos

public void setPos(long pos)

Sets the current position in this input stream.

Parameters:

pos - the new position relative to the beginning of the stream.

movePos

public void movePos(long delta)

Sets the current position in this input stream relative to the current position.

Parameters:

delta - the new position relative to the current position.