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 70fd680b Normalize getter Javadoc
70fd680b is described below
commit 70fd680bea1220fb3dc9a27d43a505fcac5f6502
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 06:41:36 2023 -0400
Normalize getter Javadoc
---
.../commons/imaging/AbstractImageParser.java | 52 +++++++++++-----------
.../commons/imaging/common/ImageBuilder.java | 2 +-
.../imaging/formats/jpeg/JpegImageMetadata.java | 2 +-
.../formats/tiff/AbstractTiffImageData.java | 4 +-
.../formats/tiff/TiffImagingParameters.java | 2 +-
.../imaging/formats/tiff/TiffRasterStatistics.java | 12 ++---
.../floatingpoint/PhotometricInterpreterFloat.java | 2 +-
7 files changed, 38 insertions(+), 38 deletions(-)
diff --git a/src/main/java/org/apache/commons/imaging/AbstractImageParser.java
b/src/main/java/org/apache/commons/imaging/AbstractImageParser.java
index 184fc117..b0abb869 100644
--- a/src/main/java/org/apache/commons/imaging/AbstractImageParser.java
+++ b/src/main/java/org/apache/commons/imaging/AbstractImageParser.java
@@ -263,14 +263,14 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get an array of all accepted extensions
+ * Gets an array of all accepted extensions
*
* @return A valid array of one or more elements.
*/
protected abstract String[] getAcceptedExtensions();
/**
- * Get an array of ImageFormat objects describing all accepted types
+ * Gets an array of ImageFormat objects describing all accepted types
*
* @return A valid array of one or more elements.
*/
@@ -397,7 +397,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get an instance of IBufferedImageFactory based on the presence
+ * Gets an instance of IBufferedImageFactory based on the presence
* of a specification for ImagingConstants..BUFFERED_IMAGE_FACTORY
* within the supplied params.
*
@@ -419,7 +419,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get the default extension for the format specified by an implementation
+ * Gets the default extension for the format specified by an implementation
* of ImageParser. Some parsers can support more than one extension
* (i.e. .JPEG, .JPG; .TIF, .TIFF, etc.).
*
@@ -428,7 +428,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
public abstract String getDefaultExtension();
/**
- * Get a default parameters instance for this parser.
+ * Gets a default parameters instance for this parser.
* @return default parameters instance
*/
public abstract T getDefaultParameters();
@@ -481,7 +481,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get an array of bytes describing the International Color Consortium
(ICC)
+ * Gets an array of bytes describing the International Color Consortium
(ICC)
* specification for the color space of the image contained in the
* input byte array. Not all formats support ICC profiles.
*
@@ -497,7 +497,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get an array of bytes describing the International Color Consortium
(ICC)
+ * Gets an array of bytes describing the International Color Consortium
(ICC)
* specification for the color space of the image contained in the
* input byte array. Not all formats support ICC profiles.
*
@@ -516,7 +516,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get an array of bytes describing the International Color Consortium
(ICC)
+ * Gets an array of bytes describing the International Color Consortium
(ICC)
* specification for the color space of the image contained in the
* input byteSource. Not all formats support ICC profiles.
*
@@ -533,7 +533,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
throws ImagingException, IOException;
/**
- * Get an array of bytes describing the International Color Consortium
(ICC)
+ * Gets an array of bytes describing the International Color Consortium
(ICC)
* specification for the color space of the image contained in the
* input file. Not all formats support ICC profiles.
*
@@ -549,7 +549,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get an array of bytes describing the International Color Consortium
(ICC)
+ * Gets an array of bytes describing the International Color Consortium
(ICC)
* specification for the color space of the image contained in the
* input file. Not all formats support ICC profiles.
*
@@ -576,7 +576,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get image information from the specified array of bytes.
Format-specific
+ * Gets image information from the specified array of bytes.
Format-specific
* ImageParser implementations are expected to return a valid
* ImageInfo object or to throw an ImageReadException if unable
* to process the specified data.
@@ -605,7 +605,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get image information from the specified ByteSource. Format-specific
+ * Gets image information from the specified ByteSource. Format-specific
* ImageParser implementations are expected to return a valid
* ImageInfo object or to throw an ImageReadException if unable
* to process the specified data.
@@ -624,7 +624,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get image information from the specified ByteSource. Format-specific
+ * Gets image information from the specified ByteSource. Format-specific
* ImageParser implementations are expected to return a valid
* ImageInfo object or to throw an ImageReadException if unable
* to process the specified data.
@@ -651,7 +651,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
throws ImagingException, IOException;
/**
- * Get image information from the specified file Format-specific
+ * Gets image information from the specified file Format-specific
* ImageParser implementations are expected to return a valid
* ImageInfo object or to throw an ImageReadException if unable
* to process the specified data.
@@ -684,7 +684,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get the size of the image described by the specified byte array.
+ * Gets the size of the image described by the specified byte array.
*
* @param bytes A valid byte array.
* @return A valid instance of Dimension.
@@ -698,7 +698,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get the size of the image described by the specified byte array.
+ * Gets the size of the image described by the specified byte array.
*
* @param bytes A valid byte array.
* @param params Optional instructions for special-handling or
@@ -716,7 +716,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
/**
- * Get the size of the image described by the specified ByteSource.
+ * Gets the size of the image described by the specified ByteSource.
*
* @param byteSource A valid reference to a ByteSource.
* @param params Optional instructions for special-handling or
@@ -731,7 +731,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
throws ImagingException, IOException;
/**
- * Get the size of the image described by the specified file.
+ * Gets the size of the image described by the specified file.
*
* @param file A valid reference to a file.
* @return A valid instance of Dimension.
@@ -745,7 +745,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get the size of the image described by the specified file.
+ * Gets the size of the image described by the specified file.
*
* @param file A valid reference to a file.
* @param params Optional instructions for special-handling or
@@ -768,7 +768,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
/**
- * Get image metadata from the specified array of bytes. Format-specific
+ * Gets image metadata from the specified array of bytes. Format-specific
* ImageParser implementations are expected to return a valid
* IImageMetadata object or to throw an ImageReadException if unable
* to process the specified data.
@@ -787,7 +787,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get image metadata from the specified array of bytes. Format-specific
+ * Gets image metadata from the specified array of bytes. Format-specific
* ImageParser implementations are expected to return a valid
* IImageMetadata object or to throw an ImageReadException if unable
* to process the specified data.
@@ -816,7 +816,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get image metadata from the specified byte source. Format-specific
+ * Gets image metadata from the specified byte source. Format-specific
* ImageParser implementations are expected to return a valid
* IImageMetadata object or to throw an ImageReadException if unable
* to process the specified byte source.
@@ -835,7 +835,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get image metadata from the specified byte source. Format-specific
+ * Gets image metadata from the specified byte source. Format-specific
* ImageParser implementations are expected to return a valid
* IImageMetadata object or to throw an ImageReadException if unable
* to process the specified byte source.
@@ -863,7 +863,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
throws ImagingException, IOException;
/**
- * Get image metadata from the specified file. Format-specific
+ * Gets image metadata from the specified file. Format-specific
* ImageParser implementations are expected to return a valid
* IImageMetadata object or to throw an ImageReadException if unable
* to process the specified data.
@@ -882,7 +882,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get image metadata from the specified file. Format-specific
+ * Gets image metadata from the specified file. Format-specific
* ImageParser implementations are expected to return a valid
* IImageMetadata object or to throw an ImageReadException if unable
* to process the specified data.
@@ -920,7 +920,7 @@ public abstract class AbstractImageParser<T extends
ImagingParameters<T>> extend
}
/**
- * Get a descriptive name for the implementation of an ImageParser.
+ * Gets a descriptive name for the implementation of an ImageParser.
*
* @return a valid, subject-matter-specific string.
*/
diff --git a/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
b/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
index 121c3b73..476e5ad7 100644
--- a/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
+++ b/src/main/java/org/apache/commons/imaging/common/ImageBuilder.java
@@ -249,7 +249,7 @@ public class ImageBuilder {
}
/**
- * Get the width of the ImageBuilder pixel field
+ * Gets the width of the ImageBuilder pixel field
*
* @return a positive integer
*/
diff --git
a/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageMetadata.java
b/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageMetadata.java
index 2cc2dd9a..3e1c35e5 100644
---
a/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageMetadata.java
+++
b/src/main/java/org/apache/commons/imaging/formats/jpeg/JpegImageMetadata.java
@@ -71,7 +71,7 @@ public class JpegImageMetadata implements ImageMetadata {
}
/**
- * Get the thumbnail image if available.
+ * Gets the thumbnail image if available.
*
* @return the thumbnail image. May be {@code null} if no image could
* be found.
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffImageData.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffImageData.java
index 80a34ae3..3dcab571 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffImageData.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/AbstractTiffImageData.java
@@ -123,7 +123,7 @@ public abstract class AbstractTiffImageData {
}
/**
- * Get the height of individual tiles. Note that if the overall
+ * Gets the height of individual tiles. Note that if the overall
* image height is not a multiple of the tile height, then
* the last row of tiles may extend beyond the image height.
* @return an integer value greater than zero
@@ -133,7 +133,7 @@ public abstract class AbstractTiffImageData {
}
/**
- * Get the width of individual tiles. Note that if the overall
+ * Gets the width of individual tiles. Note that if the overall
* image width is not a multiple of the tile width, then
* the last column of tiles may extend beyond the image width.
* @return an integer value greater than zero
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 9befaa46..33cf5388 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
@@ -122,7 +122,7 @@ public class TiffImagingParameters extends
XmpImagingParameters<TiffImagingParam
}
/**
- * Get the TIFF output set for writing TIFF files.
+ * Gets the TIFF output set for writing TIFF files.
* @return if set, a valid instance; otherwise, a null reference.
*/
public TiffOutputSet getOutputSet() {
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterStatistics.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterStatistics.java
index ec2012b8..1d349395 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterStatistics.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/TiffRasterStatistics.java
@@ -75,7 +75,7 @@ public class TiffRasterStatistics {
}
/**
- * Get the count of the number of null samples in the collection.
+ * Gets the count of the number of null samples in the collection.
*
* @return the a positive number, potentially zero
*/
@@ -84,7 +84,7 @@ public class TiffRasterStatistics {
}
/**
- * Get the count of the number of non-null and non-excluded samples in the
+ * Gets the count of the number of non-null and non-excluded samples in the
* collection.
*
* @return the a positive number, potentially zero
@@ -94,7 +94,7 @@ public class TiffRasterStatistics {
}
/**
- * Get the value that was set for exclusion, or a Float.NaN if not was
+ * Gets the value that was set for exclusion, or a Float.NaN if not was
* set.
*
* @return the excluded value (if any).
@@ -104,7 +104,7 @@ public class TiffRasterStatistics {
}
/**
- * Get the maximum value found in the source data
+ * Gets the maximum value found in the source data
*
* @return the maximum value found in the source data
*/
@@ -113,7 +113,7 @@ public class TiffRasterStatistics {
}
/**
- * Get the mean value for all sample values in the raster. Null-data values
+ * Gets the mean value for all sample values in the raster. Null-data
values
* and excluded values are not considered.
*
* @return the mean value of the samples
@@ -123,7 +123,7 @@ public class TiffRasterStatistics {
}
/**
- * Get the minimum value found in the source data
+ * Gets the minimum value found in the source data
*
* @return the minimum value found in the source data
*/
diff --git
a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PhotometricInterpreterFloat.java
b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PhotometricInterpreterFloat.java
index 980eecbf..cbd146de 100644
---
a/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PhotometricInterpreterFloat.java
+++
b/src/main/java/org/apache/commons/imaging/formats/tiff/photometricinterpreters/floatingpoint/PhotometricInterpreterFloat.java
@@ -182,7 +182,7 @@ public class PhotometricInterpreterFloat extends
PhotometricInterpreter {
}
/**
- * Get the mean of the values found while processing
+ * Gets the mean of the values found while processing
*
* @return if data was processed, a valid mean value; otherwise, a zero.
*/
