APIdia Launch Partner
Top Description Fields Constructors Methods
javax.imageio.plugins.tiff

public Class TIFFTagSet

extends Object
Class Inheritance
Known Direct Subclasses
javax.imageio.plugins.tiff.BaselineTIFFTagSet, javax.imageio.plugins.tiff.ExifGPSTagSet, javax.imageio.plugins.tiff.ExifInteroperabilityTagSet, javax.imageio.plugins.tiff.ExifParentTIFFTagSet, javax.imageio.plugins.tiff.ExifTIFFTagSet, javax.imageio.plugins.tiff.FaxTIFFTagSet, javax.imageio.plugins.tiff.GeoTIFFTagSet
Imports
java.util.Collections, .Iterator, .List, .Set, .SortedMap, .SortedSet, .TreeMap, .TreeSet
A class representing a set of TIFF tags. Each tag in the set must have a unique number (this is a limitation of the TIFF specification itself).

This class and its subclasses are responsible for mapping between raw tag numbers and TIFFTag objects, which contain additional information about each tag, such as the tag's name, legal data types, and mnemonic names for some or all of its data values.

Since
9
See Also
TIFFTag

Field Summary

Modifier and TypeField and Description
private SortedMap<String, TIFFTag>
allowedTagsByName

private SortedMap<Integer, TIFFTag>
allowedTagsByNumber

Constructor Summary

AccessConstructor and Description
private
TIFFTagSet()

Constructs a TIFFTagSet.

public
TIFFTagSet(List<TIFFTag>
a List object containing TIFFTag objects to be added to this tag set.
tags)

Constructs a TIFFTagSet, given a List of TIFFTag objects.

Method Summary

Modifier and TypeMethod and Description
public TIFFTag

Returns:

the numbered TIFFTag, or null.
getTag(int
the number of the tag to be retrieved.
tagNumber)

Returns the TIFFTag from this set that is associated with the given tag number, or null if no tag exists for that number.

public TIFFTag

Returns:

the named TIFFTag, or null.
getTag(String
the name of the tag to be retrieved, as a String.
tagName)

Returns the TIFFTag having the given tag name, or null if the named tag does not belong to this tag set.

public SortedSet<String>

Returns:

All tag names in this set.
getTagNames()

Retrieves an unmodifiable lexicographically increasing set of tag names.

public SortedSet<Integer>

Returns:

All tag numbers in this set.
getTagNumbers()

Retrieves an unmodifiable numerically increasing set of tag numbers.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

allowedTagsByNameback to summary
private SortedMap<String, TIFFTag> allowedTagsByName
allowedTagsByNumberback to summary
private SortedMap<Integer, TIFFTag> allowedTagsByNumber

Constructor Detail

TIFFTagSetback to summary
private TIFFTagSet()

Constructs a TIFFTagSet.

TIFFTagSetback to summary
public TIFFTagSet(List<TIFFTag> tags)

Constructs a TIFFTagSet, given a List of TIFFTag objects.

Parameters
tags:List<TIFFTag>

a List object containing TIFFTag objects to be added to this tag set.

Exceptions
IllegalArgumentException:
if tags is null, or contains objects that are not instances of the TIFFTag class.

Method Detail

getTagback to summary
public TIFFTag getTag(int tagNumber)

Returns the TIFFTag from this set that is associated with the given tag number, or null if no tag exists for that number.

Parameters
tagNumber:int

the number of the tag to be retrieved.

Returns:TIFFTag

the numbered TIFFTag, or null.

getTagback to summary
public TIFFTag getTag(String tagName)

Returns the TIFFTag having the given tag name, or null if the named tag does not belong to this tag set.

Parameters
tagName:String

the name of the tag to be retrieved, as a String.

Returns:TIFFTag

the named TIFFTag, or null.

Exceptions
IllegalArgumentException:
if tagName is null.
getTagNamesback to summary
public SortedSet<String> getTagNames()

Retrieves an unmodifiable lexicographically increasing set of tag names.

The returned object is unmodifiable and contains the tag names of all TIFFTags in this TIFFTagSet sorted into ascending order according to String#compareTo(Object).

Returns:SortedSet<String>

All tag names in this set.

getTagNumbersback to summary
public SortedSet<Integer> getTagNumbers()

Retrieves an unmodifiable numerically increasing set of tag numbers.

The returned object is unmodifiable and contains the tag numbers of all TIFFTags in this TIFFTagSet sorted into ascending order according to Integer#compareTo(Object).

Returns:SortedSet<Integer>

All tag numbers in this set.