com.terracottatech.offheapstore.filesystem

Class SeekableOutputStream

java.lang.Object

java.io.OutputStream

com.terracottatech.offheapstore.filesystem.SeekableOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

OffheapOutputStream

public abstract class SeekableOutputStream
extends OutputStream

This interface provides for writing bytes to an OffHeap file. For all the methods in this interface that write bytes, it is generally true that if a byte cannot be written for any reason, an IOException is thrown.

Author:

dkumar

Constructor Summary

Constructors

Constructor and Description
SeekableOutputStream()

Method Summary

Modifier and Type	Method and Description
abstract long	getFilePointer() Returns the current offset in this file.
abstract long	length() Returns the length of the stream.
abstract void	reset() Clears the stream.
abstract void	seek(long pos) Sets the file-pointer offset, measured from the beginning of this file, at which the next write occurs.
abstract void	write(int b)

Methods inherited from class java.io.OutputStream

close, flush, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

SeekableOutputStream

public SeekableOutputStream()

Method Detail

write

public abstract void write(int b)
                    throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

getFilePointer

public abstract long getFilePointer()
                             throws IOException

Returns the current offset in this file.

Returns:

the offset from the beginning of the file, in bytes, at which the next read occurs.

Throws:

IOException - if an I/O error occurs.

seek

public abstract void seek(long pos)
                   throws IOException

Sets the file-pointer offset, measured from the beginning of this file, at which the next write occurs. The offset may be set beyond the end of the file. Setting the offset beyond the end of the file does not change the file length. The file length will change only by writing after the offset has been set beyond the end of the file.

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 less than 0 or if an I/O error occurs.

reset

public abstract void reset()
                    throws IOException

Clears the stream. Calling flush after a reset will clear the contents of the file.

Throws:

IOException

length

public abstract long length()
                     throws IOException

Returns the length of the stream. This method flushes the buffers to the file before calculating the length.

Returns:

length of the stream in bytes

Throws:

IOException