DataBufferByte.java revision 290
286N/A * Portions Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved. 286N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 286N/A * This code is free software; you can redistribute it and/or modify it 286N/A * under the terms of the GNU General Public License version 2 only, as 286N/A * published by the Free Software Foundation. Sun designates this 286N/A * particular file as subject to the "Classpath" exception as provided 286N/A * by Sun in the LICENSE file that accompanied this code. 286N/A * This code is distributed in the hope that it will be useful, but WITHOUT 286N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 286N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 286N/A * version 2 for more details (a copy is included in the LICENSE file that 286N/A * accompanied this code). 286N/A * You should have received a copy of the GNU General Public License version 286N/A * 2 along with this work; if not, write to the Free Software Foundation, 286N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 286N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 286N/A * CA 95054 USA or visit www.sun.com if you need additional information or 286N/A/* **************************************************************** 286N/A ****************************************************************** 286N/A ****************************************************************** 286N/A *** COPYRIGHT (c) Eastman Kodak Company, 1997 286N/A *** As an unpublished work pursuant to Title 17 of the United 286N/A *** States Code. All rights reserved. 286N/A ****************************************************************** 286N/A ****************************************************************** 286N/A ******************************************************************/ 286N/A * This class extends <CODE>DataBuffer</CODE> and stores data internally as bytes. 286N/A * Values stored in the byte array(s) of this <CODE>DataBuffer</CODE> are treated as 286N/A * <a name="optimizations"> 286N/A * Note that some implementations may function more efficiently 286N/A * if they can maintain control over how the data for an image is 286N/A * For example, optimizations such as caching an image in video * memory require that the implementation track all modifications * Other implementations may operate better if they can store the * data in locations other than a Java array. * To maintain optimum compatibility with various optimizations * it is best to avoid constructors and methods which expose the * underlying storage as a Java array, as noted below in the * documentation for those methods. /** The default data bank. */ * Constructs a byte-based <CODE>DataBuffer</CODE> with a single bank and the * @param size The size of the <CODE>DataBuffer</CODE>. * Constructs a byte based <CODE>DataBuffer</CODE> with the specified number of * banks all of which are the specified size. * @param size The size of the banks in the <CODE>DataBuffer</CODE>. * @param numBanks The number of banks in the a<CODE>DataBuffer</CODE>. * Constructs a byte-based <CODE>DataBuffer</CODE> with a single bank using the * Only the first <CODE>size</CODE> elements should be used by accessors of * this <CODE>DataBuffer</CODE>. <CODE>dataArray</CODE> must be large enough to * hold <CODE>size</CODE> elements. * Note that {@code DataBuffer} objects created by this constructor * may be incompatible with <a href="#optimizations">performance * optimizations</a> used by some implementations (such as caching * an associated image in video memory). * @param dataArray The byte array for the <CODE>DataBuffer</CODE>. * @param size The size of the <CODE>DataBuffer</CODE> bank. * Constructs a byte-based <CODE>DataBuffer</CODE> with a single bank using the * specified array, size, and offset. <CODE>dataArray</CODE> must have at least * <CODE>offset</CODE> + <CODE>size</CODE> elements. Only elements <CODE>offset</CODE> * through <CODE>offset</CODE> + <CODE>size</CODE> - 1 * should be used by accessors of this <CODE>DataBuffer</CODE>. * Note that {@code DataBuffer} objects created by this constructor * may be incompatible with <a href="#optimizations">performance * optimizations</a> used by some implementations (such as caching * an associated image in video memory). * @param dataArray The byte array for the <CODE>DataBuffer</CODE>. * @param size The size of the <CODE>DataBuffer</CODE> bank. * @param offset The offset into the <CODE>dataArray</CODE>. <CODE>dataArray</CODE> * must have at least <CODE>offset</CODE> + <CODE>size</CODE> elements. * Constructs a byte-based <CODE>DataBuffer</CODE> with the specified arrays. * The number of banks is equal to <CODE>dataArray.length</CODE>. * Only the first <CODE>size</CODE> elements of each array should be used by * accessors of this <CODE>DataBuffer</CODE>. * Note that {@code DataBuffer} objects created by this constructor * may be incompatible with <a href="#optimizations">performance * optimizations</a> used by some implementations (such as caching * an associated image in video memory). * @param dataArray The byte arrays for the <CODE>DataBuffer</CODE>. * @param size The size of the banks in the <CODE>DataBuffer</CODE>. * Constructs a byte-based <CODE>DataBuffer</CODE> with the specified arrays, size, * The number of banks is equal to <CODE>dataArray.length</CODE>. Each array must * be at least as large as <CODE>size</CODE> + the corresponding <CODE>offset</CODE>. * There must be an entry in the <CODE>offset</CODE> array for each <CODE>dataArray</CODE> * entry. For each bank, only elements <CODE>offset</CODE> through * <CODE>offset</CODE> + <CODE>size</CODE> - 1 should be used by accessors of this * <CODE>DataBuffer</CODE>. * Note that {@code DataBuffer} objects created by this constructor * may be incompatible with <a href="#optimizations">performance * optimizations</a> used by some implementations (such as caching * an associated image in video memory). * @param dataArray The byte arrays for the <CODE>DataBuffer</CODE>. * @param size The size of the banks in the <CODE>DataBuffer</CODE>. * @param offsets The offsets into each array. * Returns the default (first) byte data array. * Note that calling this method may cause this {@code DataBuffer} * object to be incompatible with <a href="#optimizations">performance * optimizations</a> used by some implementations (such as caching * an associated image in video memory). * @return The first byte data array. * Returns the data array for the specified bank. * Note that calling this method may cause this {@code DataBuffer} * object to be incompatible with <a href="#optimizations">performance * optimizations</a> used by some implementations (such as caching * an associated image in video memory). * @param bank The bank whose data array you want to get. * @return The data array for the specified bank. * Returns the data arrays for all banks. * Note that calling this method may cause this {@code DataBuffer} * object to be incompatible with <a href="#optimizations">performance * optimizations</a> used by some implementations (such as caching * an associated image in video memory). * @return All of the data arrays. * Returns the requested data array element from the first (default) bank. * @param i The data array element you want to get. * @return The requested data array element as an integer. * @see #setElem(int, int) * @see #setElem(int, int, int) * Returns the requested data array element from the specified bank. * @param bank The bank from which you want to get a data array element. * @param i The data array element you want to get. * @return The requested data array element as an integer. * @see #setElem(int, int) * @see #setElem(int, int, int) * Sets the requested data array element in the first (default) bank * to the specified value. * @param i The data array element you want to set. * @param val The integer value to which you want to set the data array element. * @see #getElem(int, int) * Sets the requested data array element in the specified bank * from the given integer. * @param bank The bank in which you want to set the data array element. * @param i The data array element you want to set. * @param val The integer value to which you want to set the specified data array element. * @see #getElem(int, int)