Package org.scijava.io.handle

Interface StreamHandle<L extends Location>

All Superinterfaces:

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

All Known Subinterfaces:

ResettableStreamHandle<L>, SeekableStreamHandle<L>

All Known Implementing Classes:

AbstractSeekableStreamHandle, AbstractStreamHandle

public interface StreamHandle<L extends Location>
extends DataHandle<L>

A DataHandle backed by an InputStream and/or OutputStream.

Author:

Curtis Rueden, Melissa Linkert, 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

Method Summary

Modifier and Type	Method	Description
default void	advance(long bytes)	Increments the handle's offset by the given amount.
default void	close()
default void	ensureReadable(long count)	Ensures that the handle has sufficient bytes available to read.
default boolean	ensureWritable(long count)	Ensures that the handle has the correct length to be written to, and extends it as required.
InputStream	in()	Gets an input stream for reading data, positioned at the current offset.
default void	jump(long n)
OutputStream	out()	Gets an output stream for writing data, positioned at the current offset.
default int	read()	Reads the next byte of data from the stream.
default int	read(byte[] b, int off, int len)	Reads up to len bytes of data from the stream into an array of bytes.
default byte	readByte()
void	resetStream()	Resets the stream to its start.
default void	seek(long pos)	Sets the stream offset, measured from the beginning of the stream, at which the next read or write occurs.
void	setOffset(long offset)	Sets the offset of the handle to the given position.
default void	write(byte[] b, int off, int len)
default void	write(int v)
default void	writeByte(int v)

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

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

available, checksum, conversionBuffer, exists, findString, findString, findString, findString, getEncoding, getOrder, isBigEndian, isLittleEndian, isReadable, isWritable, lastModified, length, offset, read, readBoolean, readChar, readCString, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readString, readString, readUnsignedByte, readUnsignedShort, readUTF, setEncoding, setLength, setLittleEndian, setOrder, skip, skipBytes, write, writeBoolean, 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

getType, supports

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.plugin.WrapperPlugin

get, set

Method Detail

in

InputStream in()
        throws IOException

Gets an input stream for reading data, positioned at the current offset.

Returns:

the appropriate input stream, or null if the handle is write-only.

Throws:

IOException

out

OutputStream out()
          throws IOException

Gets an output stream for writing data, positioned at the current offset.

Returns:

the appropriate output stream, or null if the handle is read-only.

Throws:

IOException

setOffset

void setOffset(long offset)

Sets the offset of the handle to the given position.

This method is intended to be called only in conjunction with reading from the input stream, or writing to the output stream. Otherwise, the contents may get out of sync.

advance

default void advance(long bytes)
              throws IOException

Increments the handle's offset by the given amount.

This method is intended to be called only in conjunction with reading from the input stream, or writing to the output stream. Otherwise, the contents may get out of sync.

Throws:

IOException

seek

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

Specified by:

seek in interface DataHandle<L extends Location>

Throws:

IOException

resetStream

void resetStream()
          throws IOException

Resets the stream to its start.

Throws:

IOException - If something goes wrong with the reset

jump

default void jump(long n)
           throws IOException,
                  EOFException

Throws:

IOException

EOFException

ensureReadable

default void ensureReadable(long count)
                     throws IOException

Description copied from interface: DataHandle

Ensures that the handle has sufficient bytes available to read.

Specified by:

ensureReadable in interface DataHandle<L extends Location>

Parameters:

count - Number of bytes to read.

Throws:

EOFException - If there are insufficient bytes available.

IOException - If the handle is write-only, or something goes wrong with the check.

See Also:

DataHandle.available(long)

ensureWritable

default boolean ensureWritable(long count)
                        throws IOException

Description copied from interface: DataHandle

Ensures that the handle has the correct length to be written to, and extends it as required.

Specified by:

ensureWritable in interface DataHandle<L extends Location>

Parameters:

count - Number of bytes to write.

Returns:

true if the handle's length was sufficient, or false if the handle's length required an extension.

Throws:

IOException - If the handle is read-only, or something goes wrong with the check, or there is an error changing the handle's length.

read

default int read()
          throws IOException

Description copied from interface: DataHandle

Reads the next byte of data from the stream.

Specified by:

read in interface DataHandle<L extends Location>

Returns:

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

Throws:

IOException - - if an I/O error occurs.

readByte

default byte readByte()
               throws IOException

Specified by:

readByte in interface DataInput

Throws:

IOException

read

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

Specified by:

read in interface DataHandle<L extends Location>

Returns:

the total number of bytes read into the buffer.

Throws:

IOException

write

default void write(int v)
            throws IOException

Specified by:

write in interface DataOutput

Throws:

IOException

writeByte

default void writeByte(int v)
                throws IOException

Specified by:

writeByte in interface DataHandle<L extends Location>

Specified by:

writeByte in interface DataOutput

Throws:

IOException

write

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

Specified by:

write in interface DataOutput

Throws:

IOException

close

default void close()
            throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException