[
https://issues.apache.org/jira/browse/IMAGING-159?focusedWorklogId=623997&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-623997
]
ASF GitHub Bot logged work on IMAGING-159:
------------------------------------------
Author: ASF GitHub Bot
Created on: 17/Jul/21 05:32
Start Date: 17/Jul/21 05:32
Worklog Time Spent: 10m
Work Description: kinow commented on a change in pull request #116:
URL: https://github.com/apache/commons-imaging/pull/116#discussion_r671615265
##########
File path: src/main/java/org/apache/commons/imaging/ImagingParameters.java
##########
@@ -0,0 +1,108 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.imaging;
+
+import org.apache.commons.imaging.common.BufferedImageFactory;
+
+/**
+ * Imaging parameters.
+ *
+ * <p>Contains parameters that are common to all formats. Implementations must
include
+ * the specific parameters for each image format.</p>
+ *
+ * @since 1.0-alpha3
+ */
+public class ImagingParameters {
+
+ /**
+ * Whether to throw an exception when any issue occurs during reading
+ * or writing a file format. Default is {@code false}.
+ */
+ private boolean strict = false;
+
+ /**
+ * An optional file name, used for the description of input streams
+ * where a file name would be hard (or not possible) to be identified.
+ * Default is {@code null}.
+ */
+ private String fileName = null;
+
+ /**
+ * Factory to create {@code BufferedImage}s. Default is {@code null}.
+ */
+ private BufferedImageFactory bufferedImageFactory = null;
+
+ /**
+ * Image format used in write operations to indicate desired image format.
+ * Default is {@code null}.
+ *
+ * <p>Valid values: Any format defined in ImageFormat, such as
+ * ImageFormat.IMAGE_FORMAT_PNG.</p>
+ *
+ * @see org.apache.commons.imaging.ImageFormats
+ */
+ private ImageFormat imageFormat;
Review comment:
Excellent idea! That reduced the code smell, where I had a
`setImageFormat` in the constructor of each parameter class and, as you
pointed, users could create objects with invalid states. Thanks @darkma773r!
--
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]
Issue Time Tracking
-------------------
Worklog Id: (was: 623997)
Time Spent: 5h 10m (was: 5h)
> There should be a Parameters class
> ----------------------------------
>
> Key: IMAGING-159
> URL: https://issues.apache.org/jira/browse/IMAGING-159
> Project: Commons Imaging
> Issue Type: Improvement
> Components: imaging.*
> Affects Versions: 1.0-alpha2
> Reporter: Benedikt Ritter
> Assignee: Bruno P. Kinoshita
> Priority: Major
> Labels: github
> Fix For: 1.0-alpha3
>
> Time Spent: 5h 10m
> Remaining Estimate: 0h
>
> Currently options for image I/O are defined as Maps. The leads to the problem
> that our code has to validate parameter types when they are used:
> {code:java}
> final Object value = params.get(PARAM_KEY_COMPRESSION);
> if (value != null) {
> if (!(value instanceof Number)) {
> throw new ImageWriteException(
> "Invalid compression parameter, must be numeric: "
> + value);
> }
> compression = ((Number) value).intValue();
> }
> {code}
> This can be simplified if we define a Parameters class that provides
> additional methods like {{public int getInt(String key)}}. The implementation
> could then look up the value from the map through an exception if it is null
> or not a number.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
