/*
* Copyright (c) 1999, 2001, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.imageio.stream;
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.
/**
* A class representing a mutable reference to an array of bytes and
* an offset and length within that array. {@code IIOByteBuffer}
* is used by {@code ImageInputStream} to supply a sequence of bytes
* to the caller, possibly with fewer copies than using the conventional
* {@code read} methods that take a user-supplied byte array.
*
* <p> The byte array referenced by an {@code IIOByteBuffer} will
* generally be part of an internal data structure belonging to an
* {@code ImageReader} implementation; its contents should be
* considered read-only and must not be modified.
*
*/
public class IIOByteBuffer {
private byte[] data;
private int offset;
private int length;
Constructs an IIOByteBuffer that references a given byte array, offset, and length. Params: - 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.
/**
* Constructs an {@code IIOByteBuffer} that references a
* given byte array, offset, and length.
*
* @param data a byte array.
* @param offset an int offset within the array.
* @param length an int specifying the length of the data of
* interest within byte array, in bytes.
*/
public IIOByteBuffer(byte[] data, int offset, int length) {
this.data = data;
this.offset = offset;
this.length = length;
}
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. See Also: Returns: a byte array reference.
/**
* 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 {@code getOffset} and {@code getLength} should
* be used.
*
* @return a byte array reference.
*
* @see #getOffset
* @see #getLength
* @see #setData
*/
public byte[] getData() {
return data;
}
Updates the array reference that will be returned by subsequent calls to the getData method. Params: - data – a byte array reference containing the new data value.
See Also:
/**
* Updates the array reference that will be returned by subsequent calls
* to the {@code getData} method.
*
* @param data a byte array reference containing the new data value.
*
* @see #getData
*/
public void setData(byte[] data) {
this.data = data;
}
Returns the offset within the byte array returned by getData at which the data of interest start. See Also: Returns: an int offset.
/**
* Returns the offset within the byte array returned by
* {@code getData} at which the data of interest start.
*
* @return an int offset.
*
* @see #getData
* @see #getLength
* @see #setOffset
*/
public int getOffset() {
return offset;
}
Updates the value that will be returned by subsequent calls to the getOffset method. Params: - offset – an int containing the new offset value.
See Also:
/**
* Updates the value that will be returned by subsequent calls
* to the {@code getOffset} method.
*
* @param offset an int containing the new offset value.
*
* @see #getOffset
*/
public void setOffset(int offset) {
this.offset = offset;
}
Returns the length of the data of interest within the byte array returned by getData. See Also: Returns: an int length.
/**
* Returns the length of the data of interest within the byte
* array returned by {@code getData}.
*
* @return an int length.
*
* @see #getData
* @see #getOffset
* @see #setLength
*/
public int getLength() {
return length;
}
Updates the value that will be returned by subsequent calls to the getLength method. Params: - length – an int containing the new length value.
See Also:
/**
* Updates the value that will be returned by subsequent calls
* to the {@code getLength} method.
*
* @param length an int containing the new length value.
*
* @see #getLength
*/
public void setLength(int length) {
this.length = length;
}
}