Deprecate Pair<> class and remove all of its usages

DEVSIX-9068

Author: Dmitry Radchuk

commons/src/main/java/com/itextpdf/commons/utils/Pair.java

@@ -27,7 +27,10 @@ This file is part of the iText (R) project.
  *
  * @param <K> key parameter type.
  * @param <V> value parameter type.
+ *
+ * @deprecated in favour of {@link com.itextpdf.commons.datastructures.Tuple2}
  */
+@Deprecated
 public class Pair<K, V> {
     private final K key;
     private final V value;

sign/src/main/java/com/itextpdf/signatures/validation/DocumentRevisionsValidator.java

@@ -23,8 +23,8 @@ This file is part of the iText (R) project.
 package com.itextpdf.signatures.validation;
 
 import com.itextpdf.commons.actions.contexts.IMetaInfo;
+import com.itextpdf.commons.datastructures.Tuple2;
 import com.itextpdf.commons.utils.MessageFormatUtil;
-import com.itextpdf.commons.utils.Pair;
 import com.itextpdf.forms.PdfAcroForm;
 import com.itextpdf.forms.fields.PdfFormAnnotationUtil;
 import com.itextpdf.forms.fields.PdfFormCreator;
@@ -159,7 +159,7 @@ public class DocumentRevisionsValidator {
     private Set<PdfDictionary> newlyAddedFields;
     private Set<PdfDictionary> removedTaggedObjects;
     private Set<PdfDictionary> addedTaggedObjects;
-    private Pair<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects;
+    private Tuple2<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects;
 
     /**
      * Creates new instance of {@link DocumentRevisionsValidator}.
@@ -350,7 +350,7 @@ private void mergeRevisionsInLinearizedDocument(PdfDocument document, List<Docum
 
     private boolean validateRevision(ValidationReport validationReport, ValidationContext context,
             PdfDocument documentWithoutRevision, PdfDocument documentWithRevision, DocumentRevision currentRevision) {
-        usuallyModifiedObjects = new Pair<>(createUsuallyModifiedObjectsSet(documentWithoutRevision),
+        usuallyModifiedObjects = new Tuple2<>(createUsuallyModifiedObjectsSet(documentWithoutRevision),
                 createUsuallyModifiedObjectsSet(documentWithRevision));
         if (!compareCatalogs(documentWithoutRevision, documentWithRevision, validationReport, context)) {
             return false;
@@ -1575,19 +1575,19 @@ private void removeAppearanceRelatedProperties(PdfDictionary annotDict) {
     //
 
     private static boolean comparePdfObjects(PdfObject pdfObject1, PdfObject pdfObject2,
-            Pair<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
+            Tuple2<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
         return comparePdfObjects(pdfObject1, pdfObject2, new ArrayList<>(), usuallyModifiedObjects);
     }
 
     private static boolean comparePdfObjects(PdfObject pdfObject1, PdfObject pdfObject2,
-            List<Pair<PdfObject, PdfObject>> visitedObjects,
-            Pair<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
-        for (Pair<PdfObject, PdfObject> pair : visitedObjects) {
-            if (pair.getKey() == pdfObject1) {
-                return pair.getValue() == pdfObject2;
+            List<Tuple2<PdfObject, PdfObject>> visitedObjects,
+            Tuple2<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
+        for (Tuple2<PdfObject, PdfObject> pair : visitedObjects) {
+            if (pair.getFirst() == pdfObject1) {
+                return pair.getSecond() == pdfObject2;
             }
         }
-        visitedObjects.add(new Pair<>(pdfObject1, pdfObject2));
+        visitedObjects.add(new Tuple2<>(pdfObject1, pdfObject2));
         if (Objects.equals(pdfObject1, pdfObject2)) {
             return true;
         }
@@ -1598,10 +1598,10 @@ private static boolean comparePdfObjects(PdfObject pdfObject1, PdfObject pdfObje
             return false;
         }
         if (pdfObject1.getIndirectReference() != null &&
-                usuallyModifiedObjects.getKey().stream().anyMatch(
+                usuallyModifiedObjects.getFirst().stream().anyMatch(
                         reference -> isSameReference(reference, pdfObject1.getIndirectReference())) &&
                 pdfObject2.getIndirectReference() != null &&
-                usuallyModifiedObjects.getValue().stream().anyMatch(
+                usuallyModifiedObjects.getSecond().stream().anyMatch(
                         reference -> isSameReference(reference, pdfObject2.getIndirectReference()))) {
             // These two objects are expected to not be completely equal, we check them independently.
             // However, we still need to make sure those are same instances.
@@ -1638,8 +1638,8 @@ private static boolean comparePdfObjects(PdfObject pdfObject1, PdfObject pdfObje
     }
 
     private static boolean comparePdfArrays(PdfArray array1, PdfArray array2,
-            List<Pair<PdfObject, PdfObject>> visitedObjects,
-            Pair<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
+            List<Tuple2<PdfObject, PdfObject>> visitedObjects,
+            Tuple2<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
         if (array1.size() != array2.size()) {
             return false;
         }
@@ -1652,8 +1652,8 @@ private static boolean comparePdfArrays(PdfArray array1, PdfArray array2,
     }
 
     private static boolean comparePdfDictionaries(PdfDictionary dictionary1, PdfDictionary dictionary2,
-            List<Pair<PdfObject, PdfObject>> visitedObjects,
-            Pair<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
+            List<Tuple2<PdfObject, PdfObject>> visitedObjects,
+            Tuple2<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
         Set<Map.Entry<PdfName, PdfObject>> entrySet1 = dictionary1.entrySet();
         Set<Map.Entry<PdfName, PdfObject>> entrySet2 = dictionary2.entrySet();
         if (entrySet1.size() != entrySet2.size()) {
@@ -1669,8 +1669,8 @@ private static boolean comparePdfDictionaries(PdfDictionary dictionary1, PdfDict
     }
 
     private static boolean comparePdfStreams(PdfStream stream1, PdfStream stream2,
-            List<Pair<PdfObject, PdfObject>> visitedObjects,
-            Pair<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
+            List<Tuple2<PdfObject, PdfObject>> visitedObjects,
+            Tuple2<Set<PdfIndirectReference>, Set<PdfIndirectReference>> usuallyModifiedObjects) {
         return Arrays.equals(stream1.getBytes(), stream2.getBytes()) &&
                 comparePdfDictionaries(stream1, stream2, visitedObjects, usuallyModifiedObjects);
     }

sign/src/main/java/com/itextpdf/signatures/validation/report/xml/SignatureValidationStatus.java

@@ -22,7 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.signatures.validation.report.xml;
 
-import com.itextpdf.commons.utils.Pair;
+import com.itextpdf.commons.datastructures.Tuple2;
 import com.itextpdf.io.util.EnumUtil;
 
 import java.util.ArrayList;
@@ -31,13 +31,16 @@ This file is part of the iText (R) project.
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Class which represents signature validation status.
+ */
 class SignatureValidationStatus {
     private static final Map<MainIndication, String> MAIN_INDICATION_VALUE_MAP =
             new HashMap<MainIndication, String>(EnumUtil.getAllValuesOfEnum(MainIndication.class).size());
     private static final Map<MessageType, String> MESSAGE_TYPE_VALUE_MAP =
             new HashMap<MessageType, String>(EnumUtil.getAllValuesOfEnum(MessageType.class).size());
 
-    private final List<Pair<String, String>> messages = new ArrayList<>();
+    private final List<Tuple2<String, String>> messages = new ArrayList<>();
 
     private MainIndication mainIndication;
     private SubIndication subIndication;
@@ -55,43 +58,85 @@ class SignatureValidationStatus {
         MESSAGE_TYPE_VALUE_MAP.put(MessageType.ERROR, "urn:cef:dss:message:error");
     }
 
+    /**
+     * Creates an empty {@link SignatureValidationStatus} instance.
+     */
     public SignatureValidationStatus() {
         // Declaring default constructor explicitly to avoid removing it unintentionally.
     }
 
+    /**
+     * Sets the main status indication.
+     *
+     * @param mainIndication {@link MainIndication} value
+     */
     public void setMainIndication(MainIndication mainIndication) {
         this.mainIndication = mainIndication;
     }
 
+    /**
+     * Gets the main status indication.
+     */
     public MainIndication getMainIndication() {
         return mainIndication;
     }
 
+    /**
+     * Gets URI representation of the validation status (see ETSI TS 119 102 4.3.4.2).
+     *
+     * @return validation status as string
+     */
     public String getMainIndicationAsString() {
         return MAIN_INDICATION_VALUE_MAP.get(mainIndication);
     }
 
+    /**
+     * Sets sub-indication that shall clearly identify the reason for the main status indication.
+     *
+     * @param subIndication {@link SubIndication} value
+     */
     public void setSubIndication(SubIndication subIndication) {
         this.subIndication = subIndication;
         this.subIndicationSet = true;
     }
 
+    /**
+     * Gets sub-indication that shall clearly identify the reason for the main status indication.
+     *
+     * @return {@link SubIndication} value
+     */
     public SubIndication getSubIndication() {
         return subIndication;
     }
 
+    /**
+     * Gets sub-indication that shall clearly identify the reason for the main status indication.
+     *
+     * @return sub-indication value as string
+     */
     public String getSubIndicationAsString() {
         if (!subIndicationSet) {
             return null;
         }
         return subIndication.toString();
     }
 
+    /**
+     * Adds message for validation report data.
+     *
+     * @param reason message reason as string
+     * @param messageType {@link MessageType}
+     */
     public void addMessage(String reason, MessageType messageType) {
-        this.messages.add(new Pair<>(reason, MESSAGE_TYPE_VALUE_MAP.get(messageType)));
+        this.messages.add(new Tuple2<>(reason, MESSAGE_TYPE_VALUE_MAP.get(messageType)));
     }
 
-    public Collection<Pair<String, String>> getMessages() {
+    /**
+     * Gets all reported messages.
+     *
+     * @return Collection of reported messages
+     */
+    public Collection<Tuple2<String, String>> getMessages() {
         return messages;
     }
 

sign/src/main/java/com/itextpdf/signatures/validation/report/xml/XmlReportGenerator.java

@@ -22,7 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.signatures.validation.report.xml;
 
-import com.itextpdf.commons.utils.Pair;
+import com.itextpdf.commons.datastructures.Tuple2;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
@@ -137,20 +137,20 @@ private static void addSignatureReport(Document doc, Element root, SignatureVali
             subIndicationNode.setTextContent(subIndication);
             status.appendChild(subIndicationNode);
         }
-        Collection<Pair<String, String>> messages = signatureValidation.getSignatureValidationStatus().getMessages();
+        Collection<Tuple2<String, String>> messages = signatureValidation.getSignatureValidationStatus().getMessages();
         if (!messages.isEmpty()) {
             Node associatedValidationReportData = doc.createElement("AssociatedValidationReportData");
             status.appendChild(associatedValidationReportData);
             Node additionalValidationReportData = doc.createElement("AdditionalValidationReportData");
             associatedValidationReportData.appendChild(additionalValidationReportData);
-            for (Pair<String, String> message : messages) {
+            for (Tuple2<String, String> message : messages) {
                 Node reportData = doc.createElement("ReportData");
                 Node type = doc.createElement("Type");
-                type.setTextContent(message.getValue());
+                type.setTextContent(message.getSecond());
                 reportData.appendChild(type);
                 Element value = doc.createElement("Value");
                 value.setAttribute("xsi:type", "xs:string");
-                value.setTextContent(message.getKey());
+                value.setTextContent(message.getFirst());
                 reportData.appendChild(value);
                 additionalValidationReportData.appendChild(reportData);
             }