Javadoc

Author: garydgregory

src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SofnSegment.java

@@ -29,6 +29,9 @@
 import org.apache.commons.imaging.common.Allocator;
 import org.apache.commons.imaging.formats.jpeg.JpegConstants;
 
+/**
+ * JPEG SOFn (Start of Frame) segment.
+ */
 public final class SofnSegment extends AbstractSegment {
 
     /**
@@ -95,6 +98,15 @@ public SofnSegment(final int marker, final byte[] segmentData) throws IOExceptio
         this(marker, segmentData.length, new ByteArrayInputStream(segmentData));
     }
 
+    /**
+     * Constructs a SOFn segment.
+     *
+     * @param marker the marker.
+     * @param markerLength the marker length.
+     * @param is the input stream.
+     * @throws IOException if an I/O error occurs.
+     * @throws ImagingException if an imaging error occurs.
+     */
     public SofnSegment(final int marker, final int markerLength, final InputStream is) throws IOException, ImagingException {
         super(marker, markerLength);
 

src/main/java/org/apache/commons/imaging/formats/jpeg/segments/SosSegment.java

@@ -26,6 +26,9 @@
 
 import org.apache.commons.imaging.common.Allocator;
 
+/**
+ * JPEG SOS (Start of Scan) segment.
+ */
 public final class SosSegment extends AbstractSegment {
 
     /**
@@ -89,6 +92,14 @@ public SosSegment(final int marker, final byte[] segmentData) throws IOException
         this(marker, segmentData.length, new ByteArrayInputStream(segmentData));
     }
 
+    /**
+     * Constructs a SOS segment.
+     *
+     * @param marker the marker.
+     * @param markerLength the marker length.
+     * @param is the input stream.
+     * @throws IOException if an I/O error occurs.
+     */
     public SosSegment(final int marker, final int markerLength, final InputStream is) throws IOException {
         super(marker, markerLength);
 

src/main/java/org/apache/commons/imaging/formats/tiff/itu_t4/T4AndT6Compression.java

@@ -23,12 +23,19 @@
 import org.apache.commons.imaging.common.Allocator;
 import org.apache.commons.imaging.formats.tiff.itu_t4.T4_T6_Tables.Entry;
 
+/**
+ * T4 and T6 compression implementation for TIFF.
+ */
 public final class T4AndT6Compression {
+
     private static final HuffmanTree<Integer> WHITE_RUN_LENGTHS = new HuffmanTree<>();
     private static final HuffmanTree<Integer> BLACK_RUN_LENGTHS = new HuffmanTree<>();
     private static final HuffmanTree<Entry> CONTROL_CODES = new HuffmanTree<>();
 
+    /** White color constant. */
     public static final int WHITE = 0;
+
+    /** Black color constant. */
     public static final int BLACK = 1;
 
     static {
@@ -165,6 +172,16 @@ private static int compressT(final int a0, final int a1, final int b1, final Bit
         return a2;
     }
 
+    /**
+     * Compresses data using T4 1D compression.
+     *
+     * @param uncompressed the uncompressed data.
+     * @param width the image width.
+     * @param height the image height.
+     * @param hasFill whether to use fill bits.
+     * @return the compressed data.
+     * @throws ImagingException if an imaging error occurs.
+     */
     public static byte[] compressT4_1D(final byte[] uncompressed, final int width, final int height, final boolean hasFill) throws ImagingException {
         final BitInputStreamFlexible inputStream = new BitInputStreamFlexible(new ByteArrayInputStream(uncompressed));
         try (BitArrayOutputStream outputStream = new BitArrayOutputStream()) {
@@ -194,6 +211,17 @@ public static byte[] compressT4_1D(final byte[] uncompressed, final int width, f
         }
     }
 
+    /**
+     * Compresses data using T4 2D compression.
+     *
+     * @param uncompressed the uncompressed data.
+     * @param width the image width.
+     * @param height the image height.
+     * @param hasFill whether to use fill bits.
+     * @param parameterK the K parameter.
+     * @return the compressed data.
+     * @throws ImagingException if an imaging error occurs.
+     */
     public static byte[] compressT4_2D(final byte[] uncompressed, final int width, final int height, final boolean hasFill, final int parameterK)
             throws ImagingException {
         final BitInputStreamFlexible inputStream = new BitInputStreamFlexible(new ByteArrayInputStream(uncompressed));
@@ -272,6 +300,15 @@ public static byte[] compressT4_2D(final byte[] uncompressed, final int width, f
         return outputStream.toByteArray();
     }
 
+    /**
+     * Compresses data using T6 compression.
+     *
+     * @param uncompressed the uncompressed data.
+     * @param width the image width.
+     * @param height the image height.
+     * @return the compressed data.
+     * @throws ImagingException if an imaging error occurs.
+     */
     public static byte[] compressT6(final byte[] uncompressed, final int width, final int height) throws ImagingException {
         try (ByteArrayInputStream bais = new ByteArrayInputStream(uncompressed);
                 BitInputStreamFlexible inputStream = new BitInputStreamFlexible(bais)) {

src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfo.java

@@ -28,36 +28,105 @@
 import org.apache.commons.imaging.formats.tiff.constants.TiffDirectoryType;
 import org.apache.commons.imaging.formats.tiff.fieldtypes.AbstractFieldType;
 
+/**
+ * Base class for TIFF tag information.
+ */
 public class TagInfo {
+
+    /** Constant for unknown length. */
     public static final int LENGTH_UNKNOWN = -1;
+
+    /** Tag name. */
     public final String name;
+
+    /** Tag number. */
     public final int tag;
+
+    /** Data types supported by this tag. */
     public final List<AbstractFieldType> dataTypes;
+
+    /** Expected length of tag data. */
     public final int length;
+
+    /** Directory type where this tag is expected. */
     public final TiffDirectoryType directoryType;
+
     private final boolean isOffset;
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param dataType the data type.
+     */
     public TagInfo(final String name, final int tag, final AbstractFieldType dataType) {
         this(name, tag, dataType, LENGTH_UNKNOWN, TiffDirectoryType.EXIF_DIRECTORY_UNKNOWN);
     }
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param dataType the data type.
+     * @param length the length.
+     */
     public TagInfo(final String name, final int tag, final AbstractFieldType dataType, final int length) {
         this(name, tag, Arrays.asList(dataType), length, TiffDirectoryType.EXIF_DIRECTORY_UNKNOWN);
     }
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param dataType the data type.
+     * @param length the length.
+     * @param exifDirectory the EXIF directory.
+     */
     public TagInfo(final String name, final int tag, final AbstractFieldType dataType, final int length, final TiffDirectoryType exifDirectory) {
         this(name, tag, Arrays.asList(dataType), length, exifDirectory);
     }
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param dataType the data type.
+     * @param length the length.
+     * @param exifDirectory the EXIF directory.
+     * @param isOffset whether this is an offset tag.
+     */
     public TagInfo(final String name, final int tag, final AbstractFieldType dataType, final int length, final TiffDirectoryType exifDirectory,
             final boolean isOffset) {
         this(name, tag, Arrays.asList(dataType), length, exifDirectory, isOffset);
     }
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param dataTypes the data types.
+     * @param length the length.
+     * @param exifDirectory the EXIF directory.
+     */
     public TagInfo(final String name, final int tag, final List<AbstractFieldType> dataTypes, final int length, final TiffDirectoryType exifDirectory) {
         this(name, tag, dataTypes, length, exifDirectory, false);
     }
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param dataTypes the data types.
+     * @param length the length.
+     * @param exifDirectory the EXIF directory.
+     * @param isOffset whether this is an offset tag.
+     */
     public TagInfo(final String name, final int tag, final List<AbstractFieldType> dataTypes, final int length, final TiffDirectoryType exifDirectory,
             final boolean isOffset) {
         this.name = name;
@@ -68,28 +137,53 @@ public TagInfo(final String name, final int tag, final List<AbstractFieldType> d
         this.isOffset = isOffset;
     }
 
+    /**
+     * Encodes a value.
+     *
+     * @param abstractFieldType the field type.
+     * @param value the value.
+     * @param byteOrder the byte order.
+     * @return the encoded bytes.
+     * @throws ImagingException if an imaging error occurs.
+     */
     public byte[] encodeValue(final AbstractFieldType abstractFieldType, final Object value, final ByteOrder byteOrder) throws ImagingException {
         return abstractFieldType.writeData(value, byteOrder);
     }
 
+    /**
+     * Gets the description.
+     *
+     * @return the description.
+     */
     public String getDescription() {
         return tag + " (0x" + Integer.toHexString(tag) + ": " + name + "): ";
     }
 
     /**
+     * Gets the value from a TIFF field.
      *
-     * @param entry the TIFF field whose value to return
-     * @return the value of the TIFF field
-     * @throws ImagingException thrown by subclasses
+     * @param entry the TIFF field whose value to return.
+     * @return the value of the TIFF field.
+     * @throws ImagingException thrown by subclasses.
      */
     public Object getValue(final TiffField entry) throws ImagingException {
         return entry.getFieldType().getValue(entry);
     }
 
+    /**
+     * Checks if this is an offset tag.
+     *
+     * @return true if this is an offset tag, false otherwise.
+     */
     public boolean isOffset() {
         return isOffset;
     }
 
+    /**
+     * Checks if this is a text tag.
+     *
+     * @return true if this is a text tag, false otherwise.
+     */
     public boolean isText() {
         return false;
     }

src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoAny.java

@@ -19,7 +19,19 @@
 import org.apache.commons.imaging.formats.tiff.constants.TiffDirectoryType;
 import org.apache.commons.imaging.formats.tiff.fieldtypes.AbstractFieldType;
 
+/**
+ * Tag info for any field type.
+ */
 public class TagInfoAny extends TagInfo {
+
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param length the length.
+     * @param directoryType the directory type.
+     */
     public TagInfoAny(final String name, final int tag, final int length, final TiffDirectoryType directoryType) {
         super(name, tag, AbstractFieldType.ANY, length, directoryType);
     }

src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoAscii.java

@@ -24,15 +24,42 @@
 import org.apache.commons.imaging.formats.tiff.constants.TiffDirectoryType;
 import org.apache.commons.imaging.formats.tiff.fieldtypes.AbstractFieldType;
 
+/**
+ * Tag info for ASCII field type.
+ */
 public class TagInfoAscii extends TagInfo {
+
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param length the length.
+     * @param directoryType the directory type.
+     */
     public TagInfoAscii(final String name, final int tag, final int length, final TiffDirectoryType directoryType) {
         super(name, tag, AbstractFieldType.ASCII, length, directoryType);
     }
 
+    /**
+     * Encodes values.
+     *
+     * @param byteOrder the byte order.
+     * @param values the values.
+     * @return the encoded bytes.
+     * @throws ImagingException if an imaging error occurs.
+     */
     public byte[] encodeValue(final ByteOrder byteOrder, final String... values) throws ImagingException {
         return AbstractFieldType.ASCII.writeData(values, byteOrder);
     }
 
+    /**
+     * Gets the value.
+     *
+     * @param byteOrder the byte order.
+     * @param bytes the bytes.
+     * @return the string array value.
+     */
     public String[] getValue(final ByteOrder byteOrder, final byte[] bytes) {
         int nullCount = 0;
         for (int i = 0; i < bytes.length - 1; i++) {

src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoAsciiOrByte.java

@@ -19,7 +19,19 @@
 import org.apache.commons.imaging.formats.tiff.constants.TiffDirectoryType;
 import org.apache.commons.imaging.formats.tiff.fieldtypes.AbstractFieldType;
 
+/**
+ * Tag info for ASCII or byte field type.
+ */
 public class TagInfoAsciiOrByte extends TagInfo {
+
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param length the length.
+     * @param directoryType the directory type.
+     */
     public TagInfoAsciiOrByte(final String name, final int tag, final int length, final TiffDirectoryType directoryType) {
         super(name, tag, AbstractFieldType.ASCII_OR_BYTE, length, directoryType, false);
     }

src/main/java/org/apache/commons/imaging/formats/tiff/taginfos/TagInfoAsciiOrRational.java

@@ -19,7 +19,19 @@
 import org.apache.commons.imaging.formats.tiff.constants.TiffDirectoryType;
 import org.apache.commons.imaging.formats.tiff.fieldtypes.AbstractFieldType;
 
+/**
+ * Tag info for ASCII or rational field type.
+ */
 public class TagInfoAsciiOrRational extends TagInfo {
+
+    /**
+     * Constructs a new instance.
+     *
+     * @param name the tag name.
+     * @param tag the tag number.
+     * @param length the length.
+     * @param directoryType the directory type.
+     */
     public TagInfoAsciiOrRational(final String name, final int tag, final int length, final TiffDirectoryType directoryType) {
         super(name, tag, AbstractFieldType.ASCII_OR_RATIONAL, length, directoryType, false);
     }