- 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 byImageInputStream
to supply a sequence of bytes to the caller, possibly with fewer copies than using the conventionalread
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 anImageReader
implementation; its contents should be considered read-only and must not be modified.
-
-
Constructor Summary
Constructors Constructor and Description IIOByteBuffer(byte[] data, int offset, int length)
Constructs anIIOByteBuffer
that references a given byte array, offset, and length.
-
Method Summary
Methods Modifier and Type Method and 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 bygetData
.int
getOffset()
Returns the offset within the byte array returned bygetData
at which the data of interest start.void
setData(byte[] data)
Updates the array reference that will be returned by subsequent calls to thegetData
method.void
setLength(int length)
Updates the value that will be returned by subsequent calls to thegetLength
method.void
setOffset(int offset)
Updates the value that will be returned by subsequent calls to thegetOffset
method.
-
-
-
Constructor Detail
-
IIOByteBuffer
public IIOByteBuffer(byte[] data, int offset, int length)
Constructs anIIOByteBuffer
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 Detail
-
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 ofgetOffset
andgetLength
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 thegetData
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 bygetData
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 thegetOffset
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 bygetData
.- 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 thegetLength
method.- Parameters:
length
- an int containing the new length value.- See Also:
getLength()
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/imageio/stream/iiobytebuffer.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.