DataBuffer and stores data internally as
* shorts. Values stored in the short array(s) of this DataBuffer
* are treated as unsigned values.
*
*
* Note that some implementations may function more efficiently
* if they can maintain control over how the data for an image is
* stored.
* For example, optimizations such as caching an image in video
* memory require that the implementation track all modifications
* to that data.
* 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.
*
*/
public final class DataBufferUShort extends DataBuffer
{
/** The default data bank. */
short data[];
/** All data banks */
short bankdata[][];
/**
* Constructs an unsigned-short based DataBuffer with a single bank and the
* specified size.
*
* @param size The size of the DataBuffer.
*/
public DataBufferUShort(int size) {
super(STABLE, TYPE_USHORT, size);
data = new short[size];
bankdata = new short[1][];
bankdata[0] = data;
}
/**
* Constructs an unsigned-short based DataBuffer with the specified number of
* banks, all of which are the specified size.
*
* @param size The size of the banks in the DataBuffer.
* @param numBanks The number of banks in the aDataBuffer.
*/
public DataBufferUShort(int size, int numBanks) {
super(STABLE, TYPE_USHORT, size, numBanks);
bankdata = new short[numBanks][];
for (int i= 0; i < numBanks; i++) {
bankdata[i] = new short[size];
}
data = bankdata[0];
}
/**
* Constructs an unsigned-short based DataBuffer with a single bank
* using the specified array.
* Only the first size elements should be used by accessors of
* this DataBuffer. dataArray must be large enough to
* hold size elements.
*
* Note that {@code DataBuffer} objects created by this constructor
* may be incompatible with performance
* optimizations used by some implementations (such as caching
* an associated image in video memory).
*
* @param dataArray The unsigned-short array for the DataBuffer.
* @param size The size of the DataBuffer bank.
*/
public DataBufferUShort(short dataArray[], int size) {
super(UNTRACKABLE, TYPE_USHORT, size);
if (dataArray == null) {
throw new NullPointerException("dataArray is null");
}
data = dataArray;
bankdata = new short[1][];
bankdata[0] = data;
}
/**
* Constructs an unsigned-short based DataBuffer with a single bank
* using the specified array, size, and offset. dataArray must have at
* least offset + size elements. Only elements
* offset through offset + size - 1 should
* be used by accessors of this DataBuffer.
*
* Note that {@code DataBuffer} objects created by this constructor
* may be incompatible with performance
* optimizations used by some implementations (such as caching
* an associated image in video memory).
*
* @param dataArray The unsigned-short array for the DataBuffer.
* @param size The size of the DataBuffer bank.
* @param offset The offset into the dataArray.
*/
public DataBufferUShort(short dataArray[], int size, int offset) {
super(UNTRACKABLE, TYPE_USHORT, size, 1, offset);
if (dataArray == null) {
throw new NullPointerException("dataArray is null");
}
if ((size+offset) > dataArray.length) {
throw new IllegalArgumentException("Length of dataArray is less "+
" than size+offset.");
}
data = dataArray;
bankdata = new short[1][];
bankdata[0] = data;
}
/**
* Constructs an unsigned-short based DataBuffer with the specified arrays.
* The number of banks will be equal to dataArray.length.
* Only the first size elements of each array should be used by
* accessors of this DataBuffer.
*
* Note that {@code DataBuffer} objects created by this constructor
* may be incompatible with performance
* optimizations used by some implementations (such as caching
* an associated image in video memory).
*
* @param dataArray The unsigned-short arrays for the DataBuffer.
* @param size The size of the banks in the DataBuffer.
*/
public DataBufferUShort(short dataArray[][], int size) {
super(UNTRACKABLE, TYPE_USHORT, size, dataArray.length);
if (dataArray == null) {
throw new NullPointerException("dataArray is null");
}
for (int i=0; i < dataArray.length; i++) {
if (dataArray[i] == null) {
throw new NullPointerException("dataArray["+i+"] is null");
}
}
bankdata = dataArray.clone();
data = bankdata[0];
}
/**
* Constructs an unsigned-short based DataBuffer with specified arrays,
* size, and offsets.
* The number of banks is equal to dataArray.length. Each array must
* be at least as large as size + the corresponding offset. There must
* be an entry in the offset array for each dataArray entry. For each
* bank, only elements offset through
* offset + size - 1 should be
* used by accessors of this DataBuffer.
*
* Note that {@code DataBuffer} objects created by this constructor
* may be incompatible with performance
* optimizations used by some implementations (such as caching
* an associated image in video memory).
*
* @param dataArray The unsigned-short arrays for the DataBuffer.
* @param size The size of the banks in the DataBuffer.
* @param offsets The offsets into each array.
*/
public DataBufferUShort(short dataArray[][], int size, int offsets[]) {
super(UNTRACKABLE, TYPE_USHORT, size, dataArray.length, offsets);
if (dataArray == null) {
throw new NullPointerException("dataArray is null");
}
for (int i=0; i < dataArray.length; i++) {
if (dataArray[i] == null) {
throw new NullPointerException("dataArray["+i+"] is null");
}
if ((size+offsets[i]) > dataArray[i].length) {
throw new IllegalArgumentException("Length of dataArray["+i+
"] is less than size+"+
"offsets["+i+"].");
}
}
bankdata = dataArray.clone();
data = bankdata[0];
}
/**
* Returns the default (first) unsigned-short data array.
*
* Note that calling this method may cause this {@code DataBuffer} * object to be incompatible with performance * optimizations used by some implementations (such as caching * an associated image in video memory). * * @return The first unsigned-short data array. */ public short[] getData() { theTrackable.setUntrackable(); return data; } /** * Returns the data array for the specified bank. *
* Note that calling this method may cause this {@code DataBuffer} * object to be incompatible with performance * optimizations 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. */ public short[] getData(int bank) { theTrackable.setUntrackable(); return bankdata[bank]; } /** * Returns the data arrays for all banks. *
* Note that calling this method may cause this {@code DataBuffer} * object to be incompatible with performance * optimizations used by some implementations (such as caching * an associated image in video memory). * * @return All of the data arrays. */ public short[][] getBankData() { theTrackable.setUntrackable(); return bankdata.clone(); } /** * 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) */ public int getElem(int i) { return data[i+offset]&0xffff; } /** * 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) */ public int getElem(int bank, int i) { return bankdata[bank][i+offsets[bank]]&0xffff; } /** * 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) * @see #getElem(int, int) */ public void setElem(int i, int val) { data[i+offset] = (short)(val&0xffff); theTrackable.markDirty(); } /** * 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) * @see #getElem(int, int) */ public void setElem(int bank, int i, int val) { bankdata[bank][i+offsets[bank]] = (short)(val&0xffff); theTrackable.markDirty(); } }