Class IIOByteBuffer

java.lang.Object

javax.imageio.stream.IIOByteBuffer

public class IIOByteBuffer
extends Object

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 Summary

Constructors

Constructor	Description
IIOByteBuffer(byte[] data, int offset, int length)	Constructs an IIOByteBuffer that references a given byte array, offset, and length.

Method Summary

Modifier and Type	Method	Description
byte[]	getData()	Returns a reference to the byte array.
int	getLength()	Returns the length of the data of interest within the byte array returned by getData.
int	getOffset()	Returns the offset within the byte array returned by getData at which the data of interest start.
void	setData(byte[] data)	Updates the array reference that will be returned by subsequent calls to the getData method.
void	setLength(int length)	Updates the value that will be returned by subsequent calls to the getLength method.
void	setOffset(int offset)	Updates the value that will be returned by subsequent calls to the getOffset method.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

IIOByteBuffer

public IIOByteBuffer(byte[] data,
 int offset,
 int 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 Details

getData

public byte[] getData()

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.

Returns:

a byte array reference.

See Also:

• getOffset()
• getLength()
• setData(byte[])

setData

public void setData(byte[] data)

Updates the array reference that will be returned by subsequent calls to the getData method.

Parameters:

data - a byte array reference containing the new data value.

See Also:

• getData()

getOffset

public int getOffset()

Returns the offset within the byte array returned by getData at which the data of interest start.

Returns:

an int offset.

See Also:

• getData()
• getLength()
• setOffset(int)

setOffset

public void setOffset(int offset)

Updates the value that will be returned by subsequent calls to the getOffset method.

Parameters:

offset - an int containing the new offset value.

See Also:

• getOffset()

getLength

public int getLength()

Returns the length of the data of interest within the byte array returned by getData.

Returns:

an int length.

See Also:

• getData()
• getOffset()
• setLength(int)

setLength

public void setLength(int length)

Updates the value that will be returned by subsequent calls to the getLength method.

Parameters:

length - an int containing the new length value.

See Also:

• getLength()