Package org.scijava.io.handle

Class WriteBufferDataHandle

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.plugin.AbstractTypedPlugin<D>

org.scijava.plugin.AbstractWrapperPlugin<L>

org.scijava.io.handle.AbstractDataHandle<L>

org.scijava.io.handle.AbstractHigherOrderHandle<Location>

org.scijava.io.handle.WriteBufferDataHandle

All Implemented Interfaces:

Closeable, DataInput, DataOutput, AutoCloseable, Comparable<Prioritized>, Contextual, Identifiable, DataHandle<Location>, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, TypedPlugin<Location>, WrapperPlugin<Location>, Prioritized, Typed<Location>, Versioned

public class WriteBufferDataHandle
extends AbstractHigherOrderHandle<Location>

Wraps a DataHandle and acts as a write buffer.

Author:

Gabriel Einsdorf

Nested Class Summary

Nested classes/interfaces inherited from interface org.scijava.io.handle.DataHandle

DataHandle.ByteOrder

Field Summary

Fields inherited from interface org.scijava.io.handle.DataHandle

DEFAULT_BLOCK_SIZE, MAX_SEARCH_SIZE

Constructor Summary

Constructors

Constructor	Description
WriteBufferDataHandle(DataHandle<Location> handle)	Creates a WriteBufferDataHandle that wraps the given DataHandle, the default size for the buffer is used (10000 bytes).
WriteBufferDataHandle(DataHandle<Location> handle, int bufferSize)	Creates a WriteBufferDataHandle that wraps the given DataHandle

Method Summary

Modifier and Type	Method	Description
protected void	cleanup()	Clean up data structures after a handle has been closed in the AbstractHigherOrderHandle.close() method.
protected void	ensureOpen()
boolean	isReadable()	Gets whether reading from this handle is supported.
long	length()	Returns the length of the data in bytes.
long	offset()	Returns the current offset in the stream.
int	read(byte[] b, int off, int len)	Reads up to len bytes of data from the stream into an array of bytes.
byte	readByte()
void	seek(long pos)	Sets the stream offset, measured from the beginning of the stream, at which the next read or write occurs.
void	setLength(long length)	Sets the new length of the handle.
long	skip(long n)	Skips over and discards n bytes of data from the stream.
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class org.scijava.io.handle.AbstractHigherOrderHandle

close, exists, getType, handle, isWritable

Methods inherited from class org.scijava.io.handle.AbstractDataHandle

conversionBuffer, getEncoding, getOrder, setEncoding, setOrder

Methods inherited from class org.scijava.plugin.AbstractWrapperPlugin

get, set

Methods inherited from class org.scijava.plugin.AbstractTypedPlugin

supports

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.io.handle.DataHandle

available, checksum, ensureReadable, ensureWritable, findString, findString, findString, findString, isBigEndian, isLittleEndian, lastModified, read, read, readBoolean, readChar, readCString, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readString, readString, readUnsignedByte, readUnsignedShort, readUTF, setLittleEndian, skipBytes, write, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLine, writeLong, writeShort, writeUTF

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Typed

supports

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.plugin.WrapperPlugin

get, set

Constructor Detail

WriteBufferDataHandle

public WriteBufferDataHandle(DataHandle<Location> handle)

Creates a WriteBufferDataHandle that wraps the given DataHandle, the default size for the buffer is used (10000 bytes).

Parameters:

handle - the handle to wrap

WriteBufferDataHandle

public WriteBufferDataHandle(DataHandle<Location> handle,
                             int bufferSize)

Creates a WriteBufferDataHandle that wraps the given DataHandle

Parameters:

handle - the handle to wrap

bufferSize - the size of the write buffer in bytes

Method Detail

write

public void write(int b)
           throws IOException

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Throws:

IOException

length

public long length()
            throws IOException

Description copied from interface: DataHandle

Returns the length of the data in bytes.

Specified by:

length in interface DataHandle<Location>

Overrides:

length in class AbstractHigherOrderHandle<Location>

Returns:

The length, or -1 if the length is unknown.

Throws:

IOException

setLength

public void setLength(long length)
               throws IOException

Description copied from interface: DataHandle

Sets the new length of the handle.

Parameters:

length - New length.

Throws:

IOException - If there is an error changing the handle's length.

isReadable

public boolean isReadable()

Description copied from interface: DataHandle

Gets whether reading from this handle is supported.

Specified by:

isReadable in interface DataHandle<Location>

Overrides:

isReadable in class AbstractHigherOrderHandle<Location>

ensureOpen

protected void ensureOpen()
                   throws IOException

Overrides:

ensureOpen in class AbstractHigherOrderHandle<Location>

Throws:

IOException - if this handle has been closed

offset

public long offset()
            throws IOException

Description copied from interface: DataHandle

Returns the current offset in the stream.

Throws:

IOException

seek

public void seek(long pos)
          throws IOException

Description copied from interface: DataHandle

Sets the stream offset, measured from the beginning of the stream, at which the next read or write occurs.

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Description copied from interface: DataHandle

Skips over and discards n bytes of data from the stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, no bytes are skipped.

Parameters:

n - - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

Throws:

IOException - - if an I/O error occurs.

readByte

public byte readByte()
              throws IOException

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Description copied from interface: DataHandle

Reads up to len bytes of data from the stream into an array of bytes.

Returns:

the total number of bytes read into the buffer.

Throws:

IOException

cleanup

protected void cleanup()
                throws IOException

Description copied from class: AbstractHigherOrderHandle

Clean up data structures after a handle has been closed in the AbstractHigherOrderHandle.close() method.

Specified by:

cleanup in class AbstractHigherOrderHandle<Location>

Throws:

IOException