From 177350fbba4d490111d1362810bbeb4521d1803b Mon Sep 17 00:00:00 2001
From: Lanchon <lanchon@gmail.com>
Date: Tue, 5 Sep 2017 04:49:44 +0200
Subject: [PATCH] Clarify usage of SingletonDexContainer.UNDEFINED_ENTRY_NAME

---
 src/main/java/lanchon/multidexlib2/SingletonDexContainer.java | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/main/java/lanchon/multidexlib2/SingletonDexContainer.java b/src/main/java/lanchon/multidexlib2/SingletonDexContainer.java
index 824ec96..d27f96c 100644
--- a/src/main/java/lanchon/multidexlib2/SingletonDexContainer.java
+++ b/src/main/java/lanchon/multidexlib2/SingletonDexContainer.java
@@ -21,6 +21,10 @@ public class SingletonDexContainer extends AbstractMultiDexContainer<MultiDexFil
 
 	// I insist that some dex container entries do not have names
 	// even though dexlib2 does not allow null entry names.
+	// If this constant is ever changed to hold a non-null value,
+	// the new value will be a unique instance of String that will
+	// act as a sentinel. Clients should always test for this value
+	// using the '==' operator rather than the 'equals(...)' method.
 	public static final String UNDEFINED_ENTRY_NAME = null;
 
 	public SingletonDexContainer(DexFile dexFile) {