Seal ItemOrder and MutationBehaviour
[yangtools.git] / common / concepts / src / main / java / org / opendaylight / yangtools / concepts / ListenerRegistration.java
index 8fe2d8ff8b1bfce523077599f315e5038196f54e..02d0d609259a08e35ef6e71fda1fc52ecdaf6df3 100644 (file)
@@ -10,18 +10,20 @@ package org.opendaylight.yangtools.concepts;
 import java.util.EventListener;
 
 /**
- * Class representing a {@link Registration} of an {@link EventListener}. This
- * is interface provides the additional guarantee that the process of
- * unregistration cannot fail for predictable reasons.
+ * Class representing a {@link Registration} of an {@link EventListener}. This interface provides the additional
+ * guarantee that the process of unregistration cannot fail for predictable reasons.
+ *
+ * @param <T> Type of registered listener
  */
 public interface ListenerRegistration<T extends EventListener> extends ObjectRegistration<T> {
     /**
-     * Unregister the listener. No events should be delivered to the listener
-     * once this method returns successfully. While the interface contract
-     * allows an implementation to ignore the occurence of RuntimeExceptions,
-     * implementations are strongly encouraged to deal with such exceptions
-     * internally and to ensure invocations of this method do not fail in such
-     * circumstances.
+     * Unregister the listener. Note that invocations enqueued to the listener are not subject to synchronization
+     * rules, and events may be delivered to the listener after this method completes.
+     *
+     * <p>
+     * While the interface contract allows an implementation to ignore the occurrence of RuntimeExceptions,
+     * implementations are strongly encouraged to deal with such exceptions internally and to ensure invocations of
+     * this method do not fail in such circumstances.
      */
     @Override
     void close();