FieldType (Tagged Image File Format 2.0.0 API)

java.lang.Object
- java.lang.Enum<FieldType>
- - mil.nga.tiff.FieldType

All Implemented Interfaces:

Serializable, Comparable<FieldType>
```
public enum FieldType
extends Enum<FieldType>
```
Field Types

Author:

osbornb

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ASCII` 8-bit byte that contains a 7-bit ASCII code; the last byte must be NUL (binary zero)
`BYTE` 8-bit unsigned integer
`DOUBLE` Double precision (8-byte) IEEE format
`FLOAT` Single precision (4-byte) IEEE format
`LONG` 32-bit (4-byte) unsigned integer
`RATIONAL` Two LONGs: the first represents the numerator of a fraction; the second, the denominator
`SBYTE` An 8-bit signed (twos-complement) integer
`SHORT` 16-bit (2-byte) unsigned integer
`SLONG` A 32-bit (4-byte) signed (twos-complement) integer
`SRATIONAL` Two SLONG’s: the first represents the numerator of a fraction, the second the denominator
`SSHORT` A 16-bit (2-byte) signed (twos-complement) integer
`UNDEFINED` An 8-bit byte that may contain anything, depending on the definition of the field

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBits()` Get the number of bits per value
`int`	`getBytes()` Get the number of bytes per value
`static FieldType`	`getFieldType(int fieldType)` Get the field type
`static FieldType`	`getFieldType(int sampleFormat, int bitsPerSample)` Get the field type of the sample format and bits per sample
`static int`	`getSampleFormat(FieldType fieldType)` Get the sample format of the field type
`int`	`getValue()` Get the field type value
`static FieldType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FieldType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

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

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

- Enum Constant Detail
  - BYTE
```
public static final FieldType BYTE
```
    8-bit unsigned integer
  - ASCII
```
public static final FieldType ASCII
```
    8-bit byte that contains a 7-bit ASCII code; the last byte must be NUL (binary zero)
  - SHORT
```
public static final FieldType SHORT
```
    16-bit (2-byte) unsigned integer
  - LONG
```
public static final FieldType LONG
```
    32-bit (4-byte) unsigned integer
  - RATIONAL
```
public static final FieldType RATIONAL
```
    Two LONGs: the first represents the numerator of a fraction; the second, the denominator
  - SBYTE
```
public static final FieldType SBYTE
```
    An 8-bit signed (twos-complement) integer
  - UNDEFINED
```
public static final FieldType UNDEFINED
```
    An 8-bit byte that may contain anything, depending on the definition of the field
  - SSHORT
```
public static final FieldType SSHORT
```
    A 16-bit (2-byte) signed (twos-complement) integer
  - SLONG
```
public static final FieldType SLONG
```
    A 32-bit (4-byte) signed (twos-complement) integer
  - SRATIONAL
```
public static final FieldType SRATIONAL
```
    Two SLONG’s: the first represents the numerator of a fraction, the second the denominator
  - FLOAT
```
public static final FieldType FLOAT
```
    Single precision (4-byte) IEEE format
  - DOUBLE
```
public static final FieldType DOUBLE
```
    Double precision (8-byte) IEEE format
- Method Detail
  - values
```
public static FieldType[] 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 (FieldType c : FieldType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FieldType valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getValue
```
public int getValue()
```
    Get the field type value
    
    Returns:
    
    field type value
  - getBytes
```
public int getBytes()
```
    Get the number of bytes per value
    
    Returns:
    
    number of bytes
  - getBits
```
public int getBits()
```
    Get the number of bits per value
    
    Returns:
    
    number of bits
    
    Since:
    
    2.0.0
  - getFieldType
```
public static FieldType getFieldType(int fieldType)
```
    Get the field type
    
    Parameters:
    
    fieldType - field type number
    
    Returns:
    
    field type
  - getFieldType
```
public static FieldType getFieldType(int sampleFormat,
                                     int bitsPerSample)
```
    Get the field type of the sample format and bits per sample
    
    Parameters:
    
    sampleFormat - sample format
    
    bitsPerSample - bits per sample
    
    Returns:
    
    field type
    
    Since:
    
    2.0.0
  - getSampleFormat
```
public static int getSampleFormat(FieldType fieldType)
```
    Get the sample format of the field type
    
    Parameters:
    
    fieldType - field type
    
    Returns:
    
    sample format
    
    Since:
    
    2.0.0

Enum FieldType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BYTE

ASCII

SHORT

LONG

RATIONAL

SBYTE

UNDEFINED

SSHORT

SLONG

SRATIONAL

FLOAT

DOUBLE

Method Detail

values

valueOf

getValue

getBytes

getBits

getFieldType

getFieldType

getSampleFormat