javax.imageio.stream: public class: IIOByteBuffer

javax.imageio.stream
public class: IIOByteBuffer [javadoc | source]

java.lang.Object
   javax.imageio.stream.IIOByteBuffer

A class representing a mutable reference to an array of bytes and an offset and length within that array. IIOByteBuffer is used by ImageInputStream to supply a sequence of bytes to the caller, possibly with fewer copies than using the conventional read methods that take a user-supplied byte array.

The byte array referenced by an IIOByteBuffer will generally be part of an internal data structure belonging to an ImageReader implementation; its contents should be considered read-only and must not be modified.
Constructor:

public IIOByteBuffer(byte[] data, int offset, int length)
{ this.data = data; this.offset = offset; this.length = length; }
Constructs an IIOByteBuffer that references a given byte array, offset, and length.
Parameters:
data - a byte array.
offset - an int offset within the array.
length - an int specifying the length of the data of interest within byte array, in bytes.

Method from javax.imageio.stream.IIOByteBuffer Summary:
getData, getLength, getOffset, setData, setLength, setOffset
Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Method from javax.imageio.stream.IIOByteBuffer Detail:

public byte[] getData()
{ return data; }
Returns a reference to the byte array. The returned value should be treated as read-only, and only the portion specified by the values of getOffset and getLength should be used.
public int getLength()
{ return length; }
Returns the length of the data of interest within the byte array returned by getData.
public int getOffset()
{ return offset; }
Returns the offset within the byte array returned by getData at which the data of interest start.
public void setData(byte[] data)
{ this.data = data; }
Updates the array reference that will be returned by subsequent calls to the getData method.
public void setLength(int length)
{ this.length = length; }
Updates the value that will be returned by subsequent calls to the getLength method.
public void setOffset(int offset)
{ this.offset = offset; }
Updates the value that will be returned by subsequent calls to the getOffset method.