ArrayByte (NetCDF-Java 4.2 Public and Private API)

java.lang.Object
- ucar.ma2.Array
- - ucar.ma2.ArrayByte

Direct Known Subclasses:

ArrayByte.D0, ArrayByte.D1, ArrayByte.D2, ArrayByte.D3, ArrayByte.D4, ArrayByte.D5, ArrayByte.D6, ArrayByte.D7
```
public class ArrayByte
extends Array
```
Concrete implementation of Array specialized for bytes. Data storage is with 1D java array of bytes.
issues: what should we do if a conversion loses accuracy? nothing ? Exception ?

Author:

caron

See Also:
Array

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ArrayByte.D0` Concrete implementation of Array specialized for byte, rank 0.
`static class`	`ArrayByte.D1` Concrete implementation of Array specialized for byte, rank 1.
`static class`	`ArrayByte.D2` Concrete implementation of Array specialized for byte, rank 2.
`static class`	`ArrayByte.D3` Concrete implementation of Array specialized for byte, rank 3.
`static class`	`ArrayByte.D4` Concrete implementation of Array specialized for byte, rank 4.
`static class`	`ArrayByte.D5` Concrete implementation of Array specialized for byte, rank 5.
`static class`	`ArrayByte.D6` Concrete implementation of Array specialized for byte, rank 6.
`static class`	`ArrayByte.D7` Concrete implementation of Array specialized for byte, rank 7.

Field Summary

Fields
Modifier and Type Field and Description

protected byte[] storage
- Fields inherited from class ucar.ma2.Array
  indexCalc, rank, unsigned

Fields
Modifier and Type	Field and Description
`protected byte[]`	`storage`

Constructor Summary

Constructors
Constructor and Description

ArrayByte(int[] dimensions)
Create a new Array of type byte and the given shape.

Constructors
Constructor and Description
`ArrayByte(int[] dimensions)` Create a new Array of type byte and the given shape.

Method Summary

Methods
Modifier and Type	Method and Description
`byte`	`get(Index i)` get the value at the specified index.
`boolean`	`getBoolean(Index i)` not legal, throw ForbiddenConversionException
`boolean`	`getBoolean(int index)`
`byte`	`getByte(Index i)` Get the array element at the current element of ima, as a byte.
`byte`	`getByte(int index)`
`char`	`getChar(Index i)` Get the array element at the current element of ima, as a char.
`char`	`getChar(int index)`
`java.nio.ByteBuffer`	`getDataAsByteBuffer()` This gets the data as a ByteBuffer, in correct order.
`double`	`getDouble(Index i)` Get the array element at the current element of ima, as a double.
`double`	`getDouble(int index)`
`java.lang.Class`	`getElementType()` Return the element class type
`float`	`getFloat(Index i)` Get the array element at the current element of ima, as a float.
`float`	`getFloat(int index)`
`int`	`getInt(Index i)` Get the array element at the current element of ima, as a int.
`int`	`getInt(int index)`
`long`	`getLong(Index i)` Get the array element at the current element of ima, as a long.
`long`	`getLong(int index)`
`java.lang.Object`	`getObject(Index i)` Get the array element at index as an Object.
`java.lang.Object`	`getObject(int index)`
`short`	`getShort(Index i)` Get the array element at the current element of ima, as a short.
`short`	`getShort(int index)`
`java.lang.Object`	`getStorage()` Get underlying primitive array storage.
`void`	`set(Index i, byte value)` set the value at the sepcified index.
`void`	`setBoolean(Index i, boolean value)` not legal, throw ForbiddenConversionException
`void`	`setBoolean(int index, boolean value)`
`void`	`setByte(Index i, byte value)` Set the array element at the current element of ima.
`void`	`setByte(int index, byte value)`
`void`	`setChar(Index i, char value)` Set the array element at the current element of ima.
`void`	`setChar(int index, char value)`
`void`	`setDouble(Index i, double value)` Set the array element at the current element of ima.
`void`	`setDouble(int index, double value)`
`void`	`setFloat(Index i, float value)` Set the array element at the current element of ima.
`void`	`setFloat(int index, float value)`
`void`	`setInt(Index i, int value)` Set the array element at the current element of ima.
`void`	`setInt(int index, int value)`
`void`	`setLong(Index i, long value)` Set the array element at the current element of ima.
`void`	`setLong(int index, long value)`
`void`	`setObject(Index i, java.lang.Object value)` Set the array element at index to the specified value.
`void`	`setObject(int index, java.lang.Object value)`
`void`	`setShort(Index i, short value)` Set the array element at the current element of ima.
`void`	`setShort(int index, short value)`

Methods inherited from class ucar.ma2.Array
arraycopy, copy, copyTo1DJavaArray, copyToNDJavaArray, factory, factory, factory, factory, factory, factory, factoryConstant, flip, get1DJavaArray, getIndex, getIndexIterator, getIndexIteratorFast, getIndexPrivate, getRangeIterator, getRank, getShape, getSize, getSizeBytes, hasNext, isConstant, isUnsigned, makeArray, makeArray, makeArray, next, nextBoolean, nextByte, nextChar, nextDouble, nextFloat, nextInt, nextLong, nextShort, permute, reduce, reduce, resetLocalIterator, reshape, reshapeNoCopy, section, section, section, sectionNoReduce, sectionNoReduce, setUnsigned, shapeToString, slice, toString, transpose

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - storage
```
protected byte[] storage
```
- Constructor Detail
  - ArrayByte
```
public ArrayByte(int[] dimensions)
```
    Create a new Array of type byte and the given shape. dimensions.length determines the rank of the new Array.
    
    Parameters:
    dimensions - the shape of the Array.
- Method Detail
  - getStorage
```
public java.lang.Object getStorage()
```
    Description copied from class: Array
    
    Get underlying primitive array storage. Exposed for efficiency, use at your own risk.
    
    Specified by:
    
    getStorage in class Array
    
    Returns:
    underlying primitive array storage
  - getDataAsByteBuffer
```
public java.nio.ByteBuffer getDataAsByteBuffer()
```
    Description copied from class: Array
    
    This gets the data as a ByteBuffer, in correct order. It avoids copying if possible. Only for numeric types (byte, short, int, long, double, float)
    
    Overrides:
    
    getDataAsByteBuffer in class Array
    
    Returns:
    equivilent data in a ByteBuffer
  - getElementType
```
public java.lang.Class getElementType()
```
    Return the element class type
    
    Specified by:
    
    getElementType in class Array
    
    Returns:
    the class of the element
  - get
```
public byte get(Index i)
```
    get the value at the specified index.
    
    Parameters:
    i - index
    
    Returns:
    byte value
  - set
```
public void set(Index i,
       byte value)
```
    set the value at the sepcified index.
    
    Parameters:
    i - index
    value - set to this value
  - getDouble
```
public double getDouble(Index i)
```
    Description copied from class: Array
    
    Get the array element at the current element of ima, as a double.
    
    Specified by:
    
    getDouble in class Array
    
    Parameters:
    i - Index with current element set
    
    Returns:
    value at index cast to double if necessary.
  - setDouble
```
public void setDouble(Index i,
             double value)
```
    Description copied from class: Array
    
    Set the array element at the current element of ima.
    
    Specified by:
    
    setDouble in class Array
    
    Parameters:
    i - Index with current element set
    value - the new value; cast to underlying data type if necessary.
  - getFloat
```
public float getFloat(Index i)
```
    Description copied from class: Array
    
    Get the array element at the current element of ima, as a float.
    
    Specified by:
    
    getFloat in class Array
    
    Parameters:
    i - Index with current element set
    
    Returns:
    value at index cast to float if necessary.
  - setFloat
```
public void setFloat(Index i,
            float value)
```
    Description copied from class: Array
    
    Set the array element at the current element of ima.
    
    Specified by:
    
    setFloat in class Array
    
    Parameters:
    i - Index with current element set
    value - the new value; cast to underlying data type if necessary.
  - getLong
```
public long getLong(Index i)
```
    Description copied from class: Array
    
    Get the array element at the current element of ima, as a long.
    
    Specified by:
    
    getLong in class Array
    
    Parameters:
    i - Index with current element set
    
    Returns:
    value at index cast to long if necessary.
  - setLong
```
public void setLong(Index i,
           long value)
```
    Description copied from class: Array
    
    Set the array element at the current element of ima.
    
    Specified by:
    
    setLong in class Array
    
    Parameters:
    i - Index with current element set
    value - the new value; cast to underlying data type if necessary.
  - getInt
```
public int getInt(Index i)
```
    Description copied from class: Array
    
    Get the array element at the current element of ima, as a int.
    
    Specified by:
    
    getInt in class Array
    
    Parameters:
    i - Index with current element set
    
    Returns:
    value at index cast to int if necessary.
  - setInt
```
public void setInt(Index i,
          int value)
```
    Description copied from class: Array
    
    Set the array element at the current element of ima.
    
    Specified by:
    
    setInt in class Array
    
    Parameters:
    i - Index with current element set
    value - the new value; cast to underlying data type if necessary.
  - getShort
```
public short getShort(Index i)
```
    Description copied from class: Array
    
    Get the array element at the current element of ima, as a short.
    
    Specified by:
    
    getShort in class Array
    
    Parameters:
    i - Index with current element set
    
    Returns:
    value at index cast to short if necessary.
  - setShort
```
public void setShort(Index i,
            short value)
```
    Description copied from class: Array
    
    Set the array element at the current element of ima.
    
    Specified by:
    
    setShort in class Array
    
    Parameters:
    i - Index with current element set
    value - the new value; cast to underlying data type if necessary.
  - getByte
```
public byte getByte(Index i)
```
    Description copied from class: Array
    
    Get the array element at the current element of ima, as a byte.
    
    Specified by:
    
    getByte in class Array
    
    Parameters:
    i - Index with current element set
    
    Returns:
    value at index cast to float if necessary.
  - setByte
```
public void setByte(Index i,
           byte value)
```
    Description copied from class: Array
    
    Set the array element at the current element of ima.
    
    Specified by:
    
    setByte in class Array
    
    Parameters:
    i - Index with current element set
    value - the new value; cast to underlying data type if necessary.
  - getChar
```
public char getChar(Index i)
```
    Description copied from class: Array
    
    Get the array element at the current element of ima, as a char.
    
    Specified by:
    
    getChar in class Array
    
    Parameters:
    i - Index with current element set
    
    Returns:
    value at index cast to char if necessary.
  - setChar
```
public void setChar(Index i,
           char value)
```
    Description copied from class: Array
    
    Set the array element at the current element of ima.
    
    Specified by:
    
    setChar in class Array
    
    Parameters:
    i - Index with current element set
    value - the new value; cast to underlying data type if necessary.
  - getBoolean
```
public boolean getBoolean(Index i)
```
    not legal, throw ForbiddenConversionException
    
    Specified by:
    
    getBoolean in class Array
    
    Parameters:
    i - Index with current element set
    
    Returns:
    value at index cast to boolean if necessary.
  - setBoolean
```
public void setBoolean(Index i,
              boolean value)
```
    not legal, throw ForbiddenConversionException
    
    Specified by:
    
    setBoolean in class Array
    
    Parameters:
    i - Index with current element set
    value - the new value; cast to underlying data type if necessary.
  - getObject
```
public java.lang.Object getObject(Index i)
```
    Description copied from class: Array
    
    Get the array element at index as an Object. The returned value is wrapped in an object, eg Double for double
    
    Specified by:
    
    getObject in class Array
    
    Parameters:
    i - element Index
    
    Returns:
    Object value at index
  - setObject
```
public void setObject(Index i,
             java.lang.Object value)
```
    Description copied from class: Array
    
    Set the array element at index to the specified value. the value must be passed wrapped in the appropriate Object (eg Double for double)
    
    Specified by:
    
    setObject in class Array
    
    Parameters:
    i - Index with current element set
    value - the new value.
  - getDouble
```
public double getDouble(int index)
```
    Specified by:
    
    getDouble in class Array
  - setDouble
```
public void setDouble(int index,
             double value)
```
    Specified by:
    
    setDouble in class Array
  - getFloat
```
public float getFloat(int index)
```
    Specified by:
    
    getFloat in class Array
  - setFloat
```
public void setFloat(int index,
            float value)
```
    Specified by:
    
    setFloat in class Array
  - getLong
```
public long getLong(int index)
```
    Specified by:
    
    getLong in class Array
  - setLong
```
public void setLong(int index,
           long value)
```
    Specified by:
    
    setLong in class Array
  - getInt
```
public int getInt(int index)
```
    Specified by:
    
    getInt in class Array
  - setInt
```
public void setInt(int index,
          int value)
```
    Specified by:
    
    setInt in class Array
  - getShort
```
public short getShort(int index)
```
    Specified by:
    
    getShort in class Array
  - setShort
```
public void setShort(int index,
            short value)
```
    Specified by:
    
    setShort in class Array
  - getByte
```
public byte getByte(int index)
```
    Specified by:
    
    getByte in class Array
  - setByte
```
public void setByte(int index,
           byte value)
```
    Specified by:
    
    setByte in class Array
  - getChar
```
public char getChar(int index)
```
    Specified by:
    
    getChar in class Array
  - setChar
```
public void setChar(int index,
           char value)
```
    Specified by:
    
    setChar in class Array
  - getBoolean
```
public boolean getBoolean(int index)
```
    Specified by:
    
    getBoolean in class Array
  - setBoolean
```
public void setBoolean(int index,
              boolean value)
```
    Specified by:
    
    setBoolean in class Array
  - getObject
```
public java.lang.Object getObject(int index)
```
    Specified by:
    
    getObject in class Array
  - setObject
```
public void setObject(int index,
             java.lang.Object value)
```
    Specified by:
    
    setObject in class Array

Class ArrayByte

Nested Class Summary

Field Summary

Fields inherited from class ucar.ma2.Array

Constructor Summary

Method Summary

Methods inherited from class ucar.ma2.Array

Methods inherited from class java.lang.Object

Field Detail

storage

Constructor Detail

ArrayByte

Method Detail

getStorage

getDataAsByteBuffer

getElementType

get

set

getDouble

setDouble

getFloat

setFloat

getLong

setLong

getInt

setInt

getShort

setShort

getByte

setByte

getChar

setChar

getBoolean

setBoolean

getObject

setObject

getDouble

setDouble

getFloat

setFloat

getLong

setLong

getInt

setInt

getShort

setShort

getByte

setByte

getChar

setChar

getBoolean

setBoolean

getObject

setObject