totalcross.io

Class RandomAccessStream

java.lang.Object

totalcross.io.Stream

totalcross.io.RandomAccessStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

ByteArrayStream, File, File4D

public abstract class RandomAccessStream
extends Stream

Represents a stream that behaves like a large array of bytes and may be randomly accessed.

Since:

TotalCross 1.01

Field Summary

Fields

Modifier and Type	Field and Description
protected int	pos The index of the next position to read or write in the stream
static int	SEEK_CUR Current position of the file pointer
static int	SEEK_END End of file
static int	SEEK_SET Beginning of file

Fields inherited from class totalcross.io.Stream

skipBuffer

Constructor Summary

Constructors

Constructor and Description
RandomAccessStream()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes this I/O connection, releasing any associated resources.
int	getPos() Returns the current offset in this stream.
abstract void	setPos(int pos) Sets the file pointer for read and write operations to the given position.
abstract void	setPos(int offset, int origin) Sets the file pointer for read and write operations to a new position defined by adding offset to a reference position specified by origin.

Methods inherited from class totalcross.io.Stream

asInputStream, asOutputStream, asStream, asStream, readBytes, skipBytes, wrapInputStream, wrapInputStreamToStream, write, writeBytes, writeBytes, writeBytes, writeBytes

Methods inherited from class java.lang.Object

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

Field Detail

pos

protected int pos

The index of the next position to read or write in the stream

SEEK_SET

public static final int SEEK_SET

Beginning of file

See Also:

Constant Field Values

SEEK_CUR

public static final int SEEK_CUR

Current position of the file pointer

See Also:

Constant Field Values

SEEK_END

public static final int SEEK_END

End of file

See Also:

Constant Field Values

Constructor Detail

RandomAccessStream

public RandomAccessStream()

Method Detail

getPos

public int getPos()
           throws IOException

Returns the current offset in this stream.

Returns:

the offset from the beginning of the stream, in bytes, at which the next read or write occurs.

Throws:

IOException - if an I/O error has occurred.

Since:

TotalCross 1.2

setPos

public abstract void setPos(int offset,
                            int origin)
                     throws IOException

Sets the file pointer for read and write operations to a new position defined by adding offset to a reference position specified by origin.

Parameters:

offset - number of bytes to offset from origin.

origin - position from where offset is added. It is specified by one of the SEEK_* constants.

Throws:

java.lang.IllegalArgumentException - if origin is not one of the values specified by the SEEK_* constants.

IOException - if the new position is negative or if an I/O error occurs.

Since:

TotalCross 1.2

setPos

public abstract void setPos(int pos)
                     throws IOException

Sets the file pointer for read and write operations to the given position. The position passed is an absolute position, in bytes, from the beginning of the stream.

Parameters:

pos - the offset position, measured in bytes from the beginning of the file, at which to set the file pointer.

Throws:

IOException - if pos is negative or if an I/O error occurs.

close

public abstract void close()
                    throws IOException

Closes this I/O connection, releasing any associated resources. Once closed a connection is no longer valid.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

IOException - If an I/O error occurs.