DataType (All javadoc for netcdf-java version 5.0.0-beta1)

java.lang.Object
- java.lang.Enum<DataType>
- - ucar.ma2.DataType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DataType>
```
public enum DataType
extends java.lang.Enum<DataType>
```
Type-safe enumeration of data types. Do not change the ordering of these enums, as they are used in protobuf messages, only add new ones onto the end.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataType.Signedness` A property of `integral` data types that determines whether they can represent both positive and negative numbers (signed), or only non-negative numbers (unsigned).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BOOLEAN`
`BYTE`
`CHAR`
`DOUBLE`
`ENUM1`
`ENUM2`
`ENUM4`
`FLOAT`
`INT`
`LONG`
`OBJECT`
`OPAQUE`
`SEQUENCE`
`SHORT`
`STRING`
`STRUCTURE`
`UBYTE`
`UINT`
`ULONG`
`USHORT`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DataType`	`enumTypeize(DataType dt)`
`java.lang.Class`	`getPrimitiveClassType()` The primitive class type: char, byte, float, double, short, int, long, boolean, String, StructureData, StructureDataIterator, ByteBuffer.
`DataType.Signedness`	`getSignedness()` Returns the `signedness` of this data type.
`int`	`getSize()` Size in bytes of one element of this data type.
`static DataType`	`getType(Array arr)`
`static DataType`	`getType(java.lang.Class c, boolean isUnsigned)` Find the DataType that matches this class.
`static DataType`	`getType(java.lang.String name)` Find the DataType that matches this name.
`boolean`	`isEnum()` Is this an enumeration types?
`boolean`	`isEnumCompatible(DataType inferred)`
`boolean`	`isFloatingPoint()` Is Float or Double
`boolean`	`isIntegral()` Is Byte, Int, Short, or Long
`boolean`	`isNumeric()` Is Byte, Float, Double, Int, Short, or Long
`boolean`	`isString()` Is String or Char
`boolean`	`isUnsigned()` Returns `true` if the data type is `unsigned`.
`java.lang.String`	`toString()` The DataType name, eg "byte", "float", "String".
`static short`	`unsignedByteToShort(byte b)` Widen an unsigned byte to a short.
`static long`	`unsignedIntToLong(int i)` Widen an unsigned int to a long.
`static java.math.BigInteger`	`unsignedLongToBigInt(long l)` Widen an unsigned long to a `BigInteger`.
`static java.lang.String`	`unsignedLongToString(long li)` convert an unsigned long to a String
`static int`	`unsignedShortToInt(short s)` Widen an unsigned short to an int.
`static DataType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DataType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`static java.lang.Number`	`widenNumber(java.lang.Number number)` Return a number that is equivalent to the specified value, but represented by the next larger data type.
`DataType`	`withSignedness(DataType.Signedness signedness)` Returns a DataType that is related to `this`, but with the specified signedness.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - BOOLEAN
```
public static final DataType BOOLEAN
```
  - BYTE
```
public static final DataType BYTE
```
  - CHAR
```
public static final DataType CHAR
```
  - SHORT
```
public static final DataType SHORT
```
  - INT
```
public static final DataType INT
```
  - LONG
```
public static final DataType LONG
```
  - FLOAT
```
public static final DataType FLOAT
```
  - DOUBLE
```
public static final DataType DOUBLE
```
  - SEQUENCE
```
public static final DataType SEQUENCE
```
  - STRING
```
public static final DataType STRING
```
  - STRUCTURE
```
public static final DataType STRUCTURE
```
  - ENUM1
```
public static final DataType ENUM1
```
  - ENUM2
```
public static final DataType ENUM2
```
  - ENUM4
```
public static final DataType ENUM4
```
  - OPAQUE
```
public static final DataType OPAQUE
```
  - OBJECT
```
public static final DataType OBJECT
```
  - UBYTE
```
public static final DataType UBYTE
```
  - USHORT
```
public static final DataType USHORT
```
  - UINT
```
public static final DataType UINT
```
  - ULONG
```
public static final DataType ULONG
```
- Method Detail
  - values
```
public static DataType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DataType c : DataType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DataType valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - toString
```
public java.lang.String toString()
```
    The DataType name, eg "byte", "float", "String".
    
    Overrides:
    
    toString in class java.lang.Enum<DataType>
  - getSize
```
public int getSize()
```
    Size in bytes of one element of this data type. Strings dont know, so return 0. Structures return 1.
    
    Returns:
    
    Size in bytes of one element of this data type.
  - getPrimitiveClassType
```
public java.lang.Class getPrimitiveClassType()
```
    The primitive class type: char, byte, float, double, short, int, long, boolean, String, StructureData, StructureDataIterator, ByteBuffer.
    
    Returns:
    
    the primitive class type
  - getSignedness
```
public DataType.Signedness getSignedness()
```
    Returns the signedness of this data type. For non-integral data types, it is guaranteed to be DataType.Signedness.SIGNED.
    
    Returns:
    
    the signedness of this data type.
  - isUnsigned
```
public boolean isUnsigned()
```
    Returns true if the data type is unsigned. For non-integral data types, it is guaranteed to be false.
    
    Returns:
    
    true if the data type is unsigned.
  - isString
```
public boolean isString()
```
    Is String or Char
    
    Returns:
    
    true if String or Char
  - isNumeric
```
public boolean isNumeric()
```
    Is Byte, Float, Double, Int, Short, or Long
    
    Returns:
    
    true if numeric
  - isIntegral
```
public boolean isIntegral()
```
    Is Byte, Int, Short, or Long
    
    Returns:
    
    true if integral
  - isFloatingPoint
```
public boolean isFloatingPoint()
```
    Is Float or Double
    
    Returns:
    
    true if floating point type
  - isEnum
```
public boolean isEnum()
```
    Is this an enumeration types?
    
    Returns:
    
    true if ENUM1, 2, or 4
  - withSignedness
```
public DataType withSignedness(DataType.Signedness signedness)
```
    Returns a DataType that is related to this, but with the specified signedness. This method is only meaningful for integral data types; if it is called on a non-integral type, then this is simply returned. Examples:
```
   assert DataType.INT.withSignedness(DataType.Signedness.UNSIGNED) == DataType.UINT;       // INT to UINT
   assert DataType.ULONG.withSignedness(DataType.Signedness.SIGNED) == DataType.LONG;       // ULONG to LONG
   assert DataType.SHORT.withSignedness(DataType.Signedness.SIGNED) == DataType.SHORT;      // this: Same signs
   assert DataType.STRING.withSignedness(DataType.Signedness.UNSIGNED) == DataType.STRING;  // this: Non-integral
 
```
    Parameters:
    
    signedness - the desired signedness of the returned DataType.
    
    Returns:
    
    a DataType that is related to this, but with the specified signedness.
  - isEnumCompatible
```
public boolean isEnumCompatible(DataType inferred)
```
  - enumTypeize
```
public static DataType enumTypeize(DataType dt)
```
  - getType
```
public static DataType getType(java.lang.String name)
```
    Find the DataType that matches this name.
    
    Parameters:
    
    name - find DataType with this name.
    
    Returns:
    
    DataType or null if no match.
  - getType
```
public static DataType getType(Array arr)
```
  - getType
```
public static DataType getType(java.lang.Class c,
                               boolean isUnsigned)
```
    Find the DataType that matches this class.
    
    Parameters:
    
    c - primitive or object class, eg float.class or Float.class
    
    Returns:
    
    DataType or null if no match.
  - unsignedLongToString
```
public static java.lang.String unsignedLongToString(long li)
```
    convert an unsigned long to a String
    
    Parameters:
    
    li - unsigned int
    
    Returns:
    
    equivilent long value
  - widenNumber
```
public static java.lang.Number widenNumber(java.lang.Number number)
```
    Return a number that is equivalent to the specified value, but represented by the next larger data type. For example, a short will be widened to an int and a long will be widened to a BigInteger.
    
    Parameters:
    
    number - a number.
    
    Returns:
    
    a wider Number with the same value.
  - unsignedLongToBigInt
```
public static java.math.BigInteger unsignedLongToBigInt(long l)
```
    Widen an unsigned long to a BigInteger.
    
    Parameters:
    
    l - an unsigned long
    
    Returns:
    
    the equivalent BigInteger value.
  - unsignedIntToLong
```
public static long unsignedIntToLong(int i)
```
    Widen an unsigned int to a long.
    
    Parameters:
    
    i - an unsigned int.
    
    Returns:
    
    the equivalent long value.
  - unsignedShortToInt
```
public static int unsignedShortToInt(short s)
```
    Widen an unsigned short to an int.
    
    Parameters:
    
    s - an unsigned short.
    
    Returns:
    
    the equivalent int value.
  - unsignedByteToShort
```
public static short unsignedByteToShort(byte b)
```
    Widen an unsigned byte to a short.
    
    Parameters:
    
    b - an unsigned byte.
    
    Returns:
    
    the equivalent short value.

Enum DataType

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BOOLEAN

BYTE

CHAR

SHORT

INT

LONG

FLOAT

DOUBLE

SEQUENCE

STRING

STRUCTURE

ENUM1

ENUM2

ENUM4

OPAQUE

OBJECT

UBYTE

USHORT

UINT

ULONG

Method Detail

values

valueOf

toString

getSize

getPrimitiveClassType

getSignedness

isUnsigned

isString

isNumeric

isIntegral

isFloatingPoint

isEnum

withSignedness

isEnumCompatible

enumTypeize

getType

getType

getType

unsignedLongToString

widenNumber

unsignedLongToBigInt

unsignedIntToLong

unsignedShortToInt

unsignedByteToShort