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
commit d54f7e66504e4583522237bd2bee1a58c8a77a20 Author: Gary Gregory <[email protected]> AuthorDate: Sat Jan 3 12:05:56 2026 -0500 Javadoc --- .../apache/commons/imaging/formats/gif/GifImageParser.java | 3 +++ .../commons/imaging/formats/jpeg/decoder/JpegDecoder.java | 11 +++++++++++ .../apache/commons/imaging/formats/jpeg/iptc/IptcParser.java | 9 +++++++++ .../apache/commons/imaging/formats/tiff/JpegImageData.java | 10 ++++++++++ 4 files changed, 33 insertions(+) diff --git a/src/main/java/org/apache/commons/imaging/formats/gif/GifImageParser.java b/src/main/java/org/apache/commons/imaging/formats/gif/GifImageParser.java index 4fd53851..d33cc362 100644 --- a/src/main/java/org/apache/commons/imaging/formats/gif/GifImageParser.java +++ b/src/main/java/org/apache/commons/imaging/formats/gif/GifImageParser.java @@ -49,6 +49,9 @@ import org.apache.commons.imaging.mylzw.MyLzwDecompressor; import org.apache.commons.imaging.palette.Palette; import org.apache.commons.imaging.palette.PaletteFactory; +/** + * Parses GIF (Graphics Interchange Format) images. + */ public class GifImageParser extends AbstractImageParser<GifImagingParameters> implements XmpEmbeddable<GifImagingParameters> { private static final Logger LOGGER = Logger.getLogger(GifImageParser.class.getName()); diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegDecoder.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegDecoder.java index e26a4b4b..0719f695 100644 --- a/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegDecoder.java +++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/decoder/JpegDecoder.java @@ -45,6 +45,9 @@ import org.apache.commons.imaging.formats.jpeg.segments.DqtSegment.QuantizationT import org.apache.commons.imaging.formats.jpeg.segments.SofnSegment; import org.apache.commons.imaging.formats.jpeg.segments.SosSegment; +/** + * Decodes JPEG images. + */ public class JpegDecoder extends BinaryFileParser implements JpegUtils.Visitor { private static final int[] BAND_MASK_ARGB = { 0x00ff0000, 0x0000ff00, 0x000000ff, 0xff000000 }; @@ -176,6 +179,14 @@ public class JpegDecoder extends BinaryFileParser implements JpegUtils.Visitor { return true; } + /** + * Decodes a JPEG image from a byte source. + * + * @param byteSource the byte source containing the JPEG data. + * @return the decoded BufferedImage. + * @throws IOException if an I/O error occurs. + * @throws ImagingException if an imaging error occurs. + */ public BufferedImage decode(final ByteSource byteSource) throws IOException, ImagingException { final JpegUtils jpegUtils = new JpegUtils(); jpegUtils.traverseJfif(byteSource, this); diff --git a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcParser.java b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcParser.java index a77bd524..71c7b356 100644 --- a/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcParser.java +++ b/src/main/java/org/apache/commons/imaging/formats/jpeg/iptc/IptcParser.java @@ -112,6 +112,15 @@ public class IptcParser extends BinaryFileParser { return index + 4 <= segmentData.length && ByteConversions.toInt(segmentData, index, APP13_BYTE_ORDER) == JpegConstants.CONST_8BIM; } + /** + * Parses all IPTC blocks from the byte array. + * + * @param bytes the byte array containing IPTC data. + * @param strict whether to use strict parsing mode. + * @return a list of IPTC blocks. + * @throws ImagingException if an imaging error occurs. + * @throws IOException if an I/O error occurs. + */ protected List<IptcBlock> parseAllBlocks(final byte[] bytes, final boolean strict) throws ImagingException, IOException { final List<IptcBlock> blocks = new ArrayList<>(); 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 2c5bc2c9..402fab65 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 @@ -17,7 +17,17 @@ 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. + * + * @param offset the offset in the file. + * @param length the data length. + * @param data the data bytes. + */ public JpegImageData(final long offset, final int length, final byte[] data) { super(offset, length, data); }
