Package org.apache.commons.imaging.formats.tiff.fieldtypes

Class AbstractFieldType

java.lang.Object

org.apache.commons.imaging.formats.tiff.fieldtypes.AbstractFieldType

Direct Known Subclasses:

FieldTypeAscii, FieldTypeByte, FieldTypeDouble, FieldTypeFloat, FieldTypeLong, FieldTypeLong8, FieldTypeRational, FieldTypeShort

public abstract class AbstractFieldType
extends java.lang.Object

TIFF field types.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.List<AbstractFieldType>	ANY	Unmodifiable List of all field types.
static FieldTypeAscii	ASCII	ASCII field type.
static java.util.List<AbstractFieldType>	ASCII_OR_BYTE	Unmodifiable List of ASCII, BYTE field types.
static java.util.List<AbstractFieldType>	ASCII_OR_RATIONAL	Unmodifiable List of ASCII, RATIONAL field types.
static FieldTypeByte	BYTE	Byte field type.
static java.util.List<AbstractFieldType>	BYTE_OR_SHORT	Unmodifiable List of SHORT, BYTE field types.
static FieldTypeDouble	DOUBLE	Double field type.
private int	elementSize
static FieldTypeFloat	FLOAT	Float field type.
static FieldTypeLong	IFD	IFD field type.
static FieldTypeLong8	IFD8	IFD8 field type.
static FieldTypeLong	LONG	Long field type.
static java.util.List<AbstractFieldType>	LONG_OR_IFD	Unmodifiable List of LONG, IFD field types.
static java.util.List<AbstractFieldType>	LONG_OR_SHORT	Unmodifiable List of SHORT, LONG field types.
static FieldTypeLong8	LONG8	Long8 field type.
private java.lang.String	name
static FieldTypeRational	RATIONAL	Rational field type.
static FieldTypeByte	SBYTE	SByte field type.
static FieldTypeShort	SHORT	Short field type.
static java.util.List<AbstractFieldType>	SHORT_OR_LONG	Unmodifiable List of SHORT, LONG field types.
static java.util.List<AbstractFieldType>	SHORT_OR_LONG_OR_RATIONAL	Unmodifiable List of SHORT, LONG, RATIONAL field types.
static java.util.List<AbstractFieldType>	SHORT_OR_RATIONAL	Unmodifiable List of SHORT, RATIONAL field types.
static FieldTypeLong	SLONG	SLong field type.
static FieldTypeLong8	SLONG8	SLong8 field type.
static FieldTypeRational	SRATIONAL	SRational field type.
static FieldTypeShort	SSHORT	SShort field type.
private int	type
static FieldTypeByte	UNDEFINED	Undefined field type.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFieldType(int type, java.lang.String name, int elementSize)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
static AbstractFieldType	getFieldType(int type)	Gets a known field type.
java.lang.String	getName()	Gets the name.
int	getSize()	Gets the size.
int	getType()	Gets the type.
abstract java.lang.Object	getValue(TiffField entry)	Gets the value from a TIFF field.
abstract byte[]	writeData(java.lang.Object obj, java.nio.ByteOrder byteOrder)	Converts the given object to a byte array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BYTE

public static final FieldTypeByte BYTE

Byte field type.

ASCII

public static final FieldTypeAscii ASCII

ASCII field type.

SHORT

public static final FieldTypeShort SHORT

Short field type.

LONG

public static final FieldTypeLong LONG

Long field type.

RATIONAL

public static final FieldTypeRational RATIONAL

Rational field type.

SBYTE

public static final FieldTypeByte SBYTE

SByte field type.

UNDEFINED

public static final FieldTypeByte UNDEFINED

Undefined field type.

SSHORT

public static final FieldTypeShort SSHORT

SShort field type.

SLONG

public static final FieldTypeLong SLONG

SLong field type.

SRATIONAL

public static final FieldTypeRational SRATIONAL

SRational field type.

FLOAT

public static final FieldTypeFloat FLOAT

Float field type.

DOUBLE

public static final FieldTypeDouble DOUBLE

Double field type.

IFD

public static final FieldTypeLong IFD

IFD field type.

LONG8

public static final FieldTypeLong8 LONG8

Long8 field type.

SLONG8

public static final FieldTypeLong8 SLONG8

SLong8 field type.

IFD8

public static final FieldTypeLong8 IFD8

IFD8 field type.

ANY

public static final java.util.List<AbstractFieldType> ANY

Unmodifiable List of all field types.

SHORT_OR_LONG

public static final java.util.List<AbstractFieldType> SHORT_OR_LONG

Unmodifiable List of SHORT, LONG field types.

SHORT_OR_RATIONAL

public static final java.util.List<AbstractFieldType> SHORT_OR_RATIONAL

Unmodifiable List of SHORT, RATIONAL field types.

SHORT_OR_LONG_OR_RATIONAL

public static final java.util.List<AbstractFieldType> SHORT_OR_LONG_OR_RATIONAL

Unmodifiable List of SHORT, LONG, RATIONAL field types.

LONG_OR_SHORT

public static final java.util.List<AbstractFieldType> LONG_OR_SHORT

Unmodifiable List of SHORT, LONG field types.

BYTE_OR_SHORT

public static final java.util.List<AbstractFieldType> BYTE_OR_SHORT

Unmodifiable List of SHORT, BYTE field types.

LONG_OR_IFD

public static final java.util.List<AbstractFieldType> LONG_OR_IFD

Unmodifiable List of LONG, IFD field types.

ASCII_OR_RATIONAL

public static final java.util.List<AbstractFieldType> ASCII_OR_RATIONAL

Unmodifiable List of ASCII, RATIONAL field types.

ASCII_OR_BYTE

public static final java.util.List<AbstractFieldType> ASCII_OR_BYTE

Unmodifiable List of ASCII, BYTE field types.

type

private final int type

name

private final java.lang.String name

elementSize

private final int elementSize

Constructor Detail

AbstractFieldType

protected AbstractFieldType(int type,
                            java.lang.String name,
                            int elementSize)

Constructs a new instance.

Parameters:

type - the type.

name - the name.

elementSize - the element size.

Method Detail

getFieldType

public static AbstractFieldType getFieldType(int type)
                                      throws ImagingException

Gets a known field type.

Parameters:

type - the type to find.

Returns:

the matching field type.

Throws:

ImagingException - thrown when not found.

getName

public java.lang.String getName()

Gets the name.

Returns:

the name.

getSize

public int getSize()

Gets the size.

Returns:

the size.

getType

public int getType()

Gets the type.

Returns:

the type.

getValue

public abstract java.lang.Object getValue(TiffField entry)

Gets the value from a TIFF field.

Parameters:

entry - the TIFF field.

Returns:

the value.

writeData

public abstract byte[] writeData(java.lang.Object obj,
                                 java.nio.ByteOrder byteOrder)
                          throws ImagingException

Converts the given object to a byte array.

Parameters:

obj - input.

byteOrder - output byte order; not used by all subclasses.

Returns:

a byte array.

Throws:

ImagingException - Thrown on a bad input.