DataType

java.lang.Object
- java.lang.Enum<DataType>
- - icy.type.DataType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DataType>
```
public enum DataType
extends java.lang.Enum<DataType>
```
DataType class.
This class is used to define the internal native data type of a given object.

Author:

Stephane

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BYTE`
`DOUBLE`
`FLOAT`
`INT`
`LONG`
`SHORT`
`UBYTE`
`UINT`
`ULONG`
`UNDEFINED` Deprecated. Use `null` instance instead
`USHORT`

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`INT_MAX_VALUE`
`static float`	`INT_MAX_VALUE_F`
`static double`	`INT_MIN_VALUE`
`static float`	`INT_MIN_VALUE_F`
`static double`	`LONG_MAX_VALUE`
`static float`	`LONG_MAX_VALUE_F`
`static double`	`LONG_MIN_VALUE`
`static float`	`LONG_MIN_VALUE_F`
`static double`	`UBYTE_MAX_VALUE` cached
`static float`	`UBYTE_MAX_VALUE_F`
`static double`	`UINT_MAX_VALUE`
`static float`	`UINT_MAX_VALUE_F`
`static double`	`ULONG_MAX_VALUE`
`static float`	`ULONG_MAX_VALUE_F`
`static double`	`USHORT_MAX_VALUE`
`static float`	`USHORT_MAX_VALUE_F`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getBitSize()` Return the size (in bit) of the specified dataType
`double[]`	`getBounds()` Get the bounds `[min,max]` for current DataType.
`static DataType`	`getDataType(java.lang.Class<?> classType)` Return a DataType from the specified primitive class type
`static DataType`	`getDataType(int oldDataType)` Return a DataType from old dataType.
`static DataType`	`getDataType(int oldDataType, boolean signed)` Return a DataType from old dataType.
`static DataType`	`getDataType(java.lang.String value)` Return a DataType from the specified string.
`static DataType`	`getDataTypeFromDataBufferType(int dataBufferType)` Return a DataType from the specified DataBuffer type.
`static DataType`	`getDataTypeFromFormatToolsType(int type)` Return a DataType from the specified FormatTools type.
`static DataType`	`getDataTypeFromPixelType(ome.xml.model.enums.PixelType type)` Return a DataType from the specified PixelType.
`static DataType`	`getDataTypeFromVTKType(int vtkType)` Return a DataType from the specified VTK type.
`double[]`	`getDefaultBounds()` Get the default bounds for current DataType.
`static java.lang.String[]`	`getItems(boolean javaTypeOnly, boolean longString, boolean wantUndef)` Return all dataType as String items array (can be used for ComboBox).
`DataType`	`getJavaType()` Return the java compatible data type (signed integer type only).
`double`	`getMaxValue()` Return the maximum value for current DataType
`double`	`getMinValue()` Return the minimum value for current DataType
`int`	`getSize()` Return the size (in byte) of the specified dataType
`boolean`	`isFloat()` Return true if this is a float data type
`boolean`	`isInteger()` Return true if this is an integer data type
`boolean`	`isJavaType()` Return true if this is a compatible java data type (signed integer type only)
`boolean`	`isSameJavaType(DataType dataType)` Return true if specified data type has same "basic" type (no sign information) data type
`boolean`	`isSigned()` Return true if this is a signed data type
`int`	`sizeOf()` Deprecated. Use `getSize()` instead
`int`	`toDataBufferType()` Return the DataBuffer type corresponding to current DataType
`java.lang.String`	`toLongString()` Convert DataType to long String (long description with bpp information)
`ome.xml.model.enums.PixelType`	`toPixelType()` Return the PixelType corresponding to current DataType
`java.lang.Class<?>`	`toPrimitiveClass()` Return the corresponding primitive class type corresponding to this DataType.
`java.lang.String`	`toString()`
`java.lang.String`	`toString(boolean longString)` Convert DataType to String.
`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.

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

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

- Enum Constant Detail
  - UBYTE
```
public static final DataType UBYTE
```
  - BYTE
```
public static final DataType BYTE
```
  - USHORT
```
public static final DataType USHORT
```
  - SHORT
```
public static final DataType SHORT
```
  - UINT
```
public static final DataType UINT
```
  - INT
```
public static final DataType INT
```
  - ULONG
```
public static final DataType ULONG
```
  - LONG
```
public static final DataType LONG
```
  - FLOAT
```
public static final DataType FLOAT
```
  - DOUBLE
```
public static final DataType DOUBLE
```
  - UNDEFINED
```
public static final DataType UNDEFINED
```
    Deprecated. Use null instance instead
- Field Detail
  - UBYTE_MAX_VALUE
```
public static final double UBYTE_MAX_VALUE
```
    cached
  - USHORT_MAX_VALUE
```
public static final double USHORT_MAX_VALUE
```
  - UINT_MAX_VALUE
```
public static final double UINT_MAX_VALUE
```
  - ULONG_MAX_VALUE
```
public static final double ULONG_MAX_VALUE
```
  - INT_MIN_VALUE
```
public static final double INT_MIN_VALUE
```
    See Also:
    Constant Field Values
  - LONG_MIN_VALUE
```
public static final double LONG_MIN_VALUE
```
    See Also:
    Constant Field Values
  - INT_MAX_VALUE
```
public static final double INT_MAX_VALUE
```
    See Also:
    Constant Field Values
  - LONG_MAX_VALUE
```
public static final double LONG_MAX_VALUE
```
    See Also:
    Constant Field Values
  - UBYTE_MAX_VALUE_F
```
public static final float UBYTE_MAX_VALUE_F
```
  - USHORT_MAX_VALUE_F
```
public static final float USHORT_MAX_VALUE_F
```
  - UINT_MAX_VALUE_F
```
public static final float UINT_MAX_VALUE_F
```
  - ULONG_MAX_VALUE_F
```
public static final float ULONG_MAX_VALUE_F
```
  - INT_MIN_VALUE_F
```
public static final float INT_MIN_VALUE_F
```
    See Also:
    Constant Field Values
  - LONG_MIN_VALUE_F
```
public static final float LONG_MIN_VALUE_F
```
    See Also:
    Constant Field Values
  - INT_MAX_VALUE_F
```
public static final float INT_MAX_VALUE_F
```
    See Also:
    Constant Field Values
  - LONG_MAX_VALUE_F
```
public static final float LONG_MAX_VALUE_F
```
    See Also:
    Constant Field Values
- 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
  - getItems
```
public static java.lang.String[] getItems(boolean javaTypeOnly,
                          boolean longString,
                          boolean wantUndef)
```
    Return all dataType as String items array (can be used for ComboBox).
    
    Parameters:
    javaTypeOnly - Define if we want only java compatible data type (no unsigned integer types)
    longString - Define if we want long string format (bpp information)
    wantUndef - Define if we want the UNDEFINED data type in the list
  - getDataType
```
public static DataType getDataType(java.lang.String value)
```
    Return a DataType from the specified string.
    ex : getDataType("byte") will return DataType.BYTE
  - getDataType
```
public static DataType getDataType(int oldDataType,
                   boolean signed)
```
    Return a DataType from old dataType.
    ex : getDataTypeFromOldDataType(TypeUtil.BYTE, false) will return DataType.UBYTE
  - getDataType
```
public static DataType getDataType(int oldDataType)
```
    Return a DataType from old dataType.
    ex : getDataType(TypeUtil.BYTE) will return DataType.BYTE
  - getDataType
```
public static DataType getDataType(java.lang.Class<?> classType)
```
    Return a DataType from the specified primitive class type
  - getDataTypeFromVTKType
```
public static DataType getDataTypeFromVTKType(int vtkType)
```
    Return a DataType from the specified VTK type.
    ex : getDataTypeFromVTKType(VtkUtil.VTK_INT) will return DataType.INT
  - getDataTypeFromDataBufferType
```
public static DataType getDataTypeFromDataBufferType(int dataBufferType)
```
    Return a DataType from the specified DataBuffer type.
    ex : getDataTypeFromDataBufferType(DataBuffer.TYPE_BYTE) will return DataType.UBYTE
  - getDataTypeFromFormatToolsType
```
public static DataType getDataTypeFromFormatToolsType(int type)
```
    Return a DataType from the specified FormatTools type.
    ex : getDataTypeFromFormatToolsType(FormatTools.UINT8) will return DataType.UBYTE
  - getDataTypeFromPixelType
```
public static DataType getDataTypeFromPixelType(ome.xml.model.enums.PixelType type)
```
    Return a DataType from the specified PixelType.
    ex : getDataTypeFromPixelType(FormatTools.UINT8) will return DataType.UBYTE
  - getJavaType
```
public DataType getJavaType()
```
    Return the java compatible data type (signed integer type only).
    Can be only one of the following :
    BYTE
    SHORT
    INT
    LONG
    FLOAT
    DOUBLE
  - getMinValue
```
public double getMinValue()
```
    Return the minimum value for current DataType
  - getMaxValue
```
public double getMaxValue()
```
    Return the maximum value for current DataType
  - getDefaultBounds
```
public double[] getDefaultBounds()
```
    Get the default bounds for current DataType.
    This actually returns [0,1] for Float or Double DataType.
  - getBounds
```
public double[] getBounds()
```
    Get the bounds [min,max] for current DataType.
  - isJavaType
```
public boolean isJavaType()
```
    Return true if this is a compatible java data type (signed integer type only)
  - isSigned
```
public boolean isSigned()
```
    Return true if this is a signed data type
  - isFloat
```
public boolean isFloat()
```
    Return true if this is a float data type
  - isInteger
```
public boolean isInteger()
```
    Return true if this is an integer data type
  - sizeOf
```
@Deprecated
public int sizeOf()
```
    Deprecated. Use getSize() instead
  - getSize
```
public int getSize()
```
    Return the size (in byte) of the specified dataType
  - getBitSize
```
public int getBitSize()
```
    Return the size (in bit) of the specified dataType
  - isSameJavaType
```
public boolean isSameJavaType(DataType dataType)
```
    Return true if specified data type has same "basic" type (no sign information) data type
  - toPrimitiveClass
```
public java.lang.Class<?> toPrimitiveClass()
```
    Return the corresponding primitive class type corresponding to this DataType.
  - toDataBufferType
```
public int toDataBufferType()
```
    Return the DataBuffer type corresponding to current DataType
  - toPixelType
```
public ome.xml.model.enums.PixelType toPixelType()
```
    Return the PixelType corresponding to current DataType
  - toString
```
public java.lang.String toString(boolean longString)
```
    Convert DataType to String.
    
    Parameters:
    longString - Define if we want long description (bpp information)
  - toLongString
```
public java.lang.String toLongString()
```
    Convert DataType to long String (long description with bpp information)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<DataType>

Enum DataType

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UBYTE

BYTE

USHORT

SHORT

UINT

INT

ULONG

LONG

FLOAT

DOUBLE

UNDEFINED

Field Detail

UBYTE_MAX_VALUE

USHORT_MAX_VALUE

UINT_MAX_VALUE

ULONG_MAX_VALUE

INT_MIN_VALUE

LONG_MIN_VALUE

INT_MAX_VALUE

LONG_MAX_VALUE

UBYTE_MAX_VALUE_F

USHORT_MAX_VALUE_F

UINT_MAX_VALUE_F

ULONG_MAX_VALUE_F

INT_MIN_VALUE_F

LONG_MIN_VALUE_F

INT_MAX_VALUE_F

LONG_MAX_VALUE_F

Method Detail

values

valueOf

getItems

getDataType

getDataType

getDataType

getDataType

getDataTypeFromVTKType

getDataTypeFromDataBufferType

getDataTypeFromFormatToolsType

getDataTypeFromPixelType

getJavaType

getMinValue

getMaxValue

getDefaultBounds

getBounds

isJavaType

isSigned

isFloat

isInteger

sizeOf

getSize

getBitSize

isSameJavaType

toPrimitiveClass

toDataBufferType

toPixelType

toString

toLongString

toString