Generated by
JDiff

com.itextpdf.io.codec Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.io.codec as colored differences. Deletions are shown like this , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.

Class TIFFDirectory, constructor TIFFDirectory(RandomAccessFileOrArray, int)

Constructs a TIFFDirectory from a SeekableStream. The directory parameter specifies which directory to read from the linked list present in the stream; directory 0 is normally read but it is possible to store multiple images in a single TIFF file by maintaining multiple directories. @param stream a SeekableStream to read from. @param directory the index of the directory to read. @throws java.io.IOException in case of any I/O java error. io.IOException
Class TIFFDirectory, constructor TIFFDirectory(RandomAccessFileOrArray, long, int)

Constructs a TIFFDirectory by reading a SeekableStream. The ifd_offset parameter specifies the stream offset from which to begin reading; this mechanism is sometimes used to store private IFDs within a TIFF file that are not part of the normal sequence of IFDs. @param stream a SeekableStream to read from. @param ifd_offset the long byte offset of the directory. @param directory the index of the directory to read beyond the one at the current stream offset; zero indicates the IFD at the current offset. @throws java.io.IOException in case of any I/O error.
Class TIFFDirectory, long getIFDOffset()

Returns the offset of the IFD corresponding to this this TIFFDirectory. @return the offset of the IFD corresponding to this TIFFDirectory.
Class TIFFDirectory, long getNextIFDOffset()

Returns the offset of the next IFD after the IFD corresponding to this TIFFDirectory. @return the offset of the next IFD after the IFD corresponding to this TIFFDirectory.
Class TIFFDirectory, int getNumDirectories(RandomAccessFileOrArray)

Returns the number of image directories (subimages) stored in a given TIFF file, represented by a SeekableStream. @param stream RandomAccessFileOrArray @return The number of image directories (subimages) stored in a given TIFF file @throws java.io.IOException in case of any I/O error.
Class TIFFDirectory, boolean isBigEndian()

Returns a boolean indicating whether the byte order used in the the TIFF file is big-endian (i.e. whether the byte order is from the most significant to the least significant) @return {@code true} if the byte order used in the TIFF file is big-endian

Class TIFFField, constructor TIFFField(int, int, int, Object)

Constructs a TIFFField with arbitrary data. The data parameter must be an array of a Java type appropriate for the type of the TIFF field. Since there is no available 32-bit unsigned data type, long is used. The mapping between types is as follows:
TIFF type Java type
TIFF_BYTE byte
TIFF_ASCII String
TIFF_SHORT char
TIFF_LONG long
TIFF_RATIONAL long[2]
TIFF_SBYTE byte
TIFF_UNDEFINED byte
TIFF_SSHORT short
TIFF_SLONG int
TIFF_SRATIONAL int[2]
TIFF_FLOAT float
TIFF_DOUBLE double
@param tag The the tag tag number @param type the tag type @param count count the number of data items present in the field @param data the field data
Class TIFFField, double getAsDouble(int)

Returns data in any numerical format as a float double. Data in TIFF_SRATIONAL or TIFF_RATIONAL format are evaluated by dividing the numerator into the denominator using double-precision arithmetic.

A ClassCastException will be thrown if the field is of type TIFF_UNDEFINED or TIFF_ASCII. @param index The index index @return data in any numerical format as a double.

Class TIFFField, double[] getAsDoubles()

Returns TIFF_DOUBLE data as an array of doubles.

A ClassCastException will be thrown if the field is not of type TIFF_DOUBLE. @return TIFF_DOUBLE data as an array of doubles.

Class TIFFField, float getAsFloat(int)

Returns data in any numerical format as a float. Data in TIFF_SRATIONAL or TIFF_RATIONAL format are evaluated by dividing the numerator into the denominator using double-precision arithmetic and then truncating to single precision. Data in TIFF_SLONG, TIFF_LONG, or TIFF_DOUBLE format may suffer from truncation.

A ClassCastException will be thrown if the field is of type TIFF_UNDEFINED or TIFF_ASCII. @param index The index index @return data in any numerical format as a float.

Class TIFFField, float[] getAsFloats()

Returns TIFF_FLOAT data as an array of floats.

A ClassCastException will be thrown if the field is not of type TIFF_FLOAT. @return TIFF_FLOAT data as an array of floats.

Class TIFFField, int getAsInt(int)

Returns data in TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED, TIFF_SHORT, TIFF_SSHORT, or TIFF_SLONG format as an int.

TIFF_BYTE and TIFF_UNDEFINED data are treated as unsigned; that is, no sign extension will take place and the returned value will be in the range [0, 255]. TIFF_SBYTE data will be returned in the range [-128, 127].

A ClassCastException will be thrown if the field is not of type TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED, TIFF_SHORT, TIFF_SSHORT, or TIFF_SLONG. @param index The index index @return data in TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED, TIFF_SHORT, TIFF_SSHORT, or TIFF_SLONG format as an int.

Class TIFFField, int[] getAsInts()

Returns TIFF_SLONG data as an array of ints (signed 32-bit integers).

A ClassCastException will be thrown if the field is not of type TIFF_SLONG. @return TIFF_SLONG data as an array of ints (signed 32-bit integers).

Class TIFFField, long getAsLong(int)

Returns data in TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED, TIFF_SHORT, TIFF_SSHORT, TIFF_SLONG, or TIFF_LONG format as a long.

TIFF_BYTE and TIFF_UNDEFINED data are treated as unsigned; that is, no sign extension will take place and the returned value will be in the range [0, 255]. TIFF_SBYTE data will be returned in the range [-128, 127].

A ClassCastException will be thrown if the field is not of type TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED, TIFF_SHORT, TIFF_SSHORT, TIFF_SLONG, or TIFF_LONG. @param index The index index @return data in TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED, TIFF_SHORT, TIFF_SSHORT, TIFF_SLONG, or TIFF_LONG format as a long.

Class TIFFField, long[] getAsLongs()

Returns TIFF_LONG data as an array of longs (signed 64-bit integers).

A ClassCastException will be thrown if the field is not of type TIFF_LONG. @return TIFF_LONG data as an array of longs (signed 64-bit integers).

Class TIFFField, long[] getAsRational(int)

Returns a TIFF_RATIONAL data item as a two-element array of ints.

A ClassCastException will be thrown if the field is not of type TIFF_RATIONAL. @param index The index index @return a TIFF_RATIONAL data item as a two-element array of ints

Class TIFFField, long[][] getAsRationals()

Returns TIFF_RATIONAL data as an array of 2-element arrays of longs.

A ClassCastException will be thrown if the field is not of type TIFF_RATTIONAL. @return TIFF_RATIONAL data as an array of 2-element arrays of longs.

Class TIFFField, int[] getAsSRational(int)

Returns a TIFF_SRATIONAL data item as a two-element array of ints.

A ClassCastException will be thrown if the field is not of type TIFF_SRATIONAL. @param index The index index @return a TIFF_SRATIONAL data item as a two-element array of ints.

Class TIFFField, int[][] getAsSRationals()

Returns TIFF_SRATIONAL data as an array of 2-element arrays of ints.

A ClassCastException will be thrown if the field is not of type TIFF_SRATIONAL. @return TIFF_SRATIONAL data as an array of 2-element arrays of ints.

Class TIFFField, short[] getAsShorts()

Returns TIFF_SSHORT data as an array of shorts (signed 16-bit integers).

A ClassCastException will be thrown if the field is not of type TIFF_SSHORT. @return TIFF_SSHORT data as an array of shorts (signed 16-bit integers).

Class TIFFField, String getAsString(int)

Returns a TIFF_ASCII data item as a String.

A ClassCastException will be thrown if the field is not of type TIFF_ASCII. @param index The index index @return a TIFF_ASCII data item as a String.

Class TIFFField, String[] getAsStrings()

Returns TIFF_ASCII data as an array of strings.

A ClassCastException will be thrown if the field is not of type TIFF_ASCII. @return TIFF_ASCII data as an array of strings.


Class TIFFLZWDecoder, void addStringToTable(byte[])

Add a new string to the string table. @param str the byte string which will be added to the string table
Class TIFFLZWDecoder, void addStringToTable(byte[], byte)

Add a new string to the string table. @param oldString oldString the byte string at the end of which the new string will be written and which will be added to the string table @param newString the byte to be written to the end of the old string
Class TIFFLZWDecoder, byte[] composeString(byte[], byte)

Append newString to the end of oldString. @param oldString oldString the byte string at the end of which the new string will be written @param newString the byte to be written to the end of the old string @return the byte string which is the sum of the new string and the old string
Class TIFFLZWDecoder, byte[] decode(byte[], byte[], int)

Method to decode LZW compressed data. @param data The compressed data. data @param uncompData Array to return the uncompressed data in. in @param h The number of rows the compressed data contains. contains @return The decoded data
Class TIFFLZWDecoder, void writeString(byte[])

Write out the string just uncompressed. @param str the byte string for uncompressed write out