Javadocs

Author: aulme

src/main/java/com/uid2/client/IdentityMapV3Input.java

@@ -7,7 +7,7 @@
 public class IdentityMapV3Input {
     /**
      * @param emails a list of normalized or unnormalized email addresses
-     * @return a IdentityMapV3Input instance, to be used in {@link IdentityMapHelper#createEnvelopeForIdentityMapRequest}
+     * @return a IdentityMapV3Input instance, to be used in {@link IdentityMapV3Helper#createEnvelopeForIdentityMapRequest}
      */
     public static IdentityMapV3Input fromEmails(List<String> emails) {
         return new IdentityMapV3Input().withEmails(emails);
@@ -47,53 +47,85 @@ public static IdentityMapV3Input fromHashedPhones(List<String> hashedPhones) {
 
     public IdentityMapV3Input() {}
 
+    /**
+     * @param hashedEmails a <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#email-address-normalization">normalized</a> and <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#email-address-hash-encoding">hashed</a> email address
+     * @return this IdentityMapV3Input instance
+     */
     public IdentityMapV3Input withHashedEmails(List<String> hashedEmails) {
         for (String hashedEmail : hashedEmails) {
             withHashedEmail(hashedEmail);
         }
         return this;
     }
 
+    /**
+     * @param hashedEmail a <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#email-address-normalization">normalized</a> and <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#email-address-hash-encoding">hashed</a> email address
+     * @return this IdentityMapV3Input instance
+     */
     public IdentityMapV3Input withHashedEmail(String hashedEmail) {
         this.hashedEmails.add(new Identity(hashedEmail));
         addToDiiMappings(hashedEmail, hashedEmail);
         return this;
     }
 
+    /**
+     * @param hashedPhones a <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#phone-number-normalization">normalized</a> and <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#phone-number-hash-encoding">hashed</a> phone number
+     * @return this IdentityMapV3Input instance
+     */
     public IdentityMapV3Input withHashedPhones(List<String> hashedPhones) {
         for (String hashedPhone : hashedPhones) {
             withHashedPhone(hashedPhone);
         }
         return this;
     }
 
+    /**
+     * @param hashedPhone a <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#phone-number-normalization">normalized</a> and <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#phone-number-hash-encoding">hashed</a> phone number
+     * @return this IdentityMapV3Input instance
+     */
     public IdentityMapV3Input withHashedPhone(String hashedPhone) {
         this.hashedPhones.add(new Identity(hashedPhone));
         addToDiiMappings(hashedPhone, hashedPhone);
         return this;
     }
 
+    /**
+     * @param emails a list of normalized or unnormalized email addresses
+     * @return this IdentityMapV3Input instance
+     */
     public IdentityMapV3Input withEmails(List<String> emails) {
         for (String email : emails) {
             withEmail(email);
         }
         return this;
     }
 
+    /**
+     * @param email a normalized or unnormalized email address
+     * @return this IdentityMapV3Input instance
+     */
     public IdentityMapV3Input withEmail(String email) {
         String hashedEmail = InputUtil.normalizeAndHashEmail(email);
         this.hashedEmails.add(new Identity(hashedEmail));
         addToDiiMappings(hashedEmail, email);
         return this;
     }
 
+    /**
+     * @param phones a <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#phone-number-normalization">normalized</a> phone number
+     * @return this IdentityMapV3Input instance
+     */
     public IdentityMapV3Input withPhones(List<String> phones) {
         for (String phone : phones) {
             withPhone(phone);
         }
         return this;
     }
 
+    /**
+     * @param phone a <a href="https://unifiedid.com/docs/getting-started/gs-normalization-encoding#phone-number-normalization">normalized</a> phone number
+     * @return this IdentityMapV3Input instance
+     */
     public IdentityMapV3Input withPhone(String phone) {
         if (!InputUtil.isPhoneNumberNormalized(phone)) {
             throw new IllegalArgumentException("phone number is not normalized: " + phone);
@@ -106,14 +138,14 @@ public IdentityMapV3Input withPhone(String phone) {
 
     }
 
-    private void addToDiiMappings(String hashedDii, String rawDii) {
-        diiMappings.computeIfAbsent(hashedDii, k -> new ArrayList<>()).add(rawDii);
-    }
-
     List<String> getRawDiis(String identityType, int i) {
         return diiMappings.get(getEncodedDii(identityType, i));
     }
 
+    private void addToDiiMappings(String hashedDii, String rawDii) {
+        diiMappings.computeIfAbsent(hashedDii, k -> new ArrayList<>()).add(rawDii);
+    }
+
     private String getEncodedDii(String identityType, int i) {
         switch (identityType) {
             case "email_hash": return hashedEmails.get(i).identity;