Class TIFFTagSet
- java.lang.Object
-
- com.github.jaiimageio.plugins.tiff.TIFFTagSet
-
- Direct Known Subclasses:
BaselineTIFFTagSet
,EXIFGPSTagSet
,EXIFInteroperabilityTagSet
,EXIFParentTIFFTagSet
,EXIFTIFFTagSet
,FaxTIFFTagSet
,GeoTIFFTagSet
public class TIFFTagSet extends java.lang.Object
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 ts data values.- See Also:
TIFFTag
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.SortedMap
allowedTagsByName
private java.util.SortedMap
allowedTagsByNumber
-
Constructor Summary
Constructors Modifier Constructor Description private
TIFFTagSet()
Constructs a TIFFTagSet.TIFFTagSet(java.util.List tags)
Constructs aTIFFTagSet
, given aList
ofTIFFTag
objects.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TIFFTag
getTag(int tagNumber)
Returns theTIFFTag
from this set that is associated with the given tag number, ornull
if no tag exists for that number.TIFFTag
getTag(java.lang.String tagName)
Returns theTIFFTag
having the given tag name, ornull
if the named tag does not belong to this tag set.java.util.SortedSet
getTagNames()
Retrieves an unmodifiable lexicographically increasing set of tag names.java.util.SortedSet
getTagNumbers()
Retrieves an unmodifiable numerically increasing set of tag numbers.
-
-
-
Constructor Detail
-
TIFFTagSet
private TIFFTagSet()
Constructs a TIFFTagSet.
-
TIFFTagSet
public TIFFTagSet(java.util.List tags)
Constructs aTIFFTagSet
, given aList
ofTIFFTag
objects.- Parameters:
tags
- aList
object containingTIFFTag
objects to be added to this tag set.- Throws:
java.lang.IllegalArgumentException
- iftags
isnull
, or contains objects that are not instances of theTIFFTag
class.
-
-
Method Detail
-
getTag
public TIFFTag getTag(int tagNumber)
Returns theTIFFTag
from this set that is associated with the given tag number, ornull
if no tag exists for that number.- Parameters:
tagNumber
- the number of the tag to be retrieved.- Returns:
- the numbered
TIFFTag
, ornull
.
-
getTag
public TIFFTag getTag(java.lang.String tagName)
Returns theTIFFTag
having the given tag name, ornull
if the named tag does not belong to this tag set.- Parameters:
tagName
- the name of the tag to be retrieved, as aString
.- Returns:
- the named
TIFFTag
, ornull
. - Throws:
java.lang.IllegalArgumentException
- iftagName
isnull
.
-
getTagNumbers
public java.util.SortedSet getTagNumbers()
Retrieves an unmodifiable numerically increasing set of tag numbers.The returned object is unmodifiable and contains the tag numbers of all
TIFFTag
s in thisTIFFTagSet
sorted into ascending order according to {@linkInteger#compareTo(Object)
}.- Returns:
- All tag numbers in this set.
-
getTagNames
public java.util.SortedSet getTagNames()
Retrieves an unmodifiable lexicographically increasing set of tag names.The returned object is unmodifiable and contains the tag names of all
TIFFTag
s in thisTIFFTagSet
sorted into ascending order according to {@linkString#compareTo(Object)
}.- Returns:
- All tag names in this set.
-
-