You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ki...@apache.org on 2022/01/30 21:09:59 UTC
[commons-imaging] 01/03: IMAGING-327: change getExif method name
This is an automated email from the ASF dual-hosted git repository.
kinow pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-imaging.git
commit 6b69ebba53cd18da6610d256a6e45dd22b4960e3
Author: gwlucastrig <co...@gmail.com>
AuthorDate: Sun Jan 30 13:36:36 2022 -0500
IMAGING-327: change getExif method name
---
src/conf/spotbugs-exclude-filter.xml | 4 ++--
.../formats/tiff/TiffImagingParameters.java | 24 ++++++++++++++++------
.../formats/tiff/write/TiffImageWriterBase.java | 2 +-
.../formats/jpeg/exif/MicrosoftTagTest.java | 2 +-
4 files changed, 22 insertions(+), 10 deletions(-)
diff --git a/src/conf/spotbugs-exclude-filter.xml b/src/conf/spotbugs-exclude-filter.xml
index 244862f..84abf6e 100644
--- a/src/conf/spotbugs-exclude-filter.xml
+++ b/src/conf/spotbugs-exclude-filter.xml
@@ -180,12 +180,12 @@
</Match>
<Match>
<Class name="org.apache.commons.imaging.formats.tiff.TiffImagingParameters" />
- <Method name="getExif" />
+ <Method name="getOutputSet" />
<Bug pattern="EI_EXPOSE_REP" />
</Match>
<Match>
<Class name="org.apache.commons.imaging.formats.tiff.TiffImagingParameters" />
- <Method name="setExif" />
+ <Method name="setOutputSet" />
<Bug pattern="EI_EXPOSE_REP2" />
</Match>
<!-- Reason: For code clarity, we could use a simple 'else', but instead keep a complete expression -->
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImagingParameters.java b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImagingParameters.java
index 058e41e..8a706f5 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImagingParameters.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffImagingParameters.java
@@ -33,9 +33,10 @@ public class TiffImagingParameters extends XmpImagingParameters {
private boolean readThumbnails = true;
/**
- * User provided {@code TiffOutputSet} used to write into the image's EXIF metadata.
+ * User provided {@code TiffOutputSet} used to write into
+ * the image's metadata including standard directory and EXIF tags.
*/
- private TiffOutputSet exif = null;
+ private TiffOutputSet tiffOutputSet = null;
/**
* X-coordinate of a sub-image.
@@ -106,12 +107,23 @@ public class TiffImagingParameters extends XmpImagingParameters {
this.readThumbnails = readThumbnails;
}
- public TiffOutputSet getExif() {
- return exif;
+ /**
+ * Get the TIFF output set for writing TIFF files.
+ * @return if set, a valid instance; otherwise, a null reference.
+ */
+ public TiffOutputSet getOutputSet() {
+ return tiffOutputSet;
}
- public void setExif(TiffOutputSet exif) {
- this.exif = exif;
+ /**
+ * Set the TIFF output set for writing TIFF files. An output set
+ * may contain various types of TiffDirectories including image directories,
+ * EXIF directories, GPS-related directories, etc.
+ *
+ * @param tiffOutputSet A valid instance.
+ */
+ public void setOutputSet(TiffOutputSet tiffOutputSet) {
+ this.tiffOutputSet = tiffOutputSet;
}
/**
diff --git a/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffImageWriterBase.java b/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffImageWriterBase.java
index c170e86..fa401dd 100644
--- a/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffImageWriterBase.java
+++ b/src/main/java/org/apache/commons/imaging/formats/tiff/write/TiffImageWriterBase.java
@@ -302,7 +302,7 @@ public abstract class TiffImageWriterBase {
public void writeImage(final BufferedImage src, final OutputStream os, TiffImagingParameters params)
throws ImageWriteException, IOException {
- TiffOutputSet userExif = params.getExif();
+ TiffOutputSet userExif = params.getOutputSet();
String xmpXml = params.getXmpXml();
diff --git a/src/test/java/org/apache/commons/imaging/formats/jpeg/exif/MicrosoftTagTest.java b/src/test/java/org/apache/commons/imaging/formats/jpeg/exif/MicrosoftTagTest.java
index 8b8f604..e2e257f 100644
--- a/src/test/java/org/apache/commons/imaging/formats/jpeg/exif/MicrosoftTagTest.java
+++ b/src/test/java/org/apache/commons/imaging/formats/jpeg/exif/MicrosoftTagTest.java
@@ -59,7 +59,7 @@ public class MicrosoftTagTest extends ExifBaseTest {
root.add(MicrosoftTagConstants.EXIF_TAG_XPSUBJECT, SUBJECT);
root.add(MicrosoftTagConstants.EXIF_TAG_XPTITLE, TITLE);
final TiffImagingParameters params = new TiffImagingParameters();
- params.setExif(exifSet);
+ params.setOutputSet(exifSet);
TiffImageParser tiffImageParser = new TiffImageParser();
final byte[] bytes;
try (ByteArrayOutputStream baos = new ByteArrayOutputStream()) {