diff options
author | Joakim Erdfelt | 2013-08-14 17:54:07 +0000 |
---|---|---|
committer | Joakim Erdfelt | 2013-08-14 17:54:07 +0000 |
commit | e39b48c90d17d4195d16842c4b83c505a69735ff (patch) | |
tree | f751dc82f718af47590925bb4460b5af5233ff39 | |
parent | 34032552ea75b2fed83fc72a38f3ca11151f9291 (diff) | |
download | org.eclipse.jetty.project-e39b48c90d17d4195d16842c4b83c505a69735ff.tar.gz org.eclipse.jetty.project-e39b48c90d17d4195d16842c4b83c505a69735ff.tar.xz org.eclipse.jetty.project-e39b48c90d17d4195d16842c4b83c505a69735ff.zip |
Fixing up javadoc issues in WebSocket classes
50 files changed, 80 insertions, 69 deletions
diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/ClientContainer.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/ClientContainer.java index 2ff9a8979b..f9b98e296b 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/ClientContainer.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/ClientContainer.java @@ -27,6 +27,7 @@ import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; + import javax.websocket.ClientEndpoint; import javax.websocket.ClientEndpointConfig; import javax.websocket.DeploymentException; @@ -85,21 +86,6 @@ public class ClientContainer extends ContainerLifeCycle implements WebSocketCont addBean(client); } - @Override - protected void doStart() throws Exception - { - super.doStart(); - ShutdownThread.register(client); - } - - @Override - protected void doStop() throws Exception - { - endpointClientMetadataCache.clear(); - ShutdownThread.deregister(client); - super.doStop(); - } - private Session connect(EndpointInstance instance, URI path) throws IOException { Objects.requireNonNull(instance,"EndpointInstance cannot be null"); @@ -178,6 +164,21 @@ public class ClientContainer extends ContainerLifeCycle implements WebSocketCont return connect(instance,path); } + @Override + protected void doStart() throws Exception + { + super.doStart(); + ShutdownThread.register(client); + } + + @Override + protected void doStop() throws Exception + { + endpointClientMetadataCache.clear(); + ShutdownThread.deregister(client); + super.doStop(); + } + public EndpointMetadata getClientEndpointMetadata(Class<?> endpoint) { EndpointMetadata metadata = null; @@ -272,8 +273,6 @@ public class ClientContainer extends ContainerLifeCycle implements WebSocketCont /** * Used in {@link Session#getOpenSessions()} - * - * @return */ public Set<Session> getOpenSessions() { diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/MessageHandlerWrapper.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/MessageHandlerWrapper.java index c423809705..1b69499bdd 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/MessageHandlerWrapper.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/MessageHandlerWrapper.java @@ -18,7 +18,8 @@ package org.eclipse.jetty.websocket.jsr356; -import javax.websocket.Decoder; +import javax.websocket.Decoder.BinaryStream; +import javax.websocket.Decoder.TextStream; import javax.websocket.MessageHandler; import javax.websocket.MessageHandler.Partial; import javax.websocket.MessageHandler.Whole; @@ -26,7 +27,7 @@ import javax.websocket.MessageHandler.Whole; import org.eclipse.jetty.websocket.jsr356.metadata.MessageHandlerMetadata; /** - * Expose a {@link MessageHandler} instance along with its associated {@link MessageHandlerMetadata} and {@link DecoderWrapper} + * Expose a {@link MessageHandler} instance along with its associated {@link MessageHandlerMetadata} and {@link DecoderFactory.Wrapper} */ public class MessageHandlerWrapper { @@ -74,8 +75,7 @@ public class MessageHandlerWrapper } /** - * Flag for a onMessage() method that wants MessageHandler.{@link Whole} with a Decoder that is based on {@link Decoder.TextStream} or - * {@link Decoder.BinaryStream} + * Flag for a onMessage() method that wants MessageHandler.{@link Whole} with a Decoder that is based on {@link TextStream} or {@link BinaryStream} * * @return true for Streaming based Decoder, false for normal decoder for whole messages. */ diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/IJsrMethod.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/IJsrMethod.java index eb847034ac..0e3f86b485 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/IJsrMethod.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/IJsrMethod.java @@ -49,7 +49,7 @@ public interface IJsrMethod /** * The type of message this method can handle * - * @return the message type if @{@link OnMessage} annotated, {@link MessageType#UNKNOWN} if unknown/unspecified + * @return the message type if @{@link OnMessage} annotated, null if unknown/unspecified */ MessageType getMessageType(); diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryCallable.java index 6d08d5e625..fc38004985 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryCallable.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryCallable.java @@ -18,11 +18,13 @@ package org.eclipse.jetty.websocket.jsr356.annotations; +import java.io.InputStream; import java.lang.reflect.Method; import java.nio.ByteBuffer; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.Binary; import javax.websocket.OnMessage; import org.eclipse.jetty.websocket.jsr356.JsrSession; @@ -33,7 +35,7 @@ import org.eclipse.jetty.websocket.jsr356.annotations.Param.Role; * <p> * Not for use with {@link InputStream} based {@link OnMessage} method objects. * - * @see Decoder.Binary + * @see Binary */ public class OnMessageBinaryCallable extends OnMessageCallable { diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryStreamCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryStreamCallable.java index 2c28f91136..393d7ae3f4 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryStreamCallable.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageBinaryStreamCallable.java @@ -18,12 +18,14 @@ package org.eclipse.jetty.websocket.jsr356.annotations; +//import java.io.IOException; import java.io.IOException; import java.io.InputStream; import java.lang.reflect.Method; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.BinaryStream; import javax.websocket.OnMessage; import org.eclipse.jetty.websocket.jsr356.JsrSession; @@ -32,7 +34,7 @@ import org.eclipse.jetty.websocket.jsr356.annotations.Param.Role; /** * Callable for {@link OnMessage} annotated methods for {@link InputStream} based binary message objects * - * @see Decoder.BinaryStream + * @see BinaryStream */ public class OnMessageBinaryStreamCallable extends OnMessageCallable { diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextCallable.java index a71ea97a34..d9d5b32ba9 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextCallable.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextCallable.java @@ -23,6 +23,7 @@ import java.lang.reflect.Method; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.Text; import javax.websocket.OnMessage; import org.eclipse.jetty.websocket.jsr356.JsrSession; @@ -33,7 +34,7 @@ import org.eclipse.jetty.websocket.jsr356.annotations.Param.Role; * <p> * Not for use with {@link Reader} based {@link OnMessage} method objects. * - * @see Decoder.Text + * @see Text */ public class OnMessageTextCallable extends OnMessageCallable { diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextStreamCallable.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextStreamCallable.java index 0cc5a2a810..fff760d8c4 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextStreamCallable.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/annotations/OnMessageTextStreamCallable.java @@ -24,6 +24,7 @@ import java.lang.reflect.Method; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.TextStream; import javax.websocket.OnMessage; import org.eclipse.jetty.websocket.jsr356.JsrSession; @@ -32,7 +33,7 @@ import org.eclipse.jetty.websocket.jsr356.annotations.Param.Role; /** * Callable for {@link OnMessage} annotated methods for {@link Reader} based text message objects * - * @see Decoder.TextStream + * @see TextStream */ public class OnMessageTextStreamCallable extends OnMessageCallable { diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/BooleanDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/BooleanDecoder.java index ea87165478..b3f90bc217 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/BooleanDecoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/BooleanDecoder.java @@ -20,6 +20,8 @@ package org.eclipse.jetty.websocket.jsr356.decoders; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.Text; + /** * Default implementation of the {@link Text} Message to {@link Boolean} decoder. diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ByteDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ByteDecoder.java index def579e520..f7136caa93 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ByteDecoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ByteDecoder.java @@ -20,6 +20,8 @@ package org.eclipse.jetty.websocket.jsr356.decoders; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.Text; + /** * Default implementation of the {@link Text} Message to {@link Byte} decoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/CharacterDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/CharacterDecoder.java index ddcebd157a..b0813a139c 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/CharacterDecoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/CharacterDecoder.java @@ -20,6 +20,8 @@ package org.eclipse.jetty.websocket.jsr356.decoders; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.Text; + /** * Default implementation of the {@link Text} Message to {@link Character} decoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/DoubleDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/DoubleDecoder.java index a9a002f600..f32eb4c33a 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/DoubleDecoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/DoubleDecoder.java @@ -20,6 +20,8 @@ package org.eclipse.jetty.websocket.jsr356.decoders; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.Text; + /** * Default implementation of the {@link Text} Message to {@link Double} to decoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/IntegerDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/IntegerDecoder.java index 41d4f39184..62104dff62 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/IntegerDecoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/IntegerDecoder.java @@ -20,6 +20,8 @@ package org.eclipse.jetty.websocket.jsr356.decoders; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.Text; + /** * Default implementation of the {@link Text} Message to {@link Integer} decoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ShortDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ShortDecoder.java index 607fa3032d..8adecfc4f0 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ShortDecoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/ShortDecoder.java @@ -20,6 +20,8 @@ package org.eclipse.jetty.websocket.jsr356.decoders; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.Text; + /** * Default implementation of the {@link Text} Message to {@link Short} decoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/StringDecoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/StringDecoder.java index bdd75b03ac..5e7a5be171 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/StringDecoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/decoders/StringDecoder.java @@ -20,6 +20,8 @@ package org.eclipse.jetty.websocket.jsr356.decoders; import javax.websocket.DecodeException; import javax.websocket.Decoder; +import javax.websocket.Decoder.Text; + /** * Default implementation of the {@link Text} Message to {@link String} decoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/BooleanEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/BooleanEncoder.java index f2cf552a8e..10cf9e92cc 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/BooleanEncoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/BooleanEncoder.java @@ -20,6 +20,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders; import javax.websocket.EncodeException; import javax.websocket.Encoder; +import javax.websocket.Encoder.Text; /** * Default encoder for {@link Boolean} to {@link Text} Message encoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ByteEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ByteEncoder.java index 193bb5a434..05745ab173 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ByteEncoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ByteEncoder.java @@ -19,6 +19,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders; import javax.websocket.EncodeException; +import javax.websocket.Encoder.Text; import javax.websocket.Encoder; /** diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/CharacterEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/CharacterEncoder.java index 1a0f1a20df..d5b5072fb1 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/CharacterEncoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/CharacterEncoder.java @@ -20,6 +20,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders; import javax.websocket.EncodeException; import javax.websocket.Encoder; +import javax.websocket.Encoder.Text; /** * Default encoder for {@link Character} to {@link Text} Message encoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/DoubleEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/DoubleEncoder.java index ab40aacbaf..8c8e68d88b 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/DoubleEncoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/DoubleEncoder.java @@ -20,6 +20,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders; import javax.websocket.EncodeException; import javax.websocket.Encoder; +import javax.websocket.Encoder.Text; /** * Default encoder for {@link Double} to {@link Text} Message encoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/FloatEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/FloatEncoder.java index 2cf4ead0b1..3ee7ab8152 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/FloatEncoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/FloatEncoder.java @@ -20,7 +20,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders; import javax.websocket.EncodeException; import javax.websocket.Encoder; - +import javax.websocket.Encoder.Text; /** * Default encoder for {@link Float} to {@link Text} Message encoder */ diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/IntegerEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/IntegerEncoder.java index fd4afe974d..071fd9e14a 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/IntegerEncoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/IntegerEncoder.java @@ -20,6 +20,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders; import javax.websocket.EncodeException; import javax.websocket.Encoder; +import javax.websocket.Encoder.Text; /** * Default encoder for {@link Integer} to {@link Text} Message encoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/LongEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/LongEncoder.java index 6a5dfe71dc..36f64eb6ab 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/LongEncoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/LongEncoder.java @@ -20,6 +20,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders; import javax.websocket.EncodeException; import javax.websocket.Encoder; +import javax.websocket.Encoder.Text; /** * Default encoder for {@link Long} to {@link Text} Message encoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ShortEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ShortEncoder.java index 14150dfd6d..4ec73f8ef9 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ShortEncoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/ShortEncoder.java @@ -20,6 +20,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders; import javax.websocket.EncodeException; import javax.websocket.Encoder; +import javax.websocket.Encoder.Text; /** * Default encoder for {@link Short} to {@link Text} Message encoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/StringEncoder.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/StringEncoder.java index ff7f443558..5cc16d1a16 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/StringEncoder.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/StringEncoder.java @@ -20,6 +20,7 @@ package org.eclipse.jetty.websocket.jsr356.encoders; import javax.websocket.EncodeException; import javax.websocket.Encoder; +import javax.websocket.Encoder.Text; /** * Default encoder for {@link String} to {@link Text} Message encoder diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/endpoints/JsrAnnotatedEventDriver.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/endpoints/JsrAnnotatedEventDriver.java index e05baacd5c..86743455c1 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/endpoints/JsrAnnotatedEventDriver.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/endpoints/JsrAnnotatedEventDriver.java @@ -26,7 +26,7 @@ import java.util.Map; import javax.websocket.CloseReason; import javax.websocket.DecodeException; -import javax.websocket.MessageHandler; +import javax.websocket.MessageHandler.Whole; import org.eclipse.jetty.util.BufferUtil; import org.eclipse.jetty.util.log.Log; @@ -142,7 +142,7 @@ public class JsrAnnotatedEventDriver extends AbstractJsrEventDriver implements E } /** - * Entry point for binary frames destined for {@link MessageHandler#Whole} + * Entry point for binary frames destined for {@link Whole} */ @Override public void onBinaryMessage(byte[] data) diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/ConfiguratorTest.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/ConfiguratorTest.java index 1a1d55d56b..13489202fd 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/ConfiguratorTest.java +++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/ConfiguratorTest.java @@ -26,6 +26,7 @@ import java.util.Map; import java.util.concurrent.TimeUnit; import javax.websocket.ClientEndpointConfig; +import javax.websocket.ClientEndpointConfig.Configurator; import javax.websocket.ContainerProvider; import javax.websocket.HandshakeResponse; import javax.websocket.Session; @@ -40,7 +41,7 @@ import org.junit.BeforeClass; import org.junit.Test; /** - * Tests of {@link ClientEndpointConfig.Configurator} + * Tests of {@link Configurator} */ public class ConfiguratorTest { diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/ClientAnnotatedEndpointScanner_GoodSignaturesTest.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/ClientAnnotatedEndpointScanner_GoodSignaturesTest.java index 47bfe04f1d..9370f47dc8 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/ClientAnnotatedEndpointScanner_GoodSignaturesTest.java +++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/ClientAnnotatedEndpointScanner_GoodSignaturesTest.java @@ -58,7 +58,7 @@ import org.junit.runners.Parameterized; import org.junit.runners.Parameterized.Parameters; /** - * Test {@link JsrAnnotatedClientScanner} against various valid, simple, 1 method annotated classes with valid signatures. + * Test {@link AnnotatedEndpointScanner} against various valid, simple, 1 method {@link ClientEndpoint} annotated classes with valid signatures. */ @RunWith(Parameterized.class) public class ClientAnnotatedEndpointScanner_GoodSignaturesTest diff --git a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/ClientAnnotatedEndpointScanner_InvalidSignaturesTest.java b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/ClientAnnotatedEndpointScanner_InvalidSignaturesTest.java index d467e84170..791fb2f6cf 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/ClientAnnotatedEndpointScanner_InvalidSignaturesTest.java +++ b/jetty-websocket/javax-websocket-client-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/endpoints/ClientAnnotatedEndpointScanner_InvalidSignaturesTest.java @@ -52,7 +52,7 @@ import org.junit.runners.Parameterized; import org.junit.runners.Parameterized.Parameters; /** - * Test {@link JsrAnnotatedClientScanner} against various simple, single method annotated classes with invalid signatures. + * Test {@link AnnotatedEndpointScanner} against various simple, 1 method, {@link ClientEndpoint} annotated classes with invalid signatures. */ @RunWith(Parameterized.class) public class ClientAnnotatedEndpointScanner_InvalidSignaturesTest diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ServerAnnotatedEndpointScanner_GoodSignaturesTest.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ServerAnnotatedEndpointScanner_GoodSignaturesTest.java index 94f892f44d..a012b9b117 100644 --- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ServerAnnotatedEndpointScanner_GoodSignaturesTest.java +++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ServerAnnotatedEndpointScanner_GoodSignaturesTest.java @@ -76,7 +76,7 @@ import org.junit.runners.Parameterized; import org.junit.runners.Parameterized.Parameters; /** - * Test {@link JsrAnnotatedServerScanner} against various valid, simple, 1 method annotated classes with valid signatures. + * Test {@link AnnotatedEndpointScanner} against various simple, 1 method {@link ServerEndpoint} annotated classes with valid signatures. */ @RunWith(Parameterized.class) public class ServerAnnotatedEndpointScanner_GoodSignaturesTest diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ServerAnnotatedEndpointScanner_InvalidSignaturesTest.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ServerAnnotatedEndpointScanner_InvalidSignaturesTest.java index e459b1eee8..e9fb3f3a41 100644 --- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ServerAnnotatedEndpointScanner_InvalidSignaturesTest.java +++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/ServerAnnotatedEndpointScanner_InvalidSignaturesTest.java @@ -51,7 +51,7 @@ import org.junit.runners.Parameterized; import org.junit.runners.Parameterized.Parameters; /** - * Test {@link JsrAnnotatedServerScanner} against various simple, single method annotated classes with invalid signatures. + * Test {@link AnnotatedEndpointScanner} against various simple, 1 method {@link ServerEndpoint} annotated classes with invalid signatures. */ @RunWith(Parameterized.class) public class ServerAnnotatedEndpointScanner_InvalidSignaturesTest diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/BadPayloadException.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/BadPayloadException.java index 70f57af746..262150b9ff 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/BadPayloadException.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/BadPayloadException.java @@ -20,7 +20,7 @@ package org.eclipse.jetty.websocket.api; /** * Exception to terminate the connection because it has received data within a frame payload that was not consistent with the requirements of that frame - * payload. (eg: not UTF-8 in a text frame, or a bad data seen in the {@link PerMessageCompressionExtension}) + * payload. (eg: not UTF-8 in a text frame, or a unexpected data seen by an extension) * * @see StatusCode#BAD_PAYLOAD */ diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/InvalidWebSocketException.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/InvalidWebSocketException.java index 3ffe7f124d..2c3da1a130 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/InvalidWebSocketException.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/InvalidWebSocketException.java @@ -18,6 +18,8 @@ package org.eclipse.jetty.websocket.api; +import org.eclipse.jetty.websocket.api.annotations.WebSocket; + /** * Indicating that the provided Class is not a valid WebSocket as defined by the API. * <p> diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java index a6cea8801f..147c5a01d8 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeResponse.java @@ -163,8 +163,6 @@ public class UpgradeResponse /** * Set the list of extensions that are approved for use with this websocket. * <p> - * This is Advanced usage of the {@link WebSocketCreator} to allow for a custom set of negotiated extensions. - * <p> * Notes: * <ul> * <li>Per the spec you cannot add extensions that have not been seen in the {@link UpgradeRequest}, just remove entries you don't want to use</li> diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketListener.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketListener.java index 89c712736f..8f632a8e6c 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketListener.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketListener.java @@ -38,7 +38,7 @@ public interface WebSocketListener /** * A Close Event was received. * <p> - * The underlying {@link WebSocketConnection} will be considered closed at this point. + * The underlying Connection will be considered closed at this point. * * @param statusCode * the close status code. (See {@link StatusCode}) diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketPolicy.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketPolicy.java index afb3c505cf..ce20b2ca28 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketPolicy.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketPolicy.java @@ -196,8 +196,6 @@ public class WebSocketPolicy /** * Get the maximum size of a binary message buffer (for streaming writing) - * <p> - * Note: Cannot be greater than {@link #getMaxBinaryMessageSize()} * * @return the maximum size of a binary message buffer */ @@ -220,8 +218,6 @@ public class WebSocketPolicy /** * Get the maximum size of a text message buffer (for streaming writing) - * <p> - * Note: Cannot be greater than {@link #maxTextMessageSize} * * @return the maximum size of a text message buffer */ diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java index 1db2187866..6553ec5370 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java @@ -21,7 +21,7 @@ package org.eclipse.jetty.websocket.api.extensions; /** * Interface for WebSocket Extensions. * <p> - * That work is performed by the two {@link FrameHandler} implementations for incoming and outgoing frame handling. + * That {@link Frame}s are passed through the Extension via the {@link IncomingFrames} and {@link OutgoingFrames} interfaces */ public interface Extension extends IncomingFrames, OutgoingFrames { diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java index b03f0cb245..384275bf4c 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java @@ -108,7 +108,7 @@ public class ExtensionConfig } /** - * Return parameters in way similar to how {@link javax.net.websocket.extensions.Extension#getParameters()} works. + * Return parameters found in request URI. * * @return the parameter map */ diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java index 1d45fa0a32..2e17cef9b3 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java @@ -342,7 +342,6 @@ public class QuoteUtil * the string to possibly quote * @param delim * the delimiter characters that will trigger automatic quoting - * @throws IOException */ public static void quoteIfNeeded(StringBuilder buf, String str, String delim) { diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/WebSocketClient.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/WebSocketClient.java index ab2b0bb08a..378db93964 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/WebSocketClient.java +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/WebSocketClient.java @@ -372,7 +372,7 @@ public class WebSocketClient extends ContainerLifeCycle /** * @return the {@link SslContextFactory} that manages TLS encryption - * @see WebSocketClient(SslContextFactory) + * @see #WebSocketClient(SslContextFactory) */ public SslContextFactory getSslContextFactory() { diff --git a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java index 1f5df7d340..1087907399 100644 --- a/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java +++ b/jetty-websocket/websocket-client/src/main/java/org/eclipse/jetty/websocket/client/package-info.java @@ -19,15 +19,15 @@ /** * Jetty WebSocket Client API * <p> - * The core class is {@link WebSocketClient}, which acts as a central configuration object (for example - * for {@link WebSocketClient#setConnectTimeout(int) connect timeouts}, {@link WebSocketClient#setCookieStore(CookieStore) + * The core class is {@link org.eclipse.jetty.websocket.client.WebSocketClient}, which acts as a central configuration object (for example + * for {@link org.eclipse.jetty.websocket.client.WebSocketClient#setConnectTimeout(int) connect timeouts}, {@link WebSocketClient#setCookieStore(CookieStore) * request cookie store}, etc.) and as a factory for WebSocket {@link org.eclipse.jetty.websocket.api.Session} objects. * <p> * The <a href="https://tools.ietf.org/html/rfc6455">WebSocket protocol</a> is based on a framing protocol built * around an upgraded HTTP connection. It is primarily focused on the sending of messages (text or binary), with an * occasional control frame (close, ping, pong) that this implementation uses. * <p /> - * {@link WebSocketClient} holds a number of {@link org.eclipse.jetty.websocket.api.Session Sessions}, which in turn + * {@link org.eclipse.jetty.websocket.client.WebSocketClient} holds a number of {@link org.eclipse.jetty.websocket.api.Session Sessions}, which in turn * is used to manage physical vs virtual connection handling (mux extension). */ package org.eclipse.jetty.websocket.client; diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/ConnectionState.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/ConnectionState.java index aefc7193a5..ba565cf85c 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/ConnectionState.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/ConnectionState.java @@ -19,6 +19,7 @@ package org.eclipse.jetty.websocket.common; import org.eclipse.jetty.websocket.common.io.IOState; +import org.eclipse.jetty.websocket.common.io.IOState.ConnectionStateListener; /** * Connection states as outlined in <a href="https://tools.ietf.org/html/rfc6455">RFC6455</a>. @@ -47,7 +48,7 @@ public enum ConnectionState * <p> * This can be considered a half-closed state. * <p> - * When receiving this as an event on {@link IOState.ConnectionStateListener#onConnectionStateChange(ConnectionState)} a close frame should be sent using + * When receiving this as an event on {@link ConnectionStateListener#onConnectionStateChange(ConnectionState)} a close frame should be sent using * the {@link CloseInfo} available from {@link IOState#getCloseInfo()} */ CLOSING, diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/LogicalConnection.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/LogicalConnection.java index 0429af4e54..d825e28c0a 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/LogicalConnection.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/LogicalConnection.java @@ -61,13 +61,11 @@ public interface LogicalConnection extends OutgoingFrames, SuspendToken /** * Get the ByteBufferPool in use by the connection - * @return */ ByteBufferPool getBufferPool(); /** * Get the Executor used by this connection. - * @return */ Executor getExecutor(); @@ -167,8 +165,6 @@ public interface LogicalConnection extends OutgoingFrames, SuspendToken /** * Suspend a the incoming read events on the connection. - * - * @return */ SuspendToken suspend(); } diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/SessionFactory.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/SessionFactory.java index a0af9bfd36..9119f3fad7 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/SessionFactory.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/SessionFactory.java @@ -23,7 +23,7 @@ import java.net.URI; import org.eclipse.jetty.websocket.common.events.EventDriver; /** - * Interface for creating jetty {@link MutableSession} objects. + * Interface for creating jetty {@link WebSocketSession} objects. */ public interface SessionFactory { diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketFrame.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketFrame.java index 323aa621e3..4f50084876 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketFrame.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketFrame.java @@ -132,8 +132,8 @@ public class WebSocketFrame implements Frame /** * Copy constructor for the websocket frame. * - * @param copy - * the websocket to copy. + * @param frame + * the websocket frame to copy. */ public WebSocketFrame(Frame frame) { diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketSession.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketSession.java index c863535019..10e0b43543 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketSession.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/WebSocketSession.java @@ -373,8 +373,6 @@ public class WebSocketSession extends ContainerLifeCycle implements Session, Inc /** * Open/Activate the session - * - * @throws IOException */ public void open() { diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/EventMethods.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/EventMethods.java index cf6a5929db..bda2209895 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/EventMethods.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/events/annotated/EventMethods.java @@ -20,8 +20,6 @@ package org.eclipse.jetty.websocket.common.events.annotated; /** * A representation of the methods available to call for a particular class. - * <p> - * This class used to cache the method lookups via the {@link EventMethodsCache} */ public class EventMethods { diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/AbstractWebSocketConnection.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/AbstractWebSocketConnection.java index 8f9bcc5f79..53e606eac3 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/AbstractWebSocketConnection.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/AbstractWebSocketConnection.java @@ -59,7 +59,7 @@ import org.eclipse.jetty.websocket.common.WebSocketSession; import org.eclipse.jetty.websocket.common.io.IOState.ConnectionStateListener; /** - * Provides the implementation of {@link WebSocketConnection} within the framework of the new {@link Connection} framework of jetty-io + * Provides the implementation of {@link LogicalConnection} within the framework of the new {@link Connection} framework of jetty-io */ public abstract class AbstractWebSocketConnection extends AbstractConnection implements LogicalConnection, ConnectionStateListener { diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/WriteBytesProvider.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/WriteBytesProvider.java index 99bfc558e8..be8a12b710 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/WriteBytesProvider.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/io/WriteBytesProvider.java @@ -72,8 +72,6 @@ public class WriteBytesProvider implements Callback /** * Indicate that the frame entry is done generating - * - * @return */ public boolean isDone() { diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketHandshake.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketHandshake.java index e7f6fb6abe..3622e72573 100644 --- a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketHandshake.java +++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketHandshake.java @@ -30,7 +30,6 @@ public interface WebSocketHandshake * * @param request * @param response - * @param acceptedSubProtocol */ public void doHandshakeResponse(ServletUpgradeRequest request, ServletUpgradeResponse response) throws IOException; } diff --git a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServletRFCTest.java b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServletRFCTest.java index 38488c5348..735da82a18 100644 --- a/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServletRFCTest.java +++ b/jetty-websocket/websocket-server/src/test/java/org/eclipse/jetty/websocket/server/WebSocketServletRFCTest.java @@ -49,8 +49,6 @@ import org.junit.runner.RunWith; /** * Test various <a href="http://tools.ietf.org/html/rfc6455">RFC 6455</a> specified requirements placed on {@link WebSocketServlet} - * <p> - * This test serves a different purpose than than the {@link WebSocketMessageRFC6455Test}, and {@link WebSocketParserRFC6455Test} tests. */ @RunWith(AdvancedRunner.class) public class WebSocketServletRFCTest diff --git a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketServlet.java b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketServlet.java index ee9308c632..7a9eeb1630 100644 --- a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketServlet.java +++ b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketServlet.java @@ -32,7 +32,7 @@ import org.eclipse.jetty.websocket.api.annotations.WebSocket; /** * Abstract Servlet used to bridge the Servlet API to the WebSocket API. * <p> - * To use this servlet, you will be required to register your websockets with the {@link WebSocketServerFactory} so that it can create your websockets under the + * To use this servlet, you will be required to register your websockets with the {@link WebSocketServletFactory} so that it can create your websockets under the * appropriate conditions. * <p> * The most basic implementation would be as follows. @@ -56,7 +56,7 @@ import org.eclipse.jetty.websocket.api.annotations.WebSocket; * } * </pre> * - * Note: that only request that conforms to a "WebSocket: Upgrade" handshake request will trigger the {@link WebSocketServerFactory} handling of creating + * Note: that only request that conforms to a "WebSocket: Upgrade" handshake request will trigger the {@link WebSocketServletFactory} handling of creating * WebSockets.<br> * All other requests are treated as normal servlet requests. * |