[commons-imaging] 02/02: Make String descriptions consistent and simple

[ggregory]

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

commit 06c0cc88bdf48217caff6afd2d0bd6198d9331fa
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed May 31 18:31:25 2023 -0400

    Make String descriptions consistent and simple
---
 .../java/org/apache/commons/imaging/bytesource/ByteSource.java     | 4 +++-
 .../org/apache/commons/imaging/bytesource/ByteSourceArray.java     | 7 +------
 .../java/org/apache/commons/imaging/bytesource/ByteSourceFile.java | 5 -----
 .../apache/commons/imaging/bytesource/ByteSourceInputStream.java   | 5 -----
 .../org/apache/commons/imaging/bytesource/ByteSourceDataTest.java  | 1 -
 .../java/org/apache/commons/imaging/bytesource/ByteSourceTest.java | 1 -
 6 files changed, 4 insertions(+), 19 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/imaging/bytesource/ByteSource.java 
b/src/main/java/org/apache/commons/imaging/bytesource/ByteSource.java
index eff421cd..6e6f6115 100644
--- a/src/main/java/org/apache/commons/imaging/bytesource/ByteSource.java
+++ b/src/main/java/org/apache/commons/imaging/bytesource/ByteSource.java
@@ -52,7 +52,9 @@ public abstract class ByteSource {
 
     public abstract byte[] getBlock(long from, int length) throws IOException;
 
-    public abstract String getDescription();
+    public String getDescription() {
+        return getClass().getSimpleName() + "[" + getFileName() + "]";
+    }
 
     public final String getFileName() {
         return fileName;
diff --git 
a/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceArray.java 
b/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceArray.java
index e857a01f..326fc3d7 100644
--- a/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceArray.java
+++ b/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceArray.java
@@ -40,7 +40,7 @@ class ByteSourceArray extends ByteSource {
         int start;
         try {
             start = Math.toIntExact(from);
-        } catch (ArithmeticException e) {
+        } catch (final ArithmeticException e) {
             throw new ImagingException(e);
         }
         // We include a separate check for int overflow.
@@ -54,11 +54,6 @@ class ByteSourceArray extends ByteSource {
         return Arrays.copyOfRange(bytes, start, start + length);
     }
 
-    @Override
-    public String getDescription() {
-        return bytes.length + " byte array";
-    }
-
     @Override
     public InputStream getInputStream() {
         return new ByteArrayInputStream(bytes);
diff --git 
a/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceFile.java 
b/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceFile.java
index 2d3fe7e6..4e8fd60e 100644
--- a/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceFile.java
+++ b/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceFile.java
@@ -48,11 +48,6 @@ class ByteSourceFile extends ByteSource {
         }
     }
 
-    @Override
-    public String getDescription() {
-        return "File: '" + file.getAbsolutePath() + "'";
-    }
-
     @Override
     public InputStream getInputStream() throws IOException {
         return new BufferedInputStream(Files.newInputStream(file.toPath()));
diff --git 
a/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceInputStream.java
 
b/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceInputStream.java
index 8194f6d0..e53217ae 100644
--- 
a/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceInputStream.java
+++ 
b/src/main/java/org/apache/commons/imaging/bytesource/ByteSourceInputStream.java
@@ -207,11 +207,6 @@ class ByteSourceInputStream extends ByteSource {
         }
     }
 
-    @Override
-    public String getDescription() {
-        return "Inputstream: '" + getFileName() + "'";
-    }
-
     private CacheBlock getFirstBlock() throws IOException {
         if (null == cacheHead) {
             cacheHead = readBlock();
diff --git 
a/src/test/java/org/apache/commons/imaging/bytesource/ByteSourceDataTest.java 
b/src/test/java/org/apache/commons/imaging/bytesource/ByteSourceDataTest.java
index ae95302b..e63fd4a9 100644
--- 
a/src/test/java/org/apache/commons/imaging/bytesource/ByteSourceDataTest.java
+++ 
b/src/test/java/org/apache/commons/imaging/bytesource/ByteSourceDataTest.java
@@ -29,7 +29,6 @@ import java.io.InputStream;
 import java.util.Arrays;
 import java.util.stream.Stream;
 
-import org.apache.commons.imaging.bytesource.ByteSource;
 import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
diff --git 
a/src/test/java/org/apache/commons/imaging/bytesource/ByteSourceTest.java 
b/src/test/java/org/apache/commons/imaging/bytesource/ByteSourceTest.java
index fa12f5b6..0bf443f1 100644
--- a/src/test/java/org/apache/commons/imaging/bytesource/ByteSourceTest.java
+++ b/src/test/java/org/apache/commons/imaging/bytesource/ByteSourceTest.java
@@ -28,7 +28,6 @@ import java.nio.file.Files;
 
 import org.apache.commons.imaging.ImagingConstants;
 import org.apache.commons.imaging.ImagingTest;
-import org.apache.commons.imaging.bytesource.ByteSource;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;