Deprecate ListenerRegistration for removal

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

diff --git a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Registration.java b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Registration.java
index c166eb639407333f1112bcf412f56f01c0c84ee1..cbf0a2aac9cea301e8b736fea2affcb38e4b2183 100644 (file)
--- a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Registration.java
+++ b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Registration.java
@@ -16,6 +16,15 @@ public interface Registration extends AutoCloseable {
      * Unregisters the object. This operation is required not to invoke blocking operations. Implementations which
      * require interaction with outside world must provide guarantees that any work is done behind the scenes and
      * the unregistration process looks as if it has already succeeded once this method returns.
+     *
+     * <p>
+     * The above requirement does not necessarily mean that all interactions with the registered entity seize before
+     * this method returns, but they should complete within a reasonable time frame.
+     *
+     * <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();