java.awt.image
Class DataBufferByte

java.lang.Object
  extended by java.awt.image.DataBuffer
      extended by java.awt.image.DataBufferByte

public final class DataBufferByte
extends DataBuffer

A DataBuffer that uses an array of byte primitives to represent each of its banks.


Field Summary
 
Fields inherited from class java.awt.image.DataBuffer
banks, dataType, offset, offsets, size, TYPE_BYTE, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT, TYPE_SHORT, TYPE_UNDEFINED, TYPE_USHORT
 
Constructor Summary
DataBufferByte(byte[][] dataArray, int size)
          Creates a new data buffer backed by the specified data banks.
DataBufferByte(byte[][] dataArray, int size, int[] offsets)
          Creates a new data buffer backed by the specified data banks, with the specified offsets to the first element in each bank.
DataBufferByte(byte[] dataArray, int size)
          Creates a new data buffer backed by the specified data bank.
DataBufferByte(byte[] dataArray, int size, int offset)
          Creates a new data buffer backed by the specified data bank, with the specified offset to the first element.
DataBufferByte(int size)
          Creates a new data buffer with a single data bank containing the specified number of byte elements.
DataBufferByte(int size, int numBanks)
          Creates a new data buffer with the specified number of data banks, each containing the specified number of byte elements.
 
Method Summary
 byte[][] getBankData()
          Returns the array underlying this DataBuffer.
 byte[] getData()
          Returns the first data bank.
 byte[] getData(int bank)
          Returns a data bank.
 int getElem(int i)
          Returns an element from the first data bank.
 int getElem(int bank, int i)
          Returns an element from a particular data bank.
 void setElem(int i, int val)
          Sets an element in the first data bank.
 void setElem(int bank, int i, int val)
          Sets an element in a particular data bank.
 
Methods inherited from class java.awt.image.DataBuffer
getDataType, getDataTypeSize, getElemDouble, getElemDouble, getElemFloat, getElemFloat, getNumBanks, getOffset, getOffsets, getSize, setElemDouble, setElemDouble, setElemFloat, setElemFloat
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataBufferByte

public DataBufferByte(int size)
Creates a new data buffer with a single data bank containing the specified number of byte elements.

Parameters:
size - the number of elements in the data bank.

DataBufferByte

public DataBufferByte(int size,
                      int numBanks)
Creates a new data buffer with the specified number of data banks, each containing the specified number of byte elements.

Parameters:
size - the number of elements in the data bank.
numBanks - the number of data banks.

DataBufferByte

public DataBufferByte(byte[] dataArray,
                      int size)
Creates a new data buffer backed by the specified data bank.

Note: there is no exception when dataArray is null, but in that case an exception will be thrown later if you attempt to access the data buffer.

Parameters:
dataArray - the data bank.
size - the number of elements in the data bank.

DataBufferByte

public DataBufferByte(byte[] dataArray,
                      int size,
                      int offset)
Creates a new data buffer backed by the specified data bank, with the specified offset to the first element.

Note: there is no exception when dataArray is null, but in that case an exception will be thrown later if you attempt to access the data buffer.

Parameters:
dataArray - the data bank.
size - the number of elements in the data bank.
offset - the offset to the first element in the array.

DataBufferByte

public DataBufferByte(byte[][] dataArray,
                      int size)
Creates a new data buffer backed by the specified data banks.

Parameters:
dataArray - the data banks.
size - the number of elements in the data bank.
Throws:
NullPointerException - if dataArray is null.

DataBufferByte

public DataBufferByte(byte[][] dataArray,
                      int size,
                      int[] offsets)
Creates a new data buffer backed by the specified data banks, with the specified offsets to the first element in each bank.

Parameters:
dataArray - the data banks.
size - the number of elements in the data bank.
offsets - the offsets to the first element in each data bank.
Throws:
NullPointerException - if dataArray is null.
Method Detail

getData

public byte[] getData()
Returns the first data bank.

Returns:
The first data bank.

getData

public byte[] getData(int bank)
Returns a data bank.

Parameters:
bank - the bank index.
Returns:
A data bank.

getBankData

public byte[][] getBankData()
Returns the array underlying this DataBuffer.

Returns:
The data banks.

getElem

public int getElem(int i)
Returns an element from the first data bank. The offset (specified in the constructor) is added to i before accessing the underlying data array.

Overrides:
getElem in class DataBuffer
Parameters:
i - the element index.
Returns:
The element.

getElem

public int getElem(int bank,
                   int i)
Returns an element from a particular data bank. The offset (specified in the constructor) is added to i before accessing the underlying data array.

Specified by:
getElem in class DataBuffer
Parameters:
bank - the bank index.
i - the element index.
Returns:
The element.

setElem

public void setElem(int i,
                    int val)
Sets an element in the first data bank. The offset (specified in the constructor) is added to i before updating the underlying data array.

Overrides:
setElem in class DataBuffer
Parameters:
i - the element index.
val - the new element value.

setElem

public void setElem(int bank,
                    int i,
                    int val)
Sets an element in a particular data bank. The offset (specified in the constructor) is added to i before updating the underlying data array.

Specified by:
setElem in class DataBuffer
Parameters:
bank - the data bank index.
i - the element index.
val - the new element value.