Package org.scijava.io.handle

Class BytesHandle

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<BytesLocation>

org.scijava.io.handle.BytesHandle

All Implemented Interfaces:

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

public class BytesHandle
extends AbstractDataHandle<BytesLocation>

DataHandle for a BytesLocation.

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

Constructor Summary

Constructors

Constructor	Description
BytesHandle()
BytesHandle(BytesLocation location)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	exists()	Tests whether this handle's location actually exists at the source.
Class<BytesLocation>	getType()	Gets the type associated with the object.
boolean	isReadable()	Gets whether reading from this handle is supported.
boolean	isWritable()	Gets whether writing to 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	readFully(byte[] b, int off, int len)
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.
void	write(byte[] b, int off, int len)
void	write(int b)

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, readInt, readLine, readLong, readShort, readString, readString, readUnsignedByte, readUnsignedShort, readUTF, setLittleEndian, skip, 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

BytesHandle

public BytesHandle()

BytesHandle

public BytesHandle(BytesLocation location)

Method Detail

isReadable

public boolean isReadable()

Description copied from interface: DataHandle

Gets whether reading from this handle is supported.

isWritable

public boolean isWritable()

Description copied from interface: DataHandle

Gets whether writing to this handle is supported.

exists

public boolean exists()

Description copied from interface: DataHandle

Tests whether this handle's location actually exists at the source.

Returns:

True if the location exists; false if not.

offset

public long offset()

Description copied from interface: DataHandle

Returns the current offset in the stream.

length

public long length()

Description copied from interface: DataHandle

Returns the length of the data in bytes.

Returns:

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

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.

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

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

readByte

public byte readByte()
              throws IOException

Throws:

IOException

readFully

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

Throws:

IOException

write

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

Throws:

IOException

write

public void write(int b)
           throws IOException

Throws:

IOException

close

public void close()

getType

public Class<BytesLocation> getType()

Description copied from interface: Typed

Gets the type associated with the object.