From 2b5be71ad21d520e71691c0c2ad1988570706b5d Mon Sep 17 00:00:00 2001 From: Simone Bordet Date: Mon, 27 Feb 2012 21:26:27 +0100 Subject: [PATCH] Javadocs. --- spdy-core/src/main/java/org/eclipse/jetty/spdy/Promise.java | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/spdy-core/src/main/java/org/eclipse/jetty/spdy/Promise.java b/spdy-core/src/main/java/org/eclipse/jetty/spdy/Promise.java index 582ed54ba83..ef3eee17d1e 100644 --- a/spdy-core/src/main/java/org/eclipse/jetty/spdy/Promise.java +++ b/spdy-core/src/main/java/org/eclipse/jetty/spdy/Promise.java @@ -24,6 +24,12 @@ import java.util.concurrent.TimeoutException; import org.eclipse.jetty.spdy.api.Handler; +/** + *

A {@link Promise} is a {@link Future} that allows a result or a failure to be set, + * so that the {@link Future} will be {@link #isDone() done}.

+ * + * @param the type of the result object + */ public class Promise implements Handler, Future { private final CountDownLatch latch = new CountDownLatch(1);