This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-imaging.git
The following commit(s) were added to refs/heads/master by this push:
new 233b5b2d Javadoc
233b5b2d is described below
commit 233b5b2d8aa4d9a243fb140d4ea44b21813bebfd
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jan 4 12:47:08 2026 -0500
Javadoc
Add an empty line before a Javadoc comment
---
.../org/apache/commons/imaging/ImageFormats.java | 22 +++++++++
.../java/org/apache/commons/imaging/ImageInfo.java | 23 +++++++++
.../commons/imaging/common/BasicCParser.java | 1 +
.../commons/imaging/common/ImageMetadata.java | 1 +
.../imaging/formats/jpeg/iptc/IptcRecord.java | 2 +
.../imaging/formats/jpeg/iptc/IptcType.java | 1 +
.../imaging/formats/jpeg/iptc/IptcTypes.java | 57 ++++++++++++++++++++++
.../imaging/formats/jpeg/segments/DqtSegment.java | 1 +
.../imaging/formats/pcx/PcxImageParser.java | 17 +++++++
.../imaging/formats/pcx/PcxImagingParameters.java | 1 +
.../imaging/formats/png/AbstractPngText.java | 2 +
.../commons/imaging/formats/png/Extension.java | 1 +
.../imaging/formats/png/InterlaceMethod.java | 1 +
.../imaging/formats/tiff/AbstractTiffElement.java | 1 +
.../imaging/formats/tiff/JpegImageData.java | 1 +
.../imaging/formats/tiff/TiffRasterDataType.java | 1 +
.../formats/tiff/constants/DngTagConstants.java | 21 ++++++++
.../formats/tiff/constants/GpsTagConstants.java | 3 ++
.../constants/MicrosoftHdPhotoTagConstants.java | 1 -
.../tiff/constants/TiffPlanarConfiguration.java | 1 +
.../formats/tiff/fieldtypes/FieldTypeAscii.java | 1 +
.../formats/tiff/fieldtypes/FieldTypeByte.java | 1 +
.../formats/tiff/fieldtypes/FieldTypeDouble.java | 1 +
.../formats/tiff/fieldtypes/FieldTypeFloat.java | 1 +
.../formats/tiff/fieldtypes/FieldTypeLong.java | 1 +
.../formats/tiff/fieldtypes/FieldTypeLong8.java | 1 +
.../formats/tiff/fieldtypes/FieldTypeRational.java | 1 +
.../formats/tiff/fieldtypes/FieldTypeShort.java | 1 +
.../PhotometricInterpreterRgb.java | 1 +
.../apache/commons/imaging/icc/IccProfileInfo.java | 13 +++++
.../org/apache/commons/imaging/icc/IccTag.java | 3 ++
.../imaging/examples/WriteExifMetadataExample.java | 1 +
.../formats/jpeg/specific/JpegImageParserTest.java | 1 +
33 files changed, 185 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/imaging/ImageFormats.java
b/src/main/java/org/apache/commons/imaging/ImageFormats.java
index 543e829c..1d3fa380 100644
--- a/src/main/java/org/apache/commons/imaging/ImageFormats.java
+++ b/src/main/java/org/apache/commons/imaging/ImageFormats.java
@@ -25,48 +25,70 @@ public enum ImageFormats implements ImageFormat {
/** Unknown image format. */
UNKNOWN("bin"),
+
/** BMP (Windows Bitmap) image format. */
BMP("bmp", "dib"),
+
/** DCX (ZSoft Multi-page Paintbrush) image format. */
DCX("dcx"),
+
/** GIF (Graphics Interchange Format) image format. */
GIF("gif"),
+
/** ICNS (Apple Icon Image) format. */
ICNS("icns"),
+
/** ICO (Windows Icon) image format. */
ICO("ico"),
+
/** JBIG2 image format. */
JBIG2("jbig2"),
+
/** JPEG (Joint Photographic Experts Group) image format. */
JPEG("jpg", "jpeg"),
+
/** PAM (Portable Arbitrary Map) image format. */
PAM("pam"),
+
/** PSD (Adobe Photoshop Document) image format. */
PSD("psd"),
+
/** PBM (Portable Bitmap) image format. */
PBM("pbm"),
+
/** PGM (Portable Graymap) image format. */
PGM("pgm"),
+
/** PNM (Portable Any Map) image format. */
PNM("pnm"),
+
/** PPM (Portable Pixmap) image format. */
PPM("ppm"),
+
/** PCX (PC Paintbrush) image format. */
PCX("pcx", "pcc"),
+
/** PNG (Portable Network Graphics) image format. */
PNG("png"),
+
/** RGBE (Radiance HDR) image format. */
RGBE("hdr", "pic"),
+
/** TGA (Truevision TGA/TARGA) image format. */
TGA("tga"),
+
/** TIFF (Tagged Image File Format). */
TIFF("tif", "tiff"),
+
/** WBMP (Wireless Bitmap) image format. */
WBMP("wbmp"),
+
/** WebP image format. */
WEBP("webp"),
+
/** XBM (X11 Bitmap) image format. */
XBM("xbm"),
+
/** XPM (X11 Pixmap) image format. */
XPM("xpm");
diff --git a/src/main/java/org/apache/commons/imaging/ImageInfo.java
b/src/main/java/org/apache/commons/imaging/ImageInfo.java
index 92fbb275..4d9da1bd 100644
--- a/src/main/java/org/apache/commons/imaging/ImageInfo.java
+++ b/src/main/java/org/apache/commons/imaging/ImageInfo.java
@@ -30,22 +30,31 @@ public class ImageInfo {
/** Color type enumeration for images. */
public enum ColorType {
+
/** Black and white images. */
BW("Black and White"),
+
/** Grayscale images. */
GRAYSCALE("Grayscale"),
+
/** RGB color images. */
RGB("RGB"),
+
/** CMYK color images. */
CMYK("CMYK"),
+
/** YCbCr color images. */
YCbCr("YCbCr"),
+
/** YCCK color images. */
YCCK("YCCK"),
+
/** YCC color images. */
YCC("YCC"),
+
/** Other color type. */
OTHER("Other"),
+
/** Unknown color type. */
UNKNOWN("Unknown");
@@ -63,32 +72,46 @@ public class ImageInfo {
/** Compression algorithm enumeration for images. */
public enum CompressionAlgorithm {
+
/** Unknown compression. */
UNKNOWN("Unknown"),
+
/** No compression. */
NONE("None"),
+
/** LZW compression. */
LZW("LZW"),
+
/** PackBits compression. */
PACKBITS("PackBits"),
+
/** JPEG compression (TIFF obsolete). */
JPEG_TIFF_OBSOLETE("JPEG Obsolete (TIFF only)"),
+
/** JPEG compression. */
JPEG("JPEG"),
+
/** RLE: Run-Length Encoding. */
RLE("RLE: Run-Length Encoding"),
+
/** Adaptive RLE compression. */
ADAPTIVE_RLE("Adaptive RLE"),
+
/** Photoshop compression. */
PSD("Photoshop"),
+
/** PNG Filter compression. */
PNG_FILTER("PNG Filter"),
+
/** CCITT Group 3 1-Dimensional Modified Huffman run-length encoding.
*/
CCITT_GROUP_3("CCITT Group 3 1-Dimensional Modified Huffman run-length
encoding."),
+
/** CCITT Group 4 compression. */
CCITT_GROUP_4("CCITT Group 4"),
+
/** CCITT 1D compression. */
CCITT_1D("CCITT 1D"),
+
/** DEFLATE (ZIP) compression. */
DEFLATE("DEFLATE (ZIP)");
diff --git a/src/main/java/org/apache/commons/imaging/common/BasicCParser.java
b/src/main/java/org/apache/commons/imaging/common/BasicCParser.java
index d1950a57..d852c800 100644
--- a/src/main/java/org/apache/commons/imaging/common/BasicCParser.java
+++ b/src/main/java/org/apache/commons/imaging/common/BasicCParser.java
@@ -32,6 +32,7 @@ import org.apache.commons.lang3.StringUtils;
* FIXME replace this by a parser generated via ANTLR (if we really need it?!)
*/
public class BasicCParser {
+
/**
* Parses the hexadecimal-base escape-sequence found at index {@code i} of
{@code string}.
*
diff --git a/src/main/java/org/apache/commons/imaging/common/ImageMetadata.java
b/src/main/java/org/apache/commons/imaging/common/ImageMetadata.java
index 1d0f0a5f..6ecc67d1 100644
--- a/src/main/java/org/apache/commons/imaging/common/ImageMetadata.java
+++ b/src/main/java/org/apache/commons/imaging/common/ImageMetadata.java
@@ -22,6 +22,7 @@ import java.util.List;
* Image metadata.
*/
public interface ImageMetadata {
+
/**
* Represents a single metadata item.
*/
diff --git
a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcRecord.java
b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcRecord.java
index eeb4c818..1ffda6e8 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcRecord.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcRecord.java
@@ -22,8 +22,10 @@ import java.util.Comparator;
* Represents an IPTC record, a single key-value pair of Photoshop IPTC data.
*/
public class IptcRecord {
+
/** Comparator for sorting IPTC records by type. */
public static final Comparator<IptcRecord> COMPARATOR =
Comparator.comparingInt(e -> e.iptcType.getType());
+
/** The IPTC type. */
public final IptcType iptcType;
private final String value;
diff --git
a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcType.java
b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcType.java
index 469a1eb6..b506cfc7 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcType.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcType.java
@@ -20,6 +20,7 @@ package org.apache.commons.imaging.formats.jpeg.iptc;
* IPTC metadata types.
*/
public interface IptcType {
+
/**
* Gets the name of this IPTC type.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcTypes.java
b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcTypes.java
index 9d61974d..3956517f 100644
--- a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcTypes.java
+++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcTypes.java
@@ -20,118 +20,175 @@ package org.apache.commons.imaging.formats.jpeg.iptc;
* Enumeration of IPTC (International Press Telecommunications Council)
metadata record types.
*/
public enum IptcTypes implements IptcType {
+
/** Record version type. */
RECORD_VERSION(0, "Record Version"),
+
/** Object type reference type. */
OBJECT_TYPE_REFERENCE(3, "Object Type Reference"),
+
/** Object attribute reference type. */
OBJECT_ATTRIBUTE_REFERENCE(4, "Object Attribute Reference"),
+
/** Object name type. */
OBJECT_NAME(5, "Object Name"),
+
/** Edit status type. */
EDIT_STATUS(7, "Edit Status"),
+
/** Editorial update type. */
EDITORIAL_UPDATE(8, "Editorial Update"),
+
/** Urgency type. */
URGENCY(10, "Urgency"),
+
/** Subject reference type. */
SUBJECT_REFERENCE(12, "Subject Reference"),
+
/** Category type. */
CATEGORY(15, "Category"),
+
/** Supplemental category type. */
SUPPLEMENTAL_CATEGORY(20, "Supplemental Category"),
+
/** Fixture identifier type. */
FIXTURE_IDENTIFIER(22, "Fixture Identifier"),
+
/** Keywords type. */
KEYWORDS(25, "Keywords"),
+
/** Content location code type. */
CONTENT_LOCATION_CODE(26, "Content Location Code"),
+
/** Content location name type. */
CONTENT_LOCATION_NAME(27, "Content Location Name"),
+
/** Release date type. */
RELEASE_DATE(30, "Release Date"),
+
/** Release time type. */
RELEASE_TIME(35, "Release Time"),
+
/** Expiration date type. */
EXPIRATION_DATE(37, "Expiration Date"),
+
/** Expiration time type. */
EXPIRATION_TIME(38, "Expiration Time"),
+
/** Special instructions type. */
SPECIAL_INSTRUCTIONS(40, "Special Instructions"),
+
/** Action advised type. */
ACTION_ADVISED(42, "Action Advised"),
+
/** Reference service type. */
REFERENCE_SERVICE(45, "Reference Service"),
+
/** Reference date type. */
REFERENCE_DATE(47, "Reference Date"),
+
/** Reference number type. */
REFERENCE_NUMBER(50, "Reference Number"),
+
/** Date created type. */
DATE_CREATED(55, "Date Created"),
+
/** Time created type. */
TIME_CREATED(60, "Time Created"),
+
/** Digital creation date type. */
DIGITAL_CREATION_DATE(62, "Digital Creation Date"),
+
/** Digital creation time type. */
DIGITAL_CREATION_TIME(63, "Digital Creation Time"),
+
/** Originating program type. */
ORIGINATING_PROGRAM(65, "Originating Program"),
+
/** Program version type. */
PROGRAM_VERSION(70, "Program Version"),
+
/** Object cycle type. */
OBJECT_CYCLE(75, "Object Cycle"),
+
/** By-line type. */
BYLINE(80, "By-line"),
+
/** By-line title type. */
BYLINE_TITLE(85, "By-line Title"),
+
/** City type. */
CITY(90, "City"),
+
/** Sublocation type. */
SUBLOCATION(92, "Sublocation"),
+
/** Province/State type. */
PROVINCE_STATE(95, "Province/State"),
+
/** Country/Primary location code type. */
COUNTRY_PRIMARY_LOCATION_CODE(100, "Country/Primary Location Code"),
+
/** Country/Primary location name type. */
COUNTRY_PRIMARY_LOCATION_NAME(101, "Country/Primary Location Name"),
+
/** Original transmission reference type. */
ORIGINAL_TRANSMISSION_REFERENCE(103, "Original Transmission, Reference"),
+
/** Headline type. */
HEADLINE(105, "Headline"),
+
/** Credit type. */
CREDIT(110, "Credit"),
+
/** Source type. */
SOURCE(115, "Source"),
+
/** Copyright notice type. */
COPYRIGHT_NOTICE(116, "Copyright Notice"),
+
/** Contact type. */
CONTACT(118, "Contact"),
+
/** Caption/Abstract type. */
CAPTION_ABSTRACT(120, "Caption/Abstract"),
+
/** Writer/Editor type. */
WRITER_EDITOR(122, "Writer/Editor"),
+
/** Rasterized caption type. */
RASTERIZED_CAPTION(125, "Rasterized Caption"),
+
/** Image type. */
IMAGE_TYPE(130, "ImageType"),
+
/** Image orientation type. */
IMAGE_ORIENTATION(131, "Image Orientation"),
+
/** Language identifier type. */
LANGUAGE_IDENTIFIER(135, "Language Identifier"),
+
/** Audio type. */
AUDIO_TYPE(150, "Audio Type"),
+
/** Audio sampling rate type. */
AUDIO_SAMPLING_RATE(151, "Audio Sampling Rate"),
+
/** Audio sampling resolution type. */
AUDIO_SAMPLING_RESOLUTION(152, "Audio Sampling Resolution"),
+
/** Audio duration type. */
AUDIO_DURATION(153, "Audio Duration"),
+
/** Audio outcue type. */
AUDIO_OUTCUE(154, "Audio Outcue"),
+
/** Object data preview file format type. */
OBJECT_DATA_PREVIEW_FILE_FORMAT(200, "Object Data Preview, File Format"),
+
/** Object data preview file format version type. */
OBJECT_DATA_PREVIEW_FILE_FORMAT_VERSION(201, "Object Data Preview, File
Format Version"),
+
/** Object data preview data type. */
OBJECT_DATA_PREVIEW_DATA(202, "Object Data Preview Data");
diff --git
a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DqtSegment.java
b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DqtSegment.java
index fef2397b..8f1a1481 100644
---
a/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DqtSegment.java
+++
b/src/main/java/org/apache/commons/imaging/formats/jpeg/segments/DqtSegment.java
@@ -35,6 +35,7 @@ public final class DqtSegment extends AbstractSegment {
* A quantization table for JPEG compression.
*/
public static class QuantizationTable {
+
/** The precision of the quantization table (0=8-bit, 1=16-bit). */
public final int precision;
diff --git
a/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImageParser.java
b/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImageParser.java
index d6dd7f5c..a158ac8d 100644
--- a/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImageParser.java
+++ b/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImageParser.java
@@ -71,41 +71,58 @@ public class PcxImageParser extends
AbstractImageParser<PcxImagingParameters> {
public static final int ENCODING_RLE = 1;
public static final int PALETTE_INFO_COLOR = 1;
public static final int PALETTE_INFO_GRAYSCALE = 2;
+
/** Always 10 = ZSoft .pcx. */
public final int manufacturer;
+
/**
* Version: 0 = PC Paintbrush 2.5, 2 = PC Paintbrush 2.8 with palette,
3 = PC Paintbrush 2.8 w/o palette, 4 = PC Paintbrush for Windows, 5 = PC
* Paintbrush >= 3.0.
*/
public final int version;
+
/** Encoding: 0 = very old uncompressed format, 1 = .pcx run length
encoding. */
public final int encoding;
+
/** Bits ***PER PLANE*** for each pixel. */
public final int bitsPerPixel;
+
/** Window xMin. */
public final int xMin;
+
/** Window yMin. */
public final int yMin;
+
/** Window xMax. */
public final int xMax;
+
/** Window yMax. */
public final int yMax;
+
/** Horizontal dpi. */
public final int hDpi;
+
/** Vertical dpi. */
public final int vDpi;
+
/** Palette for <= 16 colors. */
public final int[] colormap;
+
/** Always 0. */
public final int reserved;
+
/** Number of color planes. */
public final int nPlanes;
+
/** Number of bytes per scanline plane, must be an even number. */
public final int bytesPerLine;
+
/** 1 = Color/BW, 2 = Grayscale, ignored in Paintbrush IV/IV+. */
public final int paletteInfo;
+
/** Horizontal screen size, in pixels. PaintBrush >= IV only. */
public final int hScreenSize;
+
/** Vertical screen size, in pixels. PaintBrush >= IV only. */
public final int vScreenSize;
diff --git
a/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImagingParameters.java
b/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImagingParameters.java
index 724894ea..eafaef65 100644
---
a/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImagingParameters.java
+++
b/src/main/java/org/apache/commons/imaging/formats/pcx/PcxImagingParameters.java
@@ -28,6 +28,7 @@ public class PcxImagingParameters extends
ImagingParameters<PcxImagingParameters
private int bitDepth = -1;
private int compression = PcxConstants.PCX_COMPRESSION_UNCOMPRESSED;
+
/**
* Constructs a new instance.
*/
diff --git
a/src/main/java/org/apache/commons/imaging/formats/png/AbstractPngText.java
b/src/main/java/org/apache/commons/imaging/formats/png/AbstractPngText.java
index a8b42199..19eaf6c6 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/AbstractPngText.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/AbstractPngText.java
@@ -57,6 +57,7 @@ public abstract class AbstractPngText {
* Represents a simple text chunk (tEXt).
*/
public static class Text extends AbstractPngText {
+
/**
* Constructs a tEXt chunk.
*
@@ -72,6 +73,7 @@ public abstract class AbstractPngText {
* Represents a compressed text chunk (zTXt).
*/
public static class Ztxt extends AbstractPngText {
+
/**
* Constructs a zTXt chunk.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/png/Extension.java
b/src/main/java/org/apache/commons/imaging/formats/png/Extension.java
index def1baee..a36c9bf0 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/Extension.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/Extension.java
@@ -22,6 +22,7 @@ package org.apache.commons.imaging.formats.png;
* @since 1.0-alpha6
*/
enum Extension {
+
/**
* @see <a
href="https://ftp-osl.osuosl.org/pub/libpng/documents/pngext-1.5.0.html";>Extensions
to the PNG 1.2 Specification, Version 1.5.0</a>
*/
diff --git
a/src/main/java/org/apache/commons/imaging/formats/png/InterlaceMethod.java
b/src/main/java/org/apache/commons/imaging/formats/png/InterlaceMethod.java
index b71738fe..2cd91e25 100644
--- a/src/main/java/org/apache/commons/imaging/formats/png/InterlaceMethod.java
+++ b/src/main/java/org/apache/commons/imaging/formats/png/InterlaceMethod.java
@@ -25,6 +25,7 @@ public enum InterlaceMethod {
/** No interlacing. */
NONE(false),
+
/** Adam7 interlacing. */
ADAM7(true);
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffElement.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffElement.java
index 152dbde7..a7d9a2c1 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffElement.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffElement.java
@@ -65,6 +65,7 @@ public abstract class AbstractTiffElement {
* Represents a stub TIFF element with no specific data.
*/
public static final class Stub extends AbstractTiffElement {
+
/**
* Constructs a new stub element.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/JpegImageData.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/JpegImageData.java
index 402fab65..628ff39a 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/JpegImageData.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/JpegImageData.java
@@ -21,6 +21,7 @@ package org.apache.commons.imaging.formats.tiff;
* JPEG image data within a TIFF file.
*/
public class JpegImageData extends AbstractTiffElement.DataElement {
+
/**
* Constructs a new JPEG image data element.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataType.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataType.java
index 1b11645f..f2be5461 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataType.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataType.java
@@ -20,6 +20,7 @@ package org.apache.commons.imaging.formats.tiff;
* Provides an enumeration indicating the type of data for an instance of a
TiffRasterData class.
*/
public enum TiffRasterDataType {
+
/**
* Indicates that the raster contains integer data. Attempts to access
floating-point data from the raster will result in the nearest floating point
value.
*/
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/DngTagConstants.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/DngTagConstants.java
index f894603a..841ce893 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/DngTagConstants.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/DngTagConstants.java
@@ -68,20 +68,28 @@ public final class DngTagConstants {
/** CFA layout value: rectangular. */
public static final int CFALAYOUT_VALUE_RECTANGULAR = 1;
+
/** CFA layout value: even columns offset down 1/2 row. */
public static final int CFALAYOUT_VALUE_EVEN_COLUMNS_OFFSET_DOWN_1_2_ROW =
2;
+
/** CFA layout value: even columns offset up 1/2 row. */
public static final int CFALAYOUT_VALUE_EVEN_COLUMNS_OFFSET_UP_1_2_ROW = 3;
+
/** CFA layout value: even rows offset right 1/2 column. */
public static final int CFALAYOUT_VALUE_EVEN_ROWS_OFFSET_RIGHT_1_2_COLUMN
= 4;
+
/** CFA layout value: even rows offset left 1/2 column. */
public static final int CFALAYOUT_VALUE_EVEN_ROWS_OFFSET_LEFT_1_2_COLUMN =
5;
+
/** CFA layout value: even rows offset up 1/2 row, even columns offset
left 1/2 column. */
public static final int
CFALAYOUT_VALUE_EVEN_ROWS_OFFSET_UP_1_2_ROW_EVEN_COLUMNS_OFFSET_LEFT_1_2_COLUMN
= 6;
+
/** CFA layout value: even rows offset up 1/2 row, even columns offset
right 1/2 column. */
public static final int
CFALAYOUT_VALUE_EVEN_ROWS_OFFSET_UP_1_2_ROW_EVEN_COLUMNS_OFFSET_RIGHT_1_2_COLUMN
= 7;
+
/** CFA layout value: even rows offset down 1/2 row, even columns offset
left 1/2 column. */
public static final int
CFALAYOUT_VALUE_EVEN_ROWS_OFFSET_DOWN_1_2_ROW_EVEN_COLUMNS_OFFSET_LEFT_1_2_COLUMN
= 8;
+
/** CFA layout value: even rows offset down 1/2 row, even columns offset
right 1/2 column. */
public static final int
CFALAYOUT_VALUE_EVEN_ROWS_OFFSET_DOWN_1_2_ROW_EVEN_COLUMNS_OFFSET_RIGHT_1_2_COLUMN
= 9;
@@ -188,8 +196,10 @@ public final class DngTagConstants {
/** Maker note safety tag. */
public static final TagInfoShort EXIF_TAG_MAKER_NOTE_SAFETY = new
TagInfoShort("MakerNoteSafety", 0xc635, TiffDirectoryType.EXIF_DIRECTORY_IFD0);
+
/** Maker note safety value: unsafe. */
public static final int MAKER_NOTE_SAFETY_VALUE_UNSAFE = 0;
+
/** Maker note safety value: safe. */
public static final int MAKER_NOTE_SAFETY_VALUE_SAFE = 1;
@@ -359,8 +369,10 @@ public final class DngTagConstants {
/** Colorimetric reference tag. */
public static final TagInfoShort EXIF_TAG_COLORIMETRIC_REFERENCE = new
TagInfoShort("ColorimetricReference", 0xc6bf,
TiffDirectoryType.EXIF_DIRECTORY_IFD0);
+
/** Colorimetric reference value: scene referred. */
public static final short COLORIMETRIC_REFERENCE_VALUE_SCENE_REFERRED = 0;
+
/** Colorimetric reference value: output referred. */
public static final short COLORIMETRIC_REFERENCE_VALUE_OUTPUT_REFERRED = 1;
@@ -404,12 +416,16 @@ public final class DngTagConstants {
/** Profile embed policy tag. */
public static final TagInfoLong EXIF_TAG_PROFILE_EMBED_POLICY = new
TagInfoLong("ProfileEmbedPolicy", 0xc6fd,
TiffDirectoryType.EXIF_DIRECTORY_UNKNOWN);
+
/** Profile embed policy value: allow copying. */
public static final int PROFILE_EMBED_POLICY_VALUE_ALLOW_COPYING = 0;
+
/** Profile embed policy value: embed if used. */
public static final int PROFILE_EMBED_POLICY_VALUE_EMBED_IF_USED = 1;
+
/** Profile embed policy value: embed never. */
public static final int PROFILE_EMBED_POLICY_VALUE_EMBED_NEVER = 2;
+
/** Profile embed policy value: no restrictions. */
public static final int PROFILE_EMBED_POLICY_VALUE_NO_RESTRICTIONS = 3;
@@ -443,14 +459,19 @@ public final class DngTagConstants {
/** Preview colorspace tag. */
public static final TagInfoLong EXIF_TAG_PREVIEW_COLORSPACE = new
TagInfoLong("PreviewColorspace", 0xc71a,
TiffDirectoryType.EXIF_DIRECTORY_UNKNOWN);
+
/** Preview colorspace value: unknown. */
public static final int PREVIEW_COLORSPACE_VALUE_UNKNOWN = 0;
+
/** Preview colorspace value: gray gamma 2.2. */
public static final int PREVIEW_COLORSPACE_VALUE_GRAY_GAMMA_2_2 = 1;
+
/** Preview colorspace value: sRGB. */
public static final int PREVIEW_COLORSPACE_VALUE_sRGB = 2;
+
/** Preview colorspace value: Adobe RGB. */
public static final int PREVIEW_COLORSPACE_VALUE_ADOBE_RGB = 3;
+
/** Preview colorspace value: ProPhoto RGB. */
public static final int PREVIEW_COLORSPACE_VALUE_PROPHOTO_RGB = 4;
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/GpsTagConstants.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/GpsTagConstants.java
index 6b01ae35..678a5dc6 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/GpsTagConstants.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/GpsTagConstants.java
@@ -90,6 +90,7 @@ public final class GpsTagConstants {
/** GPS measure mode tag. */
public static final TagInfoAscii GPS_TAG_GPS_MEASURE_MODE = new
TagInfoAscii("GPSMeasureMode", 0x000a, 2, TiffDirectoryType.EXIF_DIRECTORY_GPS);
+
/** GPS measure mode value: 2-dimensional measurement. */
public static final int
GPS_TAG_GPS_MEASURE_MODE_VALUE_2_DIMENSIONAL_MEASUREMENT = 2;
@@ -107,6 +108,7 @@ public final class GpsTagConstants {
/** GPS speed reference value: miles per hour. */
public static final String GPS_TAG_GPS_SPEED_REF_VALUE_MPH = "M";
+
/** GPS speed reference value: knots. */
public static final String GPS_TAG_GPS_SPEED_REF_VALUE_KNOTS = "N";
@@ -184,6 +186,7 @@ public final class GpsTagConstants {
/** GPS destination distance reference value: miles. */
public static final String GPS_TAG_GPS_DEST_DISTANCE_REF_VALUE_MILES = "M";
+
/** GPS destination distance reference value: nautical miles. */
public static final String
GPS_TAG_GPS_DEST_DISTANCE_REF_VALUE_NAUTICAL_MILES = "N";
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/MicrosoftHdPhotoTagConstants.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/MicrosoftHdPhotoTagConstants.java
index 06820de2..ec0ebea6 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/MicrosoftHdPhotoTagConstants.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/MicrosoftHdPhotoTagConstants.java
@@ -103,7 +103,6 @@ public final class MicrosoftHdPhotoTagConstants {
/** Pixel format: 32-bit CMYK. */
public static final BinaryConstant PIXEL_FORMAT_VALUE_32_BIT_CMYK =
create((byte) 0x1c);
- /** Pixel format: 64-bit RGBA Fixed Point. */
/** Pixel format: 64-bit RGBA Fixed Point. */
public static final BinaryConstant
PIXEL_FORMAT_VALUE_64_BIT_RGBA_FIXED_POINT = create((byte) 0x1d);
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffPlanarConfiguration.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffPlanarConfiguration.java
index 067fd1d8..40492d87 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffPlanarConfiguration.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/constants/TiffPlanarConfiguration.java
@@ -25,6 +25,7 @@ public enum TiffPlanarConfiguration {
* Indicates that data is stored in an interleaved format, so that
component values for each pixel are contiguous in the file.
*/
CHUNKY(TiffTagConstants.PLANAR_CONFIGURATION_VALUE_CHUNKY),
+
/**
* Indicates that data is stored in a non-interleaved format, component
values for each pixel are separated into distinct planes.
*/
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeAscii.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeAscii.java
index 982e01a6..e80038eb 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeAscii.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeAscii.java
@@ -28,6 +28,7 @@ import org.apache.commons.imaging.formats.tiff.TiffField;
* TIFF field type for ASCII strings.
*/
public class FieldTypeAscii extends AbstractFieldType {
+
/**
* Constructs a new ASCII field type.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeByte.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeByte.java
index 765b1a07..5a700848 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeByte.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeByte.java
@@ -25,6 +25,7 @@ import org.apache.commons.imaging.formats.tiff.TiffField;
* TIFF field type for byte values.
*/
public class FieldTypeByte extends AbstractFieldType {
+
/**
* Constructs a new byte field type.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeDouble.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeDouble.java
index 363f398e..882430b8 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeDouble.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeDouble.java
@@ -28,6 +28,7 @@ import org.apache.commons.imaging.formats.tiff.TiffField;
* TIFF field type for double-precision floating point values.
*/
public class FieldTypeDouble extends AbstractFieldType {
+
/**
* Constructs a new double field type.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeFloat.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeFloat.java
index a2b62dc6..b78eb17d 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeFloat.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeFloat.java
@@ -27,6 +27,7 @@ import org.apache.commons.imaging.formats.tiff.TiffField;
* TIFF field type for single-precision floating point values.
*/
public class FieldTypeFloat extends AbstractFieldType {
+
/**
* Constructs a new float field type.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong.java
index 887f0c75..920604a3 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong.java
@@ -27,6 +27,7 @@ import org.apache.commons.imaging.formats.tiff.TiffField;
* TIFF field type for 32-bit unsigned long values.
*/
public class FieldTypeLong extends AbstractFieldType {
+
/**
* Constructs a new long field type.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong8.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong8.java
index 9f328495..cd506151 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong8.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeLong8.java
@@ -27,6 +27,7 @@ import org.apache.commons.imaging.formats.tiff.TiffField;
* Provides an implementation of the 8-byte integer field type specified by
the BigTIFF extensions to the TIFF format.
*/
public class FieldTypeLong8 extends AbstractFieldType {
+
/**
* Constructs a new 64-bit long field type.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeRational.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeRational.java
index 78414f3b..2eb7757e 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeRational.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeRational.java
@@ -29,6 +29,7 @@ import org.apache.commons.imaging.formats.tiff.TiffField;
* TIFF field type for rational number values.
*/
public class FieldTypeRational extends AbstractFieldType {
+
/**
* Constructs a new rational field type.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeShort.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeShort.java
index f8b972ca..02d063fe 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeShort.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/fieldtypes/FieldTypeShort.java
@@ -27,6 +27,7 @@ import org.apache.commons.imaging.formats.tiff.TiffField;
* TIFF field type for 16-bit unsigned short values.
*/
public class FieldTypeShort extends AbstractFieldType {
+
/**
* Constructs a new short field type.
*
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/PhotometricInterpreterRgb.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/PhotometricInterpreterRgb.java
index e75bdd77..a5e6177d 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/PhotometricInterpreterRgb.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/PhotometricInterpreterRgb.java
@@ -25,6 +25,7 @@ import org.apache.commons.imaging.common.ImageBuilder;
* Photometric interpreter for RGB color space images.
*/
public class PhotometricInterpreterRgb extends AbstractPhotometricInterpreter {
+
/**
* Constructs a new RGB photometric interpreter.
*
diff --git a/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
b/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
index 493931d1..a85967de 100644
--- a/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
+++ b/src/main/java/org/apache/commons/imaging/icc/IccProfileInfo.java
@@ -31,30 +31,43 @@ public class IccProfileInfo {
private static final Logger LOGGER =
Logger.getLogger(IccProfileInfo.class.getName());
private final byte[] data;
+
/** The profile size in bytes. */
public final int profileSize;
+
/** The CMM type signature. */
public final int cmmTypeSignature;
+
/** The profile version. */
public final int profileVersion;
+
/** The profile/device class signature. */
public final int profileDeviceClassSignature;
+
/** The color space signature. */
public final int colorSpace;
+
/** The profile connection space signature. */
public final int profileConnectionSpace;
+
/** The profile file signature. */
public final int profileFileSignature;
+
/** The primary platform signature. */
public final int primaryPlatformSignature;
+
/** Various profile flags. */
public final int variousFlags;
+
/** The device manufacturer signature. */
public final int deviceManufacturer;
+
/** The device model signature. */
public final int deviceModel;
+
/** The rendering intent. */
public final int renderingIntent;
+
/** The profile creator signature. */
public final int profileCreatorSignature;
private final byte[] profileId;
diff --git a/src/main/java/org/apache/commons/imaging/icc/IccTag.java
b/src/main/java/org/apache/commons/imaging/icc/IccTag.java
index bd0d8b3a..895db0a2 100644
--- a/src/main/java/org/apache/commons/imaging/icc/IccTag.java
+++ b/src/main/java/org/apache/commons/imaging/icc/IccTag.java
@@ -39,10 +39,13 @@ public class IccTag {
/** The tag signature. */
public final int signature;
+
/** The offset of the tag data. */
public final int offset;
+
/** The length of the tag data. */
public final int length;
+
/** The ICC tag type. */
public final IccTagType fIccTagType;
private byte[] data;
diff --git
a/src/test/java/org/apache/commons/imaging/examples/WriteExifMetadataExample.java
b/src/test/java/org/apache/commons/imaging/examples/WriteExifMetadataExample.java
index 62f87c3b..4a4b3749 100644
---
a/src/test/java/org/apache/commons/imaging/examples/WriteExifMetadataExample.java
+++
b/src/test/java/org/apache/commons/imaging/examples/WriteExifMetadataExample.java
@@ -35,6 +35,7 @@ import
org.apache.commons.imaging.formats.tiff.write.TiffOutputSet;
import org.apache.commons.io.FileUtils;
public class WriteExifMetadataExample {
+
/**
* This example illustrates how to add/update EXIF metadata in a JPEG file.
*
diff --git
a/src/test/java/org/apache/commons/imaging/formats/jpeg/specific/JpegImageParserTest.java
b/src/test/java/org/apache/commons/imaging/formats/jpeg/specific/JpegImageParserTest.java
index a6e3ce81..993adbe5 100644
---
a/src/test/java/org/apache/commons/imaging/formats/jpeg/specific/JpegImageParserTest.java
+++
b/src/test/java/org/apache/commons/imaging/formats/jpeg/specific/JpegImageParserTest.java
@@ -32,6 +32,7 @@ import org.junit.jupiter.api.Test;
* Basic tests for JpegImageParser.
*/
class JpegImageParserTest {
+
/**
* Image created with The Gimp 2.8
*
