001 /*
002 * Copyright 1999-2001 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.imageio.stream;
027
028 /**
029 * A class representing a mutable reference to an array of bytes and
030 * an offset and length within that array. <code>IIOByteBuffer</code>
031 * is used by <code>ImageInputStream</code> to supply a sequence of bytes
032 * to the caller, possibly with fewer copies than using the conventional
033 * <code>read</code> methods that take a user-supplied byte array.
034 *
035 * <p> The byte array referenced by an <code>IIOByteBuffer</code> will
036 * generally be part of an internal data structure belonging to an
037 * <code>ImageReader</code> implementation; its contents should be
038 * considered read-only and must not be modified.
039 *
040 * @version 0.5
041 */
042 public class IIOByteBuffer {
043
044 private byte[] data;
045
046 private int offset;
047
048 private int length;
049
050 /**
051 * Constructs an <code>IIOByteBuffer</code> that references a
052 * given byte array, offset, and length.
053 *
054 * @param data a byte array.
055 * @param offset an int offset within the array.
056 * @param length an int specifying the length of the data of
057 * interest within byte array, in bytes.
058 */
059 public IIOByteBuffer(byte[] data, int offset, int length) {
060 this .data = data;
061 this .offset = offset;
062 this .length = length;
063 }
064
065 /**
066 * Returns a reference to the byte array. The returned value should
067 * be treated as read-only, and only the portion specified by the
068 * values of <code>getOffset</code> and <code>getLength</code> should
069 * be used.
070 *
071 * @return a byte array reference.
072 *
073 * @see #getOffset
074 * @see #getLength
075 * @see #setData
076 */
077 public byte[] getData() {
078 return data;
079 }
080
081 /**
082 * Updates the array reference that will be returned by subsequent calls
083 * to the <code>getData</code> method.
084 *
085 * @param data a byte array reference containing the new data value.
086 *
087 * @see #getData
088 */
089 public void setData(byte[] data) {
090 this .data = data;
091 }
092
093 /**
094 * Returns the offset within the byte array returned by
095 * <code>getData</code> at which the data of interest start.
096 *
097 * @return an int offset.
098 *
099 * @see #getData
100 * @see #getLength
101 * @see #setOffset
102 */
103 public int getOffset() {
104 return offset;
105 }
106
107 /**
108 * Updates the value that will be returned by subsequent calls
109 * to the <code>getOffset</code> method.
110 *
111 * @param offset an int containing the new offset value.
112 *
113 * @see #getOffset
114 */
115 public void setOffset(int offset) {
116 this .offset = offset;
117 }
118
119 /**
120 * Returns the length of the data of interest within the byte
121 * array returned by <code>getData</code>.
122 *
123 * @return an int length.
124 *
125 * @see #getData
126 * @see #getOffset
127 * @see #setLength
128 */
129 public int getLength() {
130 return length;
131 }
132
133 /**
134 * Updates the value that will be returned by subsequent calls
135 * to the <code>getLength</code> method.
136 *
137 * @param length an int containing the new length value.
138 *
139 * @see #getLength
140 */
141 public void setLength(int length) {
142 this.length = length;
143 }
144 }
|