import com.google.common.util.concurrent.ListenableFuture;
import java.util.concurrent.TimeUnit;
-import javax.annotation.Nonnegative;
+import org.checkerframework.checker.index.qual.NonNegative;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.util.concurrent.FluentFutures;
/**
- * A {@link DOMService} which allows its user to send {@link DOMNotification}s. It
- * provides two styles of initiating the notification delivery, similar to
- * {@link java.util.concurrent.BlockingQueue}:
- * - a put-style method which waits until the implementation can accept the notification
- * for delivery, and
- * - an offer-style method, which attempts to enqueue the notification, but allows
- * the caller to specify that it should never wait, or put an upper bound on how
- * long it is going to wait.
+ * A {@link DOMService} which allows its user to publish top-level (YANG 1.0) {@link DOMNotification}s. It provides two
+ * styles of initiating the notification delivery, similar to {@link java.util.concurrent.BlockingQueue}:
+ * <ul>
+ * <li>a put-style method which waits until the implementation can accept the notification for delivery, and</li>
+ * <li>an offer-style method, which attempts to enqueue the notification, but allows the caller to specify that it
+ * should never wait, or put an upper bound on how long it is going to wait</li>
+ * </ul>
*/
public interface DOMNotificationPublishService extends DOMService {
/**
* @throws IllegalArgumentException if timeout is negative.
*/
@NonNull ListenableFuture<? extends Object> offerNotification(@NonNull DOMNotification notification,
- @Nonnegative long timeout, @NonNull TimeUnit unit) throws InterruptedException;
+ @NonNegative long timeout, @NonNull TimeUnit unit) throws InterruptedException;
}