org.apache.commons.imaging.formats.tiff.write

Class TiffOutputDirectory

java.lang.Object

org.apache.commons.imaging.formats.tiff.write.TiffOutputDirectory

public final class TiffOutputDirectory
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TiffOutputItem.Value

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<TiffOutputDirectory>	COMPARATOR
int	type
static long	UNDEFINED_VALUE

Constructor Summary

Constructors

Constructor and Description
TiffOutputDirectory(int type, java.nio.ByteOrder byteOrder)

Method Summary

Modifier and Type	Method and Description
void	add(TagInfoAsciiOrByte tagInfo, java.lang.String... values)
void	add(TagInfoAsciiOrRational tagInfo, RationalNumber... values)
void	add(TagInfoAsciiOrRational tagInfo, java.lang.String... values)
void	add(TagInfoAscii tagInfo, java.lang.String... values)
void	add(TagInfoByte tagInfo, byte... values)
void	add(TagInfoByteOrShort tagInfo, byte... values)
void	add(TagInfoByteOrShort tagInfo, short... values)
void	add(TagInfoDouble tagInfo, double... values)
void	add(TagInfoFloat tagInfo, float... values)
void	add(TagInfoGpsText tagInfo, java.lang.String value)
void	add(TagInfoLong tagInfo, int... values)
void	add(TagInfoRational tagInfo, RationalNumber... values)
void	add(TagInfoSByte tagInfo, byte... values)
void	add(TagInfoShortOrLong tagInfo, int... values)
void	add(TagInfoShortOrLongOrRational tagInfo, int... values)
void	add(TagInfoShortOrLongOrRational tagInfo, RationalNumber... values)
void	add(TagInfoShortOrLongOrRational tagInfo, short... values)
void	add(TagInfoShortOrLong tagInfo, short... values)
void	add(TagInfoShortOrRational tagInfo, RationalNumber... values)
void	add(TagInfoShortOrRational tagInfo, short... values)
void	add(TagInfoShort tagInfo, short... values)
void	add(TagInfoSLong tagInfo, int... values)
void	add(TagInfoSRational tagInfo, RationalNumber... values)
void	add(TagInfoSShort tagInfo, short... values)
void	add(TagInfoXpString tagInfo, java.lang.String value)
void	add(TiffOutputField field)
java.lang.String	description()
TiffOutputField	findField(int tag) Finds the TiffOutputField for the given tag from this TiffOutputDirectory.
TiffOutputField	findField(TagInfo tagInfo) Finds the TiffOutputField for the given TagInfo from this TiffOutputDirectory.
java.util.List<TiffOutputField>	getFields()
java.lang.String	getItemDescription()
int	getItemLength()
JpegImageData	getRawJpegImageData()
TiffImageData	getRawTiffImageData()
void	removeField(int tag)
void	removeField(TagInfo tagInfo)
void	setJpegImageData(JpegImageData rawJpegImageData)
void	setNextDirectory(TiffOutputDirectory nextDirectory)
void	setTiffImageData(TiffImageData rawTiffImageData)
void	sortFields()
void	writeItem(BinaryOutputStream bos)

Methods inherited from class java.lang.Object

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

Field Detail

type

public final int type

COMPARATOR

public static final java.util.Comparator<TiffOutputDirectory> COMPARATOR

UNDEFINED_VALUE

public static final long UNDEFINED_VALUE

See Also:

Constant Field Values

Constructor Detail

TiffOutputDirectory

public TiffOutputDirectory(int type,
                           java.nio.ByteOrder byteOrder)

Method Detail

setNextDirectory

public void setNextDirectory(TiffOutputDirectory nextDirectory)

add

public void add(TagInfoByte tagInfo,
                byte... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoAscii tagInfo,
                java.lang.String... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoShort tagInfo,
                short... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoLong tagInfo,
                int... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoRational tagInfo,
                RationalNumber... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoSByte tagInfo,
                byte... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoSShort tagInfo,
                short... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoSLong tagInfo,
                int... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoSRational tagInfo,
                RationalNumber... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoFloat tagInfo,
                float... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoDouble tagInfo,
                double... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoByteOrShort tagInfo,
                byte... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoByteOrShort tagInfo,
                short... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoShortOrLong tagInfo,
                short... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoShortOrLong tagInfo,
                int... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoShortOrLongOrRational tagInfo,
                short... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoShortOrLongOrRational tagInfo,
                int... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoShortOrLongOrRational tagInfo,
                RationalNumber... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoShortOrRational tagInfo,
                short... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoShortOrRational tagInfo,
                RationalNumber... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoGpsText tagInfo,
                java.lang.String value)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoXpString tagInfo,
                java.lang.String value)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoAsciiOrByte tagInfo,
                java.lang.String... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoAsciiOrRational tagInfo,
                java.lang.String... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TagInfoAsciiOrRational tagInfo,
                RationalNumber... values)
         throws ImageWriteException

Throws:

ImageWriteException

add

public void add(TiffOutputField field)

getFields

public java.util.List<TiffOutputField> getFields()

removeField

public void removeField(TagInfo tagInfo)

removeField

public void removeField(int tag)

findField

public TiffOutputField findField(TagInfo tagInfo)

Finds the TiffOutputField for the given TagInfo from this TiffOutputDirectory.

If there is no field matching the given TagInfo, null will be returned.

Parameters:

tagInfo - the TagInfo specifying the field

Returns:

the field matching tagInfo or null, if the field isn't present

See Also:

findField(int)

findField

public TiffOutputField findField(int tag)

Finds the TiffOutputField for the given tag from this TiffOutputDirectory.

If there is no field matching the given tag, null will be returned.

Parameters:

tag - the tag specifying the field

Returns:

the field matching tagInfo or null, if the field isn't present

See Also:

findField(TagInfo)

sortFields

public void sortFields()

description

public java.lang.String description()

writeItem

public void writeItem(BinaryOutputStream bos)
               throws java.io.IOException,
                      ImageWriteException

Throws:

java.io.IOException

ImageWriteException

setJpegImageData

public void setJpegImageData(JpegImageData rawJpegImageData)

getRawJpegImageData

public JpegImageData getRawJpegImageData()

setTiffImageData

public void setTiffImageData(TiffImageData rawTiffImageData)

getRawTiffImageData

public TiffImageData getRawTiffImageData()

getItemLength

public int getItemLength()

getItemDescription

public java.lang.String getItemDescription()