darkma773r commented on a change in pull request #116:
URL: https://github.com/apache/commons-imaging/pull/116#discussion_r673625407
##########
File path: src/main/java/org/apache/commons/imaging/ImageParser.java
##########
@@ -79,25 +78,18 @@
* that the documentation is perfect, especially in the more obscure
* and specialized areas of implementation.
*
- * <h3>The "Map params" argument</h3>
+ * <h3>The "params" argument</h3>
*
- * Many of the methods specified by this class accept an argument of
- * type Map giving a list of parameters to be used when processing an
- * image. For example, some of the output formats permit the specification
+ * <p>Many of the methods specified by this class accept an argument of
+ * type {@code T} defining the parameters to be used when
+ * processing an image. For example, some of the output formats permit
* of different kinds of image compression or color models. Some of the
* reading methods permit the calling application to require strict
- * format compliance. In many cases, however, an application will not
- * require the use of this argument. While some of the ImageParser
- * implementations check for (and ignore) null arguments for this parameter,
- * not all of them do (at least not at the time these notes were written).
- * Therefore, a prudent programmer will always supply an valid, though
- * empty instance of a Map implementation when calling such methods.
- * Generally, the java HashMap class is useful for this purpose.
+ * format compliance.</p>
*
- * <p>Additionally, developers creating or enhancing classes derived
- * from ImageParser are encouraged to include such checks in their code.
+ * @param <T> type of parameters used by this image parser
*/
-public abstract class ImageParser extends BinaryFileParser {
+public abstract class ImageParser<T extends ImagingParameters> extends
BinaryFileParser {
Review comment:
@gwlucastrig, your approach is almost exactly like the one I was going
to suggest :-)
- Have `ImageParser` and other classes accept `ImagingParameters` directly.
- Add format-specific parameter overloads of these methods as needed,
- Have the general methods either cast the general `ImagingParameters` to
the format-specific ones or use a copy constructor to extract relevant fields
while leaving others as defaults.
> I'm leaning to the "just let it go option", but here's one way that the
run-time checking could be accomplished.
I'm also leaning toward the "just let it go option" for users that pass
format-specific parameters to parsers of the wrong format type. In my mind, any
format-specific parameters that do not apply should just be ignored. I'm
guessing this was the case when the API used a `Map` to pass parameters so we
shouldn't be losing anything. I would also not expect a method that accepts an
`ImagingParameters` argument to succeed if I pass one parameter subclass but
not another one.
Side note: @kinow, I'm looking at the `ImagingParameters` class and I can't
find any usages of the `getImageFormat()` method elsewhere in the code. Is that
method used anywhere?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
