OpenJDK 27 · javax.imageio.plugins.tiff.TIFFTag · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private int	count
private int	dataTypes
private static final int	DISALLOWED_DATATYPES_MASK Disallowed data type mask.
public static final int	MAX_DATATYPE The numerically largest constant representing a TIFF data type.
public static final int	MIN_DATATYPE The numerically smallest constant representing a TIFF data type.
private String	name
private int	number
private static final int[]	SIZE_OF_TYPE
private TIFFTagSet	tagSet
public static final int	TIFF_ASCII Flag for null-terminated ASCII strings.
public static final int	TIFF_BYTE Flag for 8 bit unsigned integers.
public static final int	TIFF_DOUBLE Flag for 64 bit IEEE doubles.
public static final int	TIFF_FLOAT Flag for 32 bit IEEE floats.
public static final int	TIFF_IFD_POINTER Flag for IFD pointer defined in TIFF Tech Note 1 in TIFF Specification Supplement 1.
public static final int	TIFF_LONG Flag for 32 bit unsigned integers.
public static final int	TIFF_RATIONAL Flag for pairs of 32 bit unsigned integers.
public static final int	TIFF_SBYTE Flag for 8 bit signed integers.
public static final int	TIFF_SHORT Flag for 16 bit unsigned integers.
public static final int	TIFF_SLONG Flag for 32 bit signed integers.
public static final int	TIFF_SRATIONAL Flag for pairs of 32 bit signed integers.
public static final int	TIFF_SSHORT Flag for 16 bit signed integers.
public static final int	TIFF_UNDEFINED Flag for 8 bit uninterpreted bytes.
public static final String	UNKNOWN_TAG_NAME The name assigned to a tag with an unknown tag number.
private SortedMap<Integer, String>	valueNames

Constructor Summary

Access	Constructor and Description
public	TIFFTag(String the name of the tag. name, int the number used to represent the tag. number, int a bit mask indicating the set of legal data types for this tag. dataTypes, int the value count for this tag. count) Constructs a `TIFFTag` with a given name, tag number, set of legal data types, and value count.
public	TIFFTag(String the name of the tag. name, int the number used to represent the tag. number, TIFFTagSet the `TIFFTagSet` to which this tag belongs. tagSet) Constructs a `TIFFTag` with a given name, tag number and `TIFFTagSet` to which it refers.
public	TIFFTag(String the name of the tag. name, int the number used to represent the tag. number, int a bit mask indicating the set of legal data types for this tag. dataTypes) Constructs a `TIFFTag` with a given name, tag number, and set of legal data types.

Method Summary

Modifier and Type	Method and Description
protected void	addValueName(int the data value. value, String the name to associate with the value. name) Adds a mnemonic name for a particular value that this tag's data may take on.
public int	Returns: the value count of this tag. getCount() Returns the value count of this tag.
public int	Returns: an `int` containing a bitmask encoding the set of valid data types. getDataTypes() Returns a bit mask indicating the set of data types that may be used to store the data associated with the tag.
public String	Returns: the tag name, as a `String`. getName() Returns the name of the tag, as it will appear in image metadata.
public int[]	Returns: the values for which there is a mnemonic name. getNamedValues() Returns an array of values for which mnemonic names are defined.
public int	Returns: the tag number, as an `int`. getNumber() Returns the integer used to represent the tag.
public static int	Returns: the number of bytes used to store the given data type. getSizeOfType(int the data type to be queried. dataType) Returns the number of bytes used to store a value of the given data type.
public TIFFTagSet	Returns: the containing `TIFFTagSet`. getTagSet() Returns the `TIFFTagSet` of which this tag is a part.
public String	Returns: the mnemonic name associated with the value, as a `String`. getValueName(int the data value. value) Returns the mnemonic name associated with a particular value that this tag's data may take on, or `null` if no name is present.
public boolean	Returns: `true` if mnemonic value names are available. hasValueNames() Returns `true` if there are mnemonic names associated with the set of legal values for the data associated with this tag.
public boolean	Returns: a `boolean` indicating whether the given data type may be used with this tag. isDataTypeOK(int the data type to be queried, one of `TIFF_BYTE`, `TIFF_SHORT`, etc. dataType) Returns `true` if the given data type may be used for the data associated with this tag.
public boolean	Returns: `true` if this tag points to an IFD. isIFDPointer() Returns `true` if this tag is used to point to an IFD structure containing additional tags.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

count	back to summary
private int count

dataTypes	back to summary
private int dataTypes

DISALLOWED_DATATYPES_MASK	back to summary
private static final int DISALLOWED_DATATYPES_MASK Disallowed data type mask.

MAX_DATATYPE	back to summary
public static final int MAX_DATATYPE The numerically largest constant representing a TIFF data type.

MIN_DATATYPE	back to summary
public static final int MIN_DATATYPE The numerically smallest constant representing a TIFF data type.

name	back to summary
private String name

number	back to summary
private int number

SIZE_OF_TYPE	back to summary
private static final int[] SIZE_OF_TYPE

tagSet	back to summary
private TIFFTagSet tagSet

TIFF_ASCII	back to summary
public static final int TIFF_ASCII Flag for null-terminated ASCII strings.

TIFF_BYTE	back to summary
public static final int TIFF_BYTE Flag for 8 bit unsigned integers.

TIFF_DOUBLE	back to summary
public static final int TIFF_DOUBLE Flag for 64 bit IEEE doubles.

TIFF_FLOAT	back to summary
public static final int TIFF_FLOAT Flag for 32 bit IEEE floats.

TIFF_IFD_POINTER	back to summary
public static final int TIFF_IFD_POINTER Flag for IFD pointer defined in TIFF Tech Note 1 in TIFF Specification Supplement 1.

TIFF_LONG	back to summary
public static final int TIFF_LONG Flag for 32 bit unsigned integers.

TIFF_RATIONAL	back to summary
public static final int TIFF_RATIONAL Flag for pairs of 32 bit unsigned integers.

TIFF_SBYTE	back to summary
public static final int TIFF_SBYTE Flag for 8 bit signed integers.

TIFF_SHORT	back to summary
public static final int TIFF_SHORT Flag for 16 bit unsigned integers.

TIFF_SLONG	back to summary
public static final int TIFF_SLONG Flag for 32 bit signed integers.

TIFF_SRATIONAL	back to summary
public static final int TIFF_SRATIONAL Flag for pairs of 32 bit signed integers.

TIFF_SSHORT	back to summary
public static final int TIFF_SSHORT Flag for 16 bit signed integers.

TIFF_UNDEFINED	back to summary
public static final int TIFF_UNDEFINED Flag for 8 bit uninterpreted bytes.

UNKNOWN_TAG_NAME	back to summary
public static final String UNKNOWN_TAG_NAME The name assigned to a tag with an unknown tag number. Such a tag may be created for example when reading an IFD and a tag number is encountered which is not in any of the `TIFFTagSet`s known to the reader.

valueNames	back to summary
private SortedMap<Integer, String> valueNames

Constructor Detail

TIFFTag back to summary

TIFFTag	back to summary
public TIFFTag(String name, int number, int dataTypes, int count) Constructs a `TIFFTag` with a given name, tag number, set of legal data types, and value count. A negative value count signifies that either an arbitrary number of values is legal or the required count is determined by the values of other fields in the IFD. A non-negative count specifies the number of values which an associated field must contain. The tag will have no associated `TIFFTagSet`. If there are mnemonic names to be associated with the legal data values for the tag, `addValueName()` should be called on the new instance for each name. Mnemonic names apply only to tags which have integral data type. See the documentation for `getDataTypes()` for an explanation of how the set of data types is to be converted into a bit mask. Parameters name:String the name of the tag. number:int the number used to represent the tag. dataTypes:int a bit mask indicating the set of legal data types for this tag. count:int the value count for this tag. Exceptions NullPointerException: if name is null. IllegalArgumentException: if number is negative or dataTypes is negative or specifies an out of range type.

public TIFFTag(String name, int number, int dataTypes, int count)

Constructs a TIFFTag with a given name, tag number, set of legal data types, and value count. A negative value count signifies that either an arbitrary number of values is legal or the required count is determined by the values of other fields in the IFD. A non-negative count specifies the number of values which an associated field must contain. The tag will have no associated TIFFTagSet.

If there are mnemonic names to be associated with the legal data values for the tag, addValueName() should be called on the new instance for each name. Mnemonic names apply only to tags which have integral data type.

See the documentation for getDataTypes() for an explanation of how the set of data types is to be converted into a bit mask.

Parameters

name:String: the name of the tag.
number:int: the number used to represent the tag.
dataTypes:int: a bit mask indicating the set of legal data types for this tag.
count:int: the value count for this tag.

Exceptions

NullPointerException:: if name is null.
IllegalArgumentException:: if number is negative or dataTypes is negative or specifies an out of range type.

TIFFTag back to summary

TIFFTag	back to summary
public TIFFTag(String name, int number, TIFFTagSet tagSet) Constructs a `TIFFTag` with a given name, tag number and `TIFFTagSet` to which it refers. The legal data types are set to include `TIFF_LONG` and `TIFF_IFD_POINTER` and the value count is unity. The `TIFFTagSet` will represent the set of `TIFFTag`s which appear in the IFD pointed to. A `TIFFTag` represents an IFD pointer if and only if `tagSet` is non-`null` or the data type `TIFF_IFD_POINTER` is legal. Parameters name:String the name of the tag. number:int the number used to represent the tag. tagSet:TIFFTagSet the `TIFFTagSet` to which this tag belongs. Exceptions NullPointerException: if name or tagSet is null. IllegalArgumentException: if number is negative. See Also `TIFFTag(String, int, int, int)`

public TIFFTag(String name, int number, TIFFTagSet tagSet)

Constructs a TIFFTag with a given name, tag number and TIFFTagSet to which it refers. The legal data types are set to include TIFF_LONG and TIFF_IFD_POINTER and the value count is unity. The TIFFTagSet will represent the set of TIFFTags which appear in the IFD pointed to. A TIFFTag represents an IFD pointer if and only if tagSet is non-null or the data type TIFF_IFD_POINTER is legal.

Parameters

name:String: the name of the tag.
number:int: the number used to represent the tag.
tagSet:TIFFTagSet: the TIFFTagSet to which this tag belongs.

Exceptions

NullPointerException:: if name or tagSet is null.
IllegalArgumentException:: if number is negative.

See Also

TIFFTag(String, int, int, int)

TIFFTag back to summary

TIFFTag	back to summary
public TIFFTag(String name, int number, int dataTypes) Constructs a `TIFFTag` with a given name, tag number, and set of legal data types. The value count of the tag will be undefined and it will have no associated `TIFFTagSet`. Parameters name:String the name of the tag. number:int the number used to represent the tag. dataTypes:int a bit mask indicating the set of legal data types for this tag. Exceptions NullPointerException: if name is null. IllegalArgumentException: if number is negative or dataTypes is negative or specifies an out of range type. See Also `TIFFTag(String, int, int, int)`

public TIFFTag(String name, int number, int dataTypes)

Constructs a TIFFTag with a given name, tag number, and set of legal data types. The value count of the tag will be undefined and it will have no associated TIFFTagSet.

Parameters

name:String: the name of the tag.
number:int: the number used to represent the tag.
dataTypes:int: a bit mask indicating the set of legal data types for this tag.

Exceptions

NullPointerException:: if name is null.
IllegalArgumentException:: if number is negative or dataTypes is negative or specifies an out of range type.

See Also

TIFFTag(String, int, int, int)

Method Detail

addValueName	back to summary
protected void addValueName(int value, String name) Adds a mnemonic name for a particular value that this tag's data may take on. Mnemonic names apply only to tags which have integral data type. Parameters value:int the data value. name:String the name to associate with the value.

addValueName

back to summary

protected void addValueName(int value, String name)

Adds a mnemonic name for a particular value that this tag's data may take on. Mnemonic names apply only to tags which have integral data type.

Parameters

value:int: the data value.
name:String: the name to associate with the value.

getCount back to summary

getCount	back to summary
public int getCount() Returns the value count of this tag. If this value is positive, it represents the required number of values for a `TIFFField` which has this tag. If the value is negative, the count is undefined. In the latter case the count may be derived, e.g., the number of values of the `BitsPerSample` field is `SamplesPerPixel`, or it may be variable as in the case of most `US-ASCII` fields. Returns:int the value count of this tag.

public int getCount()

Returns the value count of this tag. If this value is positive, it represents the required number of values for a TIFFField which has this tag. If the value is negative, the count is undefined. In the latter case the count may be derived, e.g., the number of values of the BitsPerSample field is SamplesPerPixel, or it may be variable as in the case of most US-ASCII fields.

Returns:int: the value count of this tag.

getDataTypes back to summary

getDataTypes	back to summary
public int getDataTypes() Returns a bit mask indicating the set of data types that may be used to store the data associated with the tag. For example, a tag that can store both SHORT and LONG values would return a value of: (1 << TIFFTag.TIFF_SHORT) \| (1 << TIFFTag.TIFF_LONG) Returns:int an `int` containing a bitmask encoding the set of valid data types.

public int getDataTypes()

Returns a bit mask indicating the set of data types that may be used to store the data associated with the tag. For example, a tag that can store both SHORT and LONG values would return a value of:

(1 << TIFFTag.TIFF_SHORT) | (1 << TIFFTag.TIFF_LONG)

Returns:int: an int containing a bitmask encoding the set of valid data types.

getName back to summary

getName	back to summary
public String getName() Returns the name of the tag, as it will appear in image metadata. Returns:String the tag name, as a `String`.

public String getName()

Returns the name of the tag, as it will appear in image metadata.

Returns:String: the tag name, as a String.

getNamedValues back to summary

getNamedValues	back to summary
public int[] getNamedValues() Returns an array of values for which mnemonic names are defined. The method `getValueName()` will return non-`null` only for values contained in the returned array. Mnemonic names apply only to tags which have integral data type. Returns:int[] the values for which there is a mnemonic name.

public int[] getNamedValues()

Returns an array of values for which mnemonic names are defined. The method getValueName() will return non-null only for values contained in the returned array. Mnemonic names apply only to tags which have integral data type.

Returns:int[]: the values for which there is a mnemonic name.

getNumber back to summary

getNumber	back to summary
public int getNumber() Returns the integer used to represent the tag. Returns:int the tag number, as an `int`.

public int getNumber()

Returns the integer used to represent the tag.

Returns:int: the tag number, as an int.

getSizeOfType back to summary

getSizeOfType	back to summary
public static int getSizeOfType(int dataType) Returns the number of bytes used to store a value of the given data type. Parameters dataType:int the data type to be queried. Returns:int the number of bytes used to store the given data type. Exceptions IllegalArgumentException: if `datatype` is less than `MIN_DATATYPE` or greater than `MAX_DATATYPE`.

public static int getSizeOfType(int dataType)

Returns the number of bytes used to store a value of the given data type.

Parameters

dataType:int: the data type to be queried.

Returns:int

the number of bytes used to store the given data type.

Exceptions

IllegalArgumentException:: if datatype is less than MIN_DATATYPE or greater than MAX_DATATYPE.

getTagSet back to summary

getTagSet	back to summary
public TIFFTagSet getTagSet() Returns the `TIFFTagSet` of which this tag is a part. Returns:TIFFTagSet the containing `TIFFTagSet`.

public TIFFTagSet getTagSet()

Returns the TIFFTagSet of which this tag is a part.

Returns:TIFFTagSet: the containing TIFFTagSet.

getValueName back to summary

getValueName	back to summary
public String getValueName(int value) Returns the mnemonic name associated with a particular value that this tag's data may take on, or `null` if no name is present. Mnemonic names apply only to tags which have integral data type. Parameters value:int the data value. Returns:String the mnemonic name associated with the value, as a `String`.

public String getValueName(int value)

Returns the mnemonic name associated with a particular value that this tag's data may take on, or null if no name is present. Mnemonic names apply only to tags which have integral data type.

Parameters

value:int: the data value.

Returns:String

the mnemonic name associated with the value, as a String.

hasValueNames back to summary

hasValueNames	back to summary
public boolean hasValueNames() Returns `true` if there are mnemonic names associated with the set of legal values for the data associated with this tag. Mnemonic names apply only to tags which have integral data type. Returns:boolean `true` if mnemonic value names are available.

public boolean hasValueNames()

Returns true if there are mnemonic names associated with the set of legal values for the data associated with this tag. Mnemonic names apply only to tags which have integral data type.

Returns:boolean: true if mnemonic value names are available.

isDataTypeOK back to summary

isDataTypeOK	back to summary
public boolean isDataTypeOK(int dataType) Returns `true` if the given data type may be used for the data associated with this tag. Parameters dataType:int the data type to be queried, one of `TIFF_BYTE`, `TIFF_SHORT`, etc. Returns:boolean a `boolean` indicating whether the given data type may be used with this tag. Exceptions IllegalArgumentException: if `datatype` is less than `MIN_DATATYPE` or greater than `MAX_DATATYPE`.

public boolean isDataTypeOK(int dataType)

Returns true if the given data type may be used for the data associated with this tag.

Parameters

dataType:int: the data type to be queried, one of TIFF_BYTE, TIFF_SHORT, etc.

Returns:boolean

a boolean indicating whether the given data type may be used with this tag.

Exceptions

IllegalArgumentException:: if datatype is less than MIN_DATATYPE or greater than MAX_DATATYPE.

isIFDPointer back to summary

isIFDPointer	back to summary
public boolean isIFDPointer() Returns `true` if this tag is used to point to an IFD structure containing additional tags. A `TIFFTag` represents an IFD pointer if and only if its `TIFFTagSet` is non-`null` or the data type `TIFF_IFD_POINTER` is legal. This condition will be satisfied if and only if either `getTagSet() != null` or `isDataTypeOK(TIFF_IFD_POINTER) == true`. Many TIFF extensions use the IFD mechanism in order to limit the number of new tags that may appear in the root IFD. Returns:boolean `true` if this tag points to an IFD.

public boolean isIFDPointer()

Returns true if this tag is used to point to an IFD structure containing additional tags. A TIFFTag represents an IFD pointer if and only if its TIFFTagSet is non-null or the data type TIFF_IFD_POINTER is legal. This condition will be satisfied if and only if either getTagSet() != null or isDataTypeOK(TIFF_IFD_POINTER) == true.

Many TIFF extensions use the IFD mechanism in order to limit the number of new tags that may appear in the root IFD.

Returns:boolean: true if this tag points to an IFD.

public Class TIFFTag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail