Proposal for a patch for Imaging-159 using a POJO #5
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,8 @@ | |
| * 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. | ||
| * | ||
| * Changed 2015 by Michael Gross, [email protected] | ||
| */ | ||
| package org.apache.commons.imaging; | ||
|
|
||
|
|
@@ -26,7 +28,6 @@ | |
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
|
|
||
| import org.apache.commons.imaging.common.BinaryFileParser; | ||
| import org.apache.commons.imaging.common.BufferedImageFactory; | ||
|
|
@@ -76,24 +77,6 @@ | |
| * the intentions of the original. Therefore, you should not assume | ||
| * that the documentation is perfect, especially in the more obscure | ||
| * and specialized areas of implementation. | ||
| */ | ||
| public abstract class ImageParser extends BinaryFileParser { | ||
|
|
||
|
|
@@ -169,7 +152,7 @@ public final ImageMetadata getMetadata(final ByteSource byteSource) throws Image | |
| * implementation. | ||
| * @throws IOException In the event of unsuccessful data read operation. | ||
| */ | ||
| public abstract ImageMetadata getMetadata(ByteSource byteSource, final ImagingParameters params) | ||
| throws ImageReadException, IOException; | ||
|
|
||
| /** | ||
|
|
@@ -215,7 +198,7 @@ public final ImageMetadata getMetadata(final byte[] bytes) throws ImageReadExcep | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful data read operation. | ||
| */ | ||
| public final ImageMetadata getMetadata(final byte[] bytes, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
| return getMetadata(new ByteSourceArray(bytes), params); | ||
| } | ||
|
|
@@ -264,7 +247,7 @@ public final ImageMetadata getMetadata(final File file) throws ImageReadExceptio | |
| * @throws IOException In the event of unsuccessful file read or | ||
| * access operation. | ||
| */ | ||
| public final ImageMetadata getMetadata(final File file, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
| if (getDebug()) { | ||
| System.out.println(getName() + ".getMetadata" + ": " | ||
|
|
@@ -302,7 +285,7 @@ public final ImageMetadata getMetadata(final File file, final Map<String, Object | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful data access operation. | ||
| */ | ||
| public abstract ImageInfo getImageInfo(ByteSource byteSource, final ImagingParameters params) | ||
| throws ImageReadException, IOException; | ||
|
|
||
| /** | ||
|
|
@@ -348,7 +331,7 @@ public final ImageInfo getImageInfo(final ByteSource byteSource) throws ImageRea | |
| * @throws IOException In the event of unsuccessful data | ||
| * access operation. | ||
| */ | ||
| public final ImageInfo getImageInfo(final byte[] bytes, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
| return getImageInfo(new ByteSourceArray(bytes), params); | ||
| } | ||
|
|
@@ -377,7 +360,7 @@ public final ImageInfo getImageInfo(final byte[] bytes, final Map<String, Object | |
| * @throws IOException In the event of unsuccessful file read or | ||
| * access operation. | ||
| */ | ||
| public final ImageInfo getImageInfo(final File file, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
| if (!canAcceptExtension(file)) { | ||
| return null; | ||
|
|
@@ -505,7 +488,7 @@ public final List<BufferedImage> getAllBufferedImages(final File file) throws Im | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public abstract BufferedImage getBufferedImage(ByteSource byteSource, final ImagingParameters params) | ||
| throws ImageReadException, IOException; | ||
|
|
||
| /** | ||
|
|
@@ -523,7 +506,7 @@ public abstract BufferedImage getBufferedImage(ByteSource byteSource, Map<String | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public final BufferedImage getBufferedImage(final byte[] bytes, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
| return getBufferedImage(new ByteSourceArray(bytes), params); | ||
| } | ||
|
|
@@ -543,7 +526,7 @@ public final BufferedImage getBufferedImage(final byte[] bytes, final Map<String | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public final BufferedImage getBufferedImage(final File file, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
| if (!canAcceptExtension(file)) { | ||
| return null; | ||
|
|
@@ -575,7 +558,7 @@ public final BufferedImage getBufferedImage(final File file, final Map<String, O | |
| * @throws IOException In the event of an write error from | ||
| * the output stream. | ||
| */ | ||
| public void writeImage(final BufferedImage src, final OutputStream os, final ImagingParameters params) | ||
| throws ImageWriteException, IOException { | ||
| os.close(); // we are obligated to close stream. | ||
|
|
||
|
|
@@ -609,7 +592,7 @@ public final Dimension getImageSize(final byte[] bytes) throws ImageReadExceptio | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public final Dimension getImageSize(final byte[] bytes, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
| return getImageSize(new ByteSourceArray(bytes), params); | ||
| } | ||
|
|
@@ -640,7 +623,7 @@ public final Dimension getImageSize(final File file) throws ImageReadException, | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public final Dimension getImageSize(final File file, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
|
|
||
| if (!canAcceptExtension(file)) { | ||
|
|
@@ -662,7 +645,7 @@ public final Dimension getImageSize(final File file, final Map<String, Object> p | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public abstract Dimension getImageSize(ByteSource byteSource, final ImagingParameters params) | ||
| throws ImageReadException, IOException; | ||
|
|
||
| /** | ||
|
|
@@ -682,7 +665,7 @@ public abstract Dimension getImageSize(ByteSource byteSource, Map<String, Object | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public abstract String getXmpXml(ByteSource byteSource, final ImagingParameters params) | ||
| throws ImageReadException, IOException; | ||
|
|
||
| /** | ||
|
|
@@ -715,7 +698,7 @@ public final byte[] getICCProfileBytes(final byte[] bytes) throws ImageReadExcep | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public final byte[] getICCProfileBytes(final byte[] bytes, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
| return getICCProfileBytes(new ByteSourceArray(bytes), params); | ||
| } | ||
|
|
@@ -750,7 +733,7 @@ public final byte[] getICCProfileBytes(final File file) throws ImageReadExceptio | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public final byte[] getICCProfileBytes(final File file, final ImagingParameters params) | ||
| throws ImageReadException, IOException { | ||
| if (!canAcceptExtension(file)) { | ||
| return null; | ||
|
|
@@ -777,7 +760,7 @@ public final byte[] getICCProfileBytes(final File file, final Map<String, Object | |
| * parser implementation. | ||
| * @throws IOException In the event of unsuccessful read or access operation. | ||
| */ | ||
| public abstract byte[] getICCProfileBytes(ByteSource byteSource, final ImagingParameters params) | ||
| throws ImageReadException, IOException; | ||
|
|
||
| /** | ||
|
|
@@ -846,6 +829,7 @@ public final String dumpImageFile(final ByteSource byteSource) | |
| * Write the ImageInfo and format-specific information for the image | ||
| * content of the specified byte source to a PrintWriter | ||
| * | ||
| * @param pw | ||
| * @param byteSource A valid byte source. | ||
| * @return A valid PrintWriter. | ||
| * @throws ImageReadException In the event that the the specified content | ||
|
|
@@ -954,13 +938,12 @@ protected final boolean canAcceptExtension(final String filename) { | |
| * @param params A valid Map object, or a null. | ||
| * @return A valid instance of an implementation of a IBufferedImageFactory. | ||
| */ | ||
| protected BufferedImageFactory getBufferedImageFactory(final ImagingParameters params) { | ||
| if (params == null || params.isBufferedImageFactoryPresent() == false) { | ||
| return new SimpleBufferedImageFactory(); | ||
| } | ||
|
|
||
| final BufferedImageFactory result = params.getBufferedImageFactory(); | ||
|
Member
There was a problem hiding this comment. As noted in JIRA, to me it feels strange to pass a BufferedImageFactory via a parameters object. But since this has been the case before this PR, I think we should first concentrate on getting the ImagingParameters in place and refactor the BufferedImageFactory later (if that is possible)
Member
There was a problem hiding this comment. Uh, really strange. Perhaps if it were the class only, not the instance, then I think it'd be fine. |
||
|
|
||
| if (null != result) { | ||
| return result; | ||
|
|
@@ -970,19 +953,18 @@ protected BufferedImageFactory getBufferedImageFactory(final Map<String, Object> | |
| } | ||
|
|
||
| /** | ||
| * A utility method to whether we have a parameter object and if the STRICT | ||
| * flag is set or not. | ||
| * Intended for internal use by ImageParser implementations. | ||
|
Member
There was a problem hiding this comment. Maybe some re-wording here "Return whether to use a strict mode or not when reading or writing images." or similar? |
||
| * | ||
| * @param params A valid parameter object (or a null). | ||
| * @return If the params specify strict format compliance, true; | ||
| * otherwise, false. | ||
| */ | ||
| public static boolean isStrict(final ImagingParameters params) { | ||
| if (params == null) { | ||
| return false; | ||
| } | ||
| return params.isStrictEnabled(); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This has to be removed from all files. Please file an ICLA.