From 5359aa69219f2ce5ee128fc95e5932c9ccfb9ad5 Mon Sep 17 00:00:00 2001
From: dobrin <dobrin@adobe.com>
Date: Mon, 30 Jan 2023 22:08:52 -0800
Subject: [PATCH] Add annotations for IdentityMap, IdentityItem public classes

---
 .../identity/app/ui/CustomIdentityFragment.kt | 14 ++++++-----
 .../mobile/edge/identity/IdentityItem.java    | 23 +++++++++++++------
 .../mobile/edge/identity/IdentityMap.java     | 18 +++++++++------
 3 files changed, 35 insertions(+), 20 deletions(-)

diff --git a/code/app/src/main/java/com/adobe/marketing/edge/identity/app/ui/CustomIdentityFragment.kt b/code/app/src/main/java/com/adobe/marketing/edge/identity/app/ui/CustomIdentityFragment.kt
index 7091c831..f4a46165 100644
--- a/code/app/src/main/java/com/adobe/marketing/edge/identity/app/ui/CustomIdentityFragment.kt
+++ b/code/app/src/main/java/com/adobe/marketing/edge/identity/app/ui/CustomIdentityFragment.kt
@@ -94,10 +94,12 @@ class CustomIdentityFragment : Fragment() {
             val authenticatedState: AuthenticatedState? = sharedViewModel.authenticatedState.value
             val isPrimary: Boolean = sharedViewModel.isPrimary.value ?: false
 
-            val item = IdentityItem(identifier, authenticatedState, isPrimary)
-            val map = IdentityMap()
-            map.addItem(item, namespace)
-            Identity.updateIdentities(map)
+            if (identifier != null && namespace != null) {
+                val item = IdentityItem(identifier, authenticatedState, isPrimary)
+                val map = IdentityMap()
+                map.addItem(item, namespace)
+                Identity.updateIdentities(map)
+            }
         }
 
         root.findViewById<Button>(R.id.btn_remove_identities).setOnClickListener {
@@ -106,8 +108,8 @@ class CustomIdentityFragment : Fragment() {
             val authenticatedState: AuthenticatedState? = sharedViewModel.authenticatedState.value
             val isPrimary: Boolean = sharedViewModel.isPrimary.value ?: false
 
-            val item = IdentityItem(identifier, authenticatedState, isPrimary)
-            if (namespace != null) {
+            if (identifier != null && namespace != null) {
+                val item = IdentityItem(identifier, authenticatedState, isPrimary)
                 Identity.removeIdentity(item, namespace)
             }
         }
diff --git a/code/edgeidentity/src/main/java/com/adobe/marketing/mobile/edge/identity/IdentityItem.java b/code/edgeidentity/src/main/java/com/adobe/marketing/mobile/edge/identity/IdentityItem.java
index 70efedb0..e9e2dc64 100644
--- a/code/edgeidentity/src/main/java/com/adobe/marketing/mobile/edge/identity/IdentityItem.java
+++ b/code/edgeidentity/src/main/java/com/adobe/marketing/mobile/edge/identity/IdentityItem.java
@@ -13,6 +13,8 @@
 
 import static com.adobe.marketing.mobile.edge.identity.IdentityConstants.LOG_TAG;
 
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 import com.adobe.marketing.mobile.services.Log;
 import com.adobe.marketing.mobile.util.DataReader;
 import com.adobe.marketing.mobile.util.DataReaderException;
@@ -37,12 +39,16 @@ public final class IdentityItem {
 	/**
 	 * Creates a new {@link IdentityItem}
 	 *
-	 * @param id                 id for the item
-	 * @param authenticatedState {@link AuthenticatedState} for the item
+	 * @param id                 id for the item; should not be null
+	 * @param authenticatedState {@link AuthenticatedState} for the item; if none is provided {@link AuthenticatedState#AMBIGUOUS} is used as default
 	 * @param primary            primary flag for the item
 	 * @throws IllegalArgumentException if id is null
 	 */
-	public IdentityItem(final String id, final AuthenticatedState authenticatedState, final boolean primary) {
+	public IdentityItem(
+		@NonNull final String id,
+		@Nullable final AuthenticatedState authenticatedState,
+		final boolean primary
+	) {
 		if (id == null) {
 			throw new IllegalArgumentException("id must be non-null");
 		}
@@ -57,18 +63,18 @@ public IdentityItem(final String id, final AuthenticatedState authenticatedState
 	 * {@code authenticatedState) is set to AMBIGUOUS
 	 * (@code primary} is set to false
 	 *
-	 * @param id the id for this {@link IdentityItem}
+	 * @param id the id for this {@link IdentityItem}; should not be null
 	 */
-	public IdentityItem(final String id) {
+	public IdentityItem(@NonNull final String id) {
 		this(id, AuthenticatedState.AMBIGUOUS, false);
 	}
 
 	/**
 	 * Creates a copy of item.
 	 *
-	 * @param item A {@link IdentityItem} to be copied
+	 * @param item A {@link IdentityItem} to be copied; should not be null
 	 */
-	public IdentityItem(final IdentityItem item) {
+	public IdentityItem(@NonNull final IdentityItem item) {
 		this(item.id, item.authenticatedState, item.primary);
 	}
 
@@ -77,6 +83,7 @@ public IdentityItem(final IdentityItem item) {
 	 *
 	 * @return The id for this identity item
 	 */
+	@NonNull
 	public String getId() {
 		return id;
 	}
@@ -86,6 +93,7 @@ public String getId() {
 	 *
 	 * @return Current {@link AuthenticatedState} for this item
 	 */
+	@NonNull
 	public AuthenticatedState getAuthenticatedState() {
 		return authenticatedState;
 	}
@@ -100,6 +108,7 @@ public boolean isPrimary() {
 		return primary;
 	}
 
+	@NonNull
 	@Override
 	public String toString() {
 		// format:off
diff --git a/code/edgeidentity/src/main/java/com/adobe/marketing/mobile/edge/identity/IdentityMap.java b/code/edgeidentity/src/main/java/com/adobe/marketing/mobile/edge/identity/IdentityMap.java
index 2a5b8c9b..e86d3d94 100644
--- a/code/edgeidentity/src/main/java/com/adobe/marketing/mobile/edge/identity/IdentityMap.java
+++ b/code/edgeidentity/src/main/java/com/adobe/marketing/mobile/edge/identity/IdentityMap.java
@@ -13,6 +13,7 @@
 
 import static com.adobe.marketing.mobile.edge.identity.IdentityConstants.LOG_TAG;
 
+import androidx.annotation.NonNull;
 import com.adobe.marketing.mobile.services.Log;
 import com.adobe.marketing.mobile.util.DataReader;
 import com.adobe.marketing.mobile.util.MapUtils;
@@ -44,7 +45,8 @@ public class IdentityMap {
 	 * @param namespace namespace for the list of identities to retrieve
 	 * @return IdentityItem for the namespace
 	 */
-	public List<IdentityItem> getIdentityItemsForNamespace(final String namespace) {
+	@NonNull
+	public List<IdentityItem> getIdentityItemsForNamespace(@NonNull final String namespace) {
 		final List<IdentityItem> copyItems = new ArrayList<>();
 
 		if (StringUtils.isNullOrEmpty(namespace)) {
@@ -69,6 +71,7 @@ public List<IdentityItem> getIdentityItemsForNamespace(final String namespace) {
 	 *
 	 * @return a list of all the namespaces for this {@link IdentityMap}, or an empty string if this {@code IdentityMap} is empty
 	 */
+	@NonNull
 	public List<String> getNamespaces() {
 		return new ArrayList<>(identityItems.keySet());
 	}
@@ -77,20 +80,20 @@ public List<String> getNamespaces() {
 	 * Add an identity item which is used to clearly distinguish entities that are interacting
 	 * with digital experiences.
 	 *
-	 * @param item      {@link IdentityItem} to be added to the given {@code namespace}
-	 * @param namespace the namespace integration code or namespace ID of the identity
+	 * @param item      {@link IdentityItem} to be added to the given {@code namespace}; should not be null
+	 * @param namespace the namespace integration code or namespace ID of the identity; should not be null
 	 */
-	public void addItem(final IdentityItem item, final String namespace) {
+	public void addItem(@NonNull final IdentityItem item, @NonNull final String namespace) {
 		addItem(item, namespace, false);
 	}
 
 	/**
 	 * Remove a single {@link IdentityItem} from this map.
 	 *
-	 * @param item      {@link IdentityItem} to be removed from the given {@code namespace}
-	 * @param namespace the namespace integration code or namespace ID of the identity
+	 * @param item      {@link IdentityItem} to be removed from the given {@code namespace}; should not be null
+	 * @param namespace the namespace integration code or namespace ID of the identity; should not be null
 	 */
-	public void removeItem(final IdentityItem item, final String namespace) {
+	public void removeItem(@NonNull final IdentityItem item, @NonNull final String namespace) {
 		if (item == null) {
 			Log.debug(LOG_TAG, LOG_SOURCE, "Remove item ignored as must contain a non-null IdentityItem.");
 			return;
@@ -113,6 +116,7 @@ public boolean isEmpty() {
 		return identityItems.isEmpty();
 	}
 
+	@NonNull
 	@Override
 	public String toString() {
 		final StringBuilder b = new StringBuilder();