OpenJDK 27 · javax.imageio.stream.IIOByteBuffer · APIdia, the JavaDoc alternative

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.

Modifier and Type	Field and Description
private byte[]	data
private int	length
private int	offset

Constructor Summary

Access	Constructor and Description
public	IIOByteBuffer(byte[] a byte array. data, int an int offset within the array. offset, int an int specifying the length of the data of interest within byte array, in bytes. length) Constructs an `IIOByteBuffer` that references a given byte array, offset, and length.

Method Summary

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

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

data	back to summary
private byte[] data

length	back to summary
private int length

offset	back to summary
private int offset

Constructor Detail

IIOByteBuffer back to summary

IIOByteBuffer	back to summary
public IIOByteBuffer(byte[] data, int offset, int length) Constructs an `IIOByteBuffer` that references a given byte array, offset, and length. Parameters data:byte[] a byte array. offset:int an int offset within the array. length:int an int specifying the length of the data of interest within byte array, in bytes.

public IIOByteBuffer(byte[] data, int offset, int length)

Constructs an IIOByteBuffer that references a given byte array, offset, and length.

Parameters

data:byte[]: a byte array.
offset:int: an int offset within the array.
length:int: an int specifying the length of the data of interest within byte array, in bytes.

Method Detail

getData back to summary

getData	back to summary
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:byte[] a byte array reference. See Also `getOffset`, `getLength`, `setData`

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:byte[]: a byte array reference.
See Also: getOffset, getLength, setData

getLength back to summary

getLength	back to summary
public int getLength() Returns the length of the data of interest within the byte array returned by `getData`. Returns:int an int length. See Also `getData`, `getOffset`, `setLength`

public int getLength()

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

Returns:int: an int length.
See Also: getData, getOffset, setLength

getOffset back to summary

getOffset	back to summary
public int getOffset() Returns the offset within the byte array returned by `getData` at which the data of interest start. Returns:int an int offset. See Also `getData`, `getLength`, `setOffset`

public int getOffset()

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

Returns:int: an int offset.
See Also: getData, getLength, setOffset

setData back to summary

setData	back to summary
public void setData(byte[] data) Updates the array reference that will be returned by subsequent calls to the `getData` method. Parameters data:byte[] a byte array reference containing the new data value. See Also `getData`

public void setData(byte[] data)

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

Parameters

data:byte[]: a byte array reference containing the new data value.

See Also

getData

setLength back to summary

setLength	back to summary
public void setLength(int length) Updates the value that will be returned by subsequent calls to the `getLength` method. Parameters length:int an int containing the new length value. See Also `getLength`

public void setLength(int length)

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

Parameters

length:int: an int containing the new length value.

See Also

getLength

setOffset back to summary

setOffset	back to summary
public void setOffset(int offset) Updates the value that will be returned by subsequent calls to the `getOffset` method. Parameters offset:int an int containing the new offset value. See Also `getOffset`

public void setOffset(int offset)

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

Parameters

offset:int: an int containing the new offset value.

See Also

getOffset

public Class IIOByteBuffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail