Merge/1.3 in 1.4 (#1121)

Pick enhancements from 1.3 into 1.4

- Shandra's IndirectObjects
- Lonzak's ECDSA fixes
- Many @OVERRIDES
- Javadoc
- Cleanups

.github/workflows/checkstyle.yml

@@ -1,19 +1,15 @@
 name: OpenPDF checkstyle
-on:
-  push:
-    branches: [ '*' ]
-  pull_request:
-    branches: [ '*' ]
+on: [ push, pull_request ]
 
 jobs:
   checkstyle_job:
     runs-on: ubuntu-latest
     name: Checkstyle job
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.1.1
+        uses: actions/checkout@v4
       - name: Run check style
-        uses: dbelyaev/action-checkstyle@v1.2.1
+        uses: dbelyaev/action-checkstyle@v1
         with:
           checkstyle_config: 'checkstyle.xml'
           reporter: 'github-pr-check'

.github/workflows/codacy-coverage-reporter.yaml

@@ -0,0 +1,24 @@
+name: Codacy Coverage Reporter
+
+on: [ push ]
+
+jobs:
+  codacy-coverage-reporter:
+    runs-on: ubuntu-latest
+    name: codacy-coverage-reporter
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+
+      - name: Create coverage reports
+        run: mvn -B verify --file pom.xml
+
+      - name: Run codacy-coverage-reporter
+        uses: codacy/codacy-coverage-reporter-action@v1
+        with:
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          coverage-reports: ./openpdf/target/site/jacoco/jacoco.xml, ./pdf-toolbox/target/site/jacoco/jacoco.xml, ./openpdf-fonts-extra/target/site/jacoco/jacoco.xml

.github/workflows/maven.yml

@@ -2,53 +2,25 @@
 # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
 
 name: OpenPDF maven build
-on:
-  push:
-    branches: [ '*' ]
-  pull_request:
-    branches: [ master, 1.3-java8, 1.4-java11 ]
+on: [ push, pull_request ]
 
 permissions:
   contents: read
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        # Java 11 in this branch 1.4-java11
-        java: [ 11 ]
-    name: Java ${{matrix.java}}
+    name: Build with Java 11
     steps:
-      - uses: actions/checkout@v4.1.1
-      - name: Setup java
-        uses: actions/setup-java@v4
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-java@v4
         with:
           distribution: temurin
-          java-version: ${{matrix.java}}
+          java-version: 11
+
       - name: Check maven version
         run: mvn -v; echo "** ls **"; pwd && ls -l
-      - name: Build with Maven
-        run: mvn -B install --file pom.xml
 
-  codacy-coverage-reporter:
-    runs-on: ubuntu-latest
-    name: Java 17 and codacy-coverage-reporter
-    steps:
-      - uses: actions/[email protected]
-      - name: Setup java
-        uses: actions/setup-java@v4
-        with:
-          distribution: temurin
-          java-version: 17
       - name: Build with Maven
-        run: mvn -B verify --file pom.xml
-      - name: Run codacy-coverage-reporter
-        uses: codacy/codacy-coverage-reporter-action@v1
-        with:
-          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
-          # or
-          # api-token: ${{ secrets.CODACY_API_TOKEN }}
-          coverage-reports: ./openpdf/target/site/jacoco/jacoco.xml,./pdf-toolbox/target/site/jacoco/jacoco.xml,./openpdf-fonts-extra/target/site/jacoco/jacoco.xml
-          # or a comma-separated list for multiple reports
-          # coverage-reports: <PATH_TO_REPORT>, <PATH_TO_REPORT>
+        run: mvn -B install --file pom.xml

changelogs/1.3.32.md

@@ -18,4 +18,4 @@
 * Bump com.ibm.icu:icu4j from 73.2 to 74.1 (#976)
 * Bump org.pitest:pitest-junit5-plugin from 1.2.0 to 1.2.1 (#975)
 * Bump org.apache.maven.plugins:maven-clean-plugin from 3.3.1 to 3.3.2
-* Bump org.apache.maven.plugins:maven-checkstyle-plugin (#978) 
+* Bump org.apache.maven.plugins:maven-checkstyle-plugin (#978)

openpdf/src/main/java/com/lowagie/text/ExceptionConverter.java

@@ -89,7 +89,7 @@ public class ExceptionConverter extends RuntimeException {
      */
     public ExceptionConverter(Exception ex) {
         this.ex = ex;
-        prefix = (ex instanceof RuntimeException) ? "" : "ExceptionConverter: ";
+        this.prefix = (ex instanceof RuntimeException) ? "" : "ExceptionConverter: ";
     }
 
     /**
@@ -113,39 +113,43 @@ public static final RuntimeException convertException(Exception ex) {
      * @return the original exception
      */
     public Exception getException() {
-        return ex;
+        return this.ex;
     }
 
     /**
      * We print the message of the checked exception
      *
      * @return message of the original exception
      */
+    @Override
     public String getMessage() {
-        return ex.getMessage();
+        return this.ex.getMessage();
     }
 
     /**
      * and make sure we also produce a localized version
      *
      * @return localized version of the message
      */
+    @Override
     public String getLocalizedMessage() {
-        return ex.getLocalizedMessage();
+        return this.ex.getLocalizedMessage();
     }
 
     /**
      * The toString() is changed to be prefixed with ExceptionConverter
      *
      * @return String version of the exception
      */
+    @Override
     public String toString() {
-        return prefix + ex;
+        return this.prefix + this.ex;
     }
 
     /**
      * we have to override this as well
      */
+    @Override
     public void printStackTrace() {
         printStackTrace(System.err);
     }
@@ -155,10 +159,11 @@ public void printStackTrace() {
      *
      * @param printStream printStream
      */
+    @Override
     public void printStackTrace(java.io.PrintStream printStream) {
         synchronized (printStream) {
-            printStream.print(prefix);
-            ex.printStackTrace(printStream);
+            printStream.print(this.prefix);
+            this.ex.printStackTrace(printStream);
         }
     }
 
@@ -167,10 +172,11 @@ public void printStackTrace(java.io.PrintStream printStream) {
      *
      * @param printWriter printWriter
      */
+    @Override
     public void printStackTrace(java.io.PrintWriter printWriter) {
         synchronized (printWriter) {
-            printWriter.print(prefix);
-            ex.printStackTrace(printWriter);
+            printWriter.print(this.prefix);
+            this.ex.printStackTrace(printWriter);
         }
     }
 
@@ -180,6 +186,7 @@ public void printStackTrace(java.io.PrintWriter printWriter) {
      *
      * @return a Throwable
      */
+    @Override
     public synchronized Throwable fillInStackTrace() {
         return this;
     }

openpdf/src/main/java/com/lowagie/text/html/simpleparser/FactoryProperties.java

@@ -219,7 +219,13 @@ public static HyphenationEvent getHyphenation(String s) {
         return new HyphenationAuto(lang, country, leftMin, rightMin);
     }
 
-    @Deprecated
+    /**
+     * This method isn't used by iText, but you can use it to analyze the value of a style attribute inside a HashMap.
+     * The different elements of the style attribute are added to the HashMap as key-value pairs.
+     *
+     * @param h a Map that should have at least a key named style. After this method is invoked, more keys could be
+     *          added.
+     */
     // this method is nor called anywhere. But it is public so theoretically it could be called by consumers of OpenPdf, but why?
     public static void insertStyle(Map<String, String> h) {
         String style = h.get("style");

openpdf/src/main/java/com/lowagie/text/pdf/AcroFields.java

@@ -198,7 +198,7 @@ public static Object[] splitDAelements(String da) {
                             }
                             break;
                         case "g":
-                            if (stack.size() >= 1) {
+                            if (!stack.isEmpty()) {
                                 float gray = Float.parseFloat(stack.get(stack.size() - 1));
                                 if (gray != 0) {
                                     ret[DA_COLOR] = new GrayColor(gray);
@@ -283,7 +283,7 @@ void fill() {
             return;
         }
         PdfArray arrfds = (PdfArray) PdfReader.getPdfObjectRelease(top.get(PdfName.FIELDS));
-        if (arrfds == null || arrfds.size() == 0) {
+        if (arrfds == null || arrfds.isEmpty()) {
             return;
         }
         for (int k = 1; k <= reader.getNumberOfPages(); ++k) {
@@ -344,7 +344,7 @@ void fill() {
                         annot = null;
                     }
                 }
-                if (name.length() > 0) {
+                if (!name.isEmpty()) {
                     name = name.substring(0, name.length() - 1);
                 }
                 Item item = fields.get(name);
@@ -466,21 +466,20 @@ public String[] getAppearanceStates(String fieldName) {
      * @return String[] of appearance names or null if the field can not be found
      */
     public String[] getAppearanceNames(String fieldName, int idx) {
-        Item fd = (Item) this.fields.get(fieldName);
+        Item fd = this.fields.get(fieldName);
         if (fd == null) {
             return null;
         }
-        ArrayList<String> names = new ArrayList<String>();
+        ArrayList<String> names = new ArrayList<>();
 
         PdfDictionary dic = fd.getWidget(idx);
         dic = dic.getAsDict(PdfName.AP);
         if (dic != null) {
             dic = dic.getAsDict(PdfName.N);
             if (dic != null) {
 
-                Iterator it = dic.getKeys().iterator();
-                while (it.hasNext()) {
-                    String name = PdfName.decodeName(((PdfName) it.next()).toString());
+                for (PdfName pdfName : dic.getKeys()) {
+                    String name = PdfName.decodeName(pdfName.toString());
                     if (!names.contains(name)) {
                         names.add(name);
                     }
@@ -799,7 +798,6 @@ public void decodeGenericDictionary(PdfDictionary merged, BaseField tx) throws D
         }
         //flags
         PdfNumber nfl = merged.getAsNumber(PdfName.F);
-        flags = 0;
         tx.setVisibility(BaseField.VISIBLE_BUT_DOES_NOT_PRINT);
         if (nfl != null) {
             flags = nfl.intValue();
@@ -870,7 +868,7 @@ PdfAppearance getAppearance(PdfDictionary merged, String[] values, String fieldN
         topFirst = 0;
         String text = (values.length > 0) ? values[0] : null;
 
-        TextField tx = null;
+        TextField tx;
         if (fieldCache == null || !fieldCache.containsKey(fieldName)) {
             tx = new TextField(writer, null, null);
             tx.setExtraMargin(extraMarginLeft, extraMarginTop);
@@ -1055,7 +1053,7 @@ public String getField(String name) {
             }
             PdfArray opts = item.getValue(0).getAsArray(PdfName.OPT);
             if (opts != null) {
-                int idx = 0;
+                int idx;
                 try {
                     idx = Integer.parseInt(value);
                     PdfString ps = opts.getAsString(idx);
@@ -1072,7 +1070,7 @@ public String getField(String name) {
         } else if (v instanceof PdfName) {
             return PdfName.decodeName(v.toString());
         } else if (v instanceof PdfArray) {
-            return ((PdfArray) v).toString();
+            return v.toString();
         } else {
             return "";
         }
@@ -1097,10 +1095,6 @@ public String[] getListSelection(String name) {
         if (item == null) {
             return ret;
         }
-        //PdfName type = (PdfName)PdfReader.getPdfObject(((PdfDictionary)item.merged.get(0)).get(PdfName.FT));
-        //if (!PdfName.CH.equals(type)) {
-        //    return ret;
-        //}
         PdfArray values = item.getMerged(0).getAsArray(PdfName.I);
         if (values == null) {
             return ret;
@@ -1320,7 +1314,7 @@ public Object getFieldProperty(String field, String name, int idx) {
             throw new RuntimeException("No reader has been supplied to this AcroFields instance!");
         }
         try {
-            Item item = (Item) this.fields.get(field);
+            Item item = this.fields.get(field);
             if (item == null) {
                 return false;
             }
@@ -2225,7 +2219,7 @@ public HashMap<String, SignatureType> getSignatureTypes() {
             }
 
             PdfArray ref = v.getAsArray(PdfName.REFERENCE);
-            if (ref == null || ref.size() == 0) {
+            if (ref == null || ref.isEmpty()) {
                 this.sigTypes.put(entry.getKey(), SignatureType.APPROVAL);
             } else {
 
@@ -2859,7 +2853,7 @@ public Item(PdfIndirectReference ref) {
          */
         public void writeToAll(PdfName key, PdfObject value, int writeFlags) {
             int i;
-            PdfDictionary curDict = null;
+            PdfDictionary curDict;
             if ((writeFlags & WRITE_MERGED) != 0) {
                 for (i = 0; i < merged.size(); ++i) {
                     curDict = getMerged(i);
@@ -3102,6 +3096,7 @@ private RevisionStream(RandomAccessFileOrArray raf, int length) {
             this.length = length;
         }
 
+        @Override
         public int read() throws IOException {
             int n = read(b);
             if (n != 1) {
@@ -3110,6 +3105,7 @@ public int read() throws IOException {
             return b[0] & 0xff;
         }
 
+        @Override
         public int read(byte[] b, int off, int len) throws IOException {
             if (b == null) {
                 throw new NullPointerException();
@@ -3129,6 +3125,7 @@ public int read(byte[] b, int off, int len) throws IOException {
             return elen;
         }
 
+        @Override
         public void close() throws IOException {
             if (!closed) {
                 raf.close();
@@ -3139,6 +3136,7 @@ public void close() throws IOException {
 
     private static class SorterComparator implements Comparator<Object[]> {
 
+        @Override
         public int compare(Object[] o1, Object[] o2) {
             int n1 = ((int[]) o1[1])[0];
             int n2 = ((int[]) o2[1])[0];