Annotate Identifier with @ThreadSafe

[yangtools.git] / common / concepts / src / main / java / org / opendaylight / yangtools / concepts / Identifier.java

diff --git a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Identifier.java b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Identifier.java
index 148865b850cec84120517d8a6451e66072b6d441..b673486196fbe34bfd453d24d42a1a5acdb402b4 100644 (file)
--- a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Identifier.java
+++ b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Identifier.java
@@ -8,14 +8,31 @@
 package org.opendaylight.yangtools.concepts;
 
 import java.io.Serializable;
+import javax.annotation.concurrent.ThreadSafe;
 
 /**
- * General identifier interface. It is primarily a marker for all things that
- * identify concepts -- such as names, addresses, classes, etc. We do not
- * require too much, just that the identifiers are serializable (and this
+ * General identifier interface. It is primarily a marker for all things that identify concepts -- such as names,
+ * addresses, classes, etc. We do not require too much, just that the identifiers are serializable (and this
  * transferable).
+ *
+ * Implementations are expected to implement {@link #hashCode()} and {@link #equals(Object)} methods in a way, which
+ * ensures that objects before and after serialization are considered equal.
+ *
+ * Implementations are advised to use the {@link java.io.Externalizable} Proxy pattern to allow future evolution
+ * of their serialization format. For further efficiency, implementation should implement {@link WritableObject},
+ * so they can be efficiently embedded in other {@link Serializable} objects.
+ *
+ * Note that this class is annotated as {@link ThreadSafe}, hence all implementations are expected to be thread-safe.
  */
+@ThreadSafe
 public interface Identifier extends Serializable, Immutable {
+    @Override
+    boolean equals(Object o);
+
+    @Override
+    int hashCode();
 
+    @Override
+    String toString();
 }