Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.4.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## java.awt.image
Class DataBufferUShort

    java.lang.Object
      java.awt.image.DataBuffer
          java.awt.image.DataBufferUShort

public final class DataBufferUShort
extends DataBuffer

This class extends `DataBuffer` and stores data internally as shorts. Values stored in the short array(s) of this `DataBuffer` are treated as unsigned values.

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
`DataBufferUShort(int size)` Constructs an unsigned-short based `DataBuffer` with a single bank and the specified size.
`DataBufferUShort(int size, int numBanks)` Constructs an unsigned-short based `DataBuffer` with the specified number of banks, all of which are the specified size.
`DataBufferUShort(short[][] dataArray, int size)` Constructs an unsigned-short based `DataBuffer` with the specified arrays.
`DataBufferUShort(short[][] dataArray, int size, int[] offsets)` Constructs an unsigned-short based `DataBuffer` with specified arrays, size, and offsets.
`DataBufferUShort(short[] dataArray, int size)` Constructs an unsigned-short based `DataBuffer` with a single bank using the specified array.
`DataBufferUShort(short[] dataArray, int size, int offset)` Constructs an unsigned-short based `DataBuffer` with a single bank using the specified array, size, and offset.

Method Summary
`short[][]` | `getBankData()` Returns the data arrays for all banks.
`short[]` | `getData()` Returns the default (first) unsigned-short data array.
`short[]` | `getData(int bank)` Returns the data array for the specified bank.
`int` | `getElem(int i)` Returns the requested data array element from the first (default) bank.
`int` | `getElem(int bank, int i)` Returns the requested data array element from the specified bank.
`void` | `setElem(int i, int val)` Sets the requested data array element in the first (default) bank to the specified value.
`void` | `setElem(int bank, int i, int val)` Sets the requested data array element in the specified bank from the given integer.

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

### DataBufferUShort

    public DataBufferUShort(int size)

  Constructs an unsigned-short based `DataBuffer` with a single bank and the specified size.

Parameters:
  `size` - The size of the `DataBuffer`.

### DataBufferUShort

    public DataBufferUShort(int size,
                            int numBanks)

  Constructs an unsigned-short based `DataBuffer` with the specified number of banks, all of which are the specified size.

Parameters:
  `size` - The size of the banks in the `DataBuffer`.
  `numBanks` - The number of banks in the a`DataBuffer`.

### DataBufferUShort

    public DataBufferUShort(short[] dataArray,
                            int size)

  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.

Parameters:
  `dataArray` - The unsigned-short array for the `DataBuffer`.
  `size` - The size of the `DataBuffer` bank.

### DataBufferUShort

    public DataBufferUShort(short[] dataArray,
                            int size,
                            int offset)

  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`.

Parameters:
  `dataArray` - The unsigned-short array for the `DataBuffer`.
  `size` - The size of the `DataBuffer` bank.
  `offset` - The offset into the `dataArray`.

### DataBufferUShort

    public DataBufferUShort(short[][] dataArray,
                            int size)

  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`.

Parameters:
  `dataArray` - The unsigned-short arrays for the `DataBuffer`.
  `size` - The size of the banks in the `DataBuffer`.

### DataBufferUShort

    public DataBufferUShort(short[][] dataArray,
                            int size,
                            int[] offsets)

  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`.

Parameters:
  `dataArray` - The unsigned-short arrays for the `DataBuffer`.
  `size` - The size of the banks in the `DataBuffer`.
  `offsets` - The offsets into each array.

Method Detail

### getData

    public short[] getData()

  Returns the default (first) unsigned-short data array.

  Returns:
    The first unsigned-short data array.

### getData

    public short[] getData(int bank)

  Returns the data array for the specified bank.

  Parameters:
    `bank` - The bank whose data array you want to get.
  Returns:
    The data array for the specified bank.

### getBankData

    public short[][] getBankData()

  Returns the data arrays for all banks.

  Returns:
    All of the data arrays.

### getElem

    public int getElem(int i)

  Returns the requested data array element from the first (default) bank.

  Overrides:
    `getElem` in class `DataBuffer`
  Parameters:
    `i` - The data array element you want to get.
  Returns:
    The requested data array element as an integer.
  See Also:
    `setElem(int, int)`, `setElem(int, int, int)`

### getElem

    public int getElem(int bank,
                       int i)

  Returns the requested data array element from the specified bank.

  Specified by:
    `getElem` in class `DataBuffer`
  Parameters:
    `bank` - The bank from which you want to get a data array element.
    `i` - The data array element you want to get.
  Returns:
    The requested data array element as an integer.
  See Also:
    `setElem(int, int)`, `setElem(int, int, int)`

### setElem

    public void setElem(int i,
                        int val)

  Sets the requested data array element in the first (default) bank to the specified value.

  Overrides:
    `setElem` in class `DataBuffer`
  Parameters:
    `i` - The data array element you want to set.
    `val` - The integer value to which you want to set the data array element.
  See Also:
    `getElem(int)`, `getElem(int, int)`

### setElem

    public void setElem(int bank,
                        int i,
                        int val)

  Sets the requested data array element in the specified bank from the given integer.

  Specified by:
    `setElem` in class `DataBuffer`
  Parameters:
    `bank` - The bank in which you want to set the data array element.
    `i` - The data array element you want to set.
    `val` - The integer value to which you want to set the specified data array element.
  See Also:
    `getElem(int)`, `getElem(int, int)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.4.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.