Fixing up javadoc
This commit is contained in:
Joakim Erdfelt
parent
de7c7ca7af
commit
1d341398da
|
|
@ -25,7 +25,7 @@ import java.util.Map;
|
|||
* in Jetty to expose Path Param values used during the {@link org.eclipse.jetty.websocket.jsr356.function.JsrEndpointFunctions}
|
||||
* resolution of methods.
|
||||
* <p>
|
||||
* Mostly a feature of the JSR356 Server implementation and its <code>@javax.websocket.server.PathParam</code> annotation.
|
||||
* Mostly a feature of the JSR356 Server implementation and its {@code @javax.websocket.server.PathParam} annotation.
|
||||
* </p>
|
||||
*/
|
||||
public interface PathParamProvider
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ import java.util.concurrent.TimeoutException;
|
|||
import javax.websocket.Encoder;
|
||||
|
||||
/**
|
||||
* A <code>Future<Void></code> that is already failed as a result of an Encode error
|
||||
* A {@code Future<Void>} that is already failed as a result of an Encode error
|
||||
*/
|
||||
public class EncodeFailedFuture implements Future<Void>
|
||||
{
|
||||
|
|
|
|||
|
|
@ -183,7 +183,7 @@ public class JsrEndpointFunctions extends CommonEndpointFunctions<JsrSession>
|
|||
* Block if the message sink is actively being used.
|
||||
*
|
||||
* @param handler the handler to remove from possible message sinks
|
||||
* @see {@link javax.websocket.Session#removeMessageHandler(MessageHandler)}
|
||||
* @see javax.websocket.Session#removeMessageHandler(MessageHandler)
|
||||
* @since JSR356 v1.0
|
||||
*/
|
||||
public void removeMessageHandler(MessageHandler handler)
|
||||
|
|
@ -220,7 +220,7 @@ public class JsrEndpointFunctions extends CommonEndpointFunctions<JsrSession>
|
|||
* @param handler the partial message handler
|
||||
* @param <T> the generic defined type
|
||||
* @throws IllegalStateException if unable to process message handler
|
||||
* @see {@link javax.websocket.Session#addMessageHandler(Class, MessageHandler.Partial)}
|
||||
* @see javax.websocket.Session#addMessageHandler(Class, MessageHandler.Partial)
|
||||
* @since JSR356 v1.1
|
||||
*/
|
||||
public <T> void setMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) throws IllegalStateException
|
||||
|
|
@ -275,7 +275,7 @@ public class JsrEndpointFunctions extends CommonEndpointFunctions<JsrSession>
|
|||
* @param handler the whole message handler
|
||||
* @param <T> the generic defined type
|
||||
* @throws IllegalStateException if unable to process message handler
|
||||
* @see {@link javax.websocket.Session#addMessageHandler(Class, MessageHandler.Whole)}
|
||||
* @see javax.websocket.Session#addMessageHandler(Class, MessageHandler.Whole)
|
||||
* @since JSR356 v1.1
|
||||
*/
|
||||
public <T> void setMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) throws IllegalStateException
|
||||
|
|
|
|||
|
|
@ -164,7 +164,7 @@ public class StreamTest
|
|||
*
|
||||
* @param file
|
||||
* the file to validate
|
||||
* @param shaFile
|
||||
* @param sha1File
|
||||
* the sha1sum file to verify against
|
||||
*/
|
||||
private void assertFileUpload(File file, File sha1File) throws IOException, NoSuchAlgorithmException
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ public interface WebSocketPartialListener extends WebSocketConnectionListener
|
|||
/**
|
||||
* A WebSocket BINARY (or associated CONTINUATION) frame has been received.
|
||||
* <p>
|
||||
* <b>Important Note</b>: The payload <code>ByteBuffer</code> cannot be modified, and the ByteBuffer object itself
|
||||
* <b>Important Note</b>: The payload {@code ByteBuffer} cannot be modified, and the ByteBuffer object itself
|
||||
* will be recycled on completion of this method call, make a copy of the data contained within if you want to
|
||||
* retain it between calls.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -30,9 +30,9 @@ import org.eclipse.jetty.websocket.api.Session;
|
|||
* Annotation for tagging methods to receive connection close events.
|
||||
* <p>
|
||||
* Acceptable method patterns.<br>
|
||||
* Note: <code>methodName</code> can be any name you want to use.
|
||||
* Note: {@code methodName} can be any name you want to use.
|
||||
* <ol>
|
||||
* <li><code>public void methodName(int statusCode, String reason)</code></li>
|
||||
* <li>{@code public void methodName(int statusCode, String reason)}</li>
|
||||
* <li><code>public void methodName({@link Session} session, int statusCode, String reason)</code></li>
|
||||
* </ol>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import org.eclipse.jetty.websocket.api.Session;
|
|||
* Annotation for tagging methods to receive connection open events.
|
||||
* <p>
|
||||
* Only 1 acceptable method pattern for this annotation.<br>
|
||||
* Note: <code>methodName</code> can be any name you want to use.
|
||||
* Note: {@code methodName} can be any name you want to use.
|
||||
* <ol>
|
||||
* <li><code>public void methodName({@link Session} session)</code></li>
|
||||
* </ol>
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import org.eclipse.jetty.websocket.api.Session;
|
|||
* Annotation for receiving websocket errors (exceptions) that have occurred internally in the websocket implementation.
|
||||
* <p>
|
||||
* Acceptable method patterns.<br>
|
||||
* Note: <code>methodName</code> can be any name you want to use.
|
||||
* Note: {@code methodName} can be any name you want to use.
|
||||
* <ol>
|
||||
* <li><code>public void methodName({@link Throwable} error)</code></li>
|
||||
* <li><code>public void methodName({@link Session} session, {@link Throwable} error)</code></li>
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import org.eclipse.jetty.websocket.api.Session;
|
|||
* (ADVANCED) Annotation for tagging methods to receive frame events.
|
||||
* <p>
|
||||
* Acceptable method patterns.<br>
|
||||
* Note: <code>methodName</code> can be any name you want to use.
|
||||
* Note: {@code methodName} can be any name you want to use.
|
||||
* <ol>
|
||||
* <li><code>public void methodName({@link org.eclipse.jetty.websocket.api.extensions.Frame} frame)</code></li>
|
||||
* <li><code>public void methodName({@link Session} session, {@link org.eclipse.jetty.websocket.api.extensions.Frame} frame)</code></li>
|
||||
|
|
|
|||
|
|
@ -31,13 +31,13 @@ import org.eclipse.jetty.websocket.api.Session;
|
|||
* Annotation for tagging methods to receive Binary or Text Message events.
|
||||
* <p>
|
||||
* Acceptable method patterns.<br>
|
||||
* Note: <code>methodName</code> can be any name you want to use.
|
||||
* Note: {@code methodName} can be any name you want to use.
|
||||
* <p>
|
||||
* <u>Text Message Versions</u>
|
||||
* <ol>
|
||||
* <li><code>public void methodName(String text)</code></li>
|
||||
* <li>{@code public void methodName(String text)}</li>
|
||||
* <li><code>public void methodName({@link Session} session, String text)</code></li>
|
||||
* <li><code>public void methodName(Reader reader)</code></li>
|
||||
* <li>{@code public void methodName(Reader reader)}</li>
|
||||
* <li><code>public void methodName({@link Session} session, Reader reader)</code></li>
|
||||
* </ol>
|
||||
* Note: that the {@link Reader} in this case will always use UTF-8 encoding/charset (this is dictated by the RFC 6455 spec for Text Messages. If you need to
|
||||
|
|
@ -45,9 +45,9 @@ import org.eclipse.jetty.websocket.api.Session;
|
|||
* <p>
|
||||
* <u>Binary Message Versions</u>
|
||||
* <ol>
|
||||
* <li><code>public void methodName(byte buf[], int offset, int length)</code></li>
|
||||
* <li>{@code public void methodName(byte buf[], int offset, int length)}</li>
|
||||
* <li><code>public void methodName({@link Session} session, byte buf[], int offset, int length)</code></li>
|
||||
* <li><code>public void methodName(InputStream stream)</code></li>
|
||||
* <li>{@code public void methodName(InputStream stream)}</li>
|
||||
* <li><code>public void methodName({@link Session} session, InputStream stream)</code></li>
|
||||
* </ol>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -33,9 +33,9 @@ public interface Extension extends IncomingFrames, OutgoingFrames
|
|||
public ExtensionConfig getConfig();
|
||||
|
||||
/**
|
||||
* The <code>Sec-WebSocket-Extensions</code> name for this extension.
|
||||
* The {@code Sec-WebSocket-Extensions} name for this extension.
|
||||
* <p>
|
||||
* Also known as the <a href="https://tools.ietf.org/html/rfc6455#section-9.1"><code>extension-token</code> per Section 9.1. Negotiating Extensions</a>.
|
||||
* Also known as the <a href="https://tools.ietf.org/html/rfc6455#section-9.1">{@code extension-token} per Section 9.1. Negotiating Extensions</a>.
|
||||
* @return the name of the extension
|
||||
*/
|
||||
public String getName();
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ public class ExtensionConfig
|
|||
}
|
||||
|
||||
/**
|
||||
* Parse enumeration of <code>Sec-WebSocket-Extensions</code> header values into a {@link ExtensionConfig} list
|
||||
* Parse enumeration of {@code Sec-WebSocket-Extensions} header values into a {@link ExtensionConfig} list
|
||||
*
|
||||
* @param valuesEnum
|
||||
* the raw header values enum
|
||||
|
|
@ -73,7 +73,7 @@ public class ExtensionConfig
|
|||
}
|
||||
|
||||
/**
|
||||
* Parse 1 or more raw <code>Sec-WebSocket-Extensions</code> header values into a {@link ExtensionConfig} list
|
||||
* Parse 1 or more raw {@code Sec-WebSocket-Extensions} header values into a {@link ExtensionConfig} list
|
||||
*
|
||||
* @param rawSecWebSocketExtensions
|
||||
* the raw header values
|
||||
|
|
|
|||
|
|
@ -322,7 +322,7 @@ public class QuoteUtil
|
|||
/**
|
||||
* Append into buf the provided string, adding quotes if needed.
|
||||
* <p>
|
||||
* Quoting is determined if any of the characters in the <code>delim</code> are found in the input <code>str</code>.
|
||||
* Quoting is determined if any of the characters in the {@code delim} are found in the input <code>str</code>.
|
||||
*
|
||||
* @param buf
|
||||
* the buffer to append to
|
||||
|
|
|
|||
|
|
@ -28,9 +28,9 @@ import java.util.Objects;
|
|||
public final class WSURI
|
||||
{
|
||||
/**
|
||||
* Convert to HTTP <code>http</code> or <code>https</code> scheme URIs.
|
||||
* Convert to HTTP {@code http} or <code>https</code> scheme URIs.
|
||||
* <p>
|
||||
* Converting <code>ws</code> and <code>wss</code> URIs to their HTTP equivalent
|
||||
* Converting {@code ws} and <code>wss</code> URIs to their HTTP equivalent
|
||||
*
|
||||
* @param inputUri
|
||||
* the input URI
|
||||
|
|
@ -67,9 +67,9 @@ public final class WSURI
|
|||
}
|
||||
|
||||
/**
|
||||
* Convert to WebSocket <code>ws</code> or <code>wss</code> scheme URIs
|
||||
* Convert to WebSocket {@code ws} or <code>wss</code> scheme URIs
|
||||
* <p>
|
||||
* Converting <code>http</code> and <code>https</code> URIs to their WebSocket equivalent
|
||||
* Converting {@code http} and <code>https</code> URIs to their WebSocket equivalent
|
||||
*
|
||||
* @param inputUrl
|
||||
* the input URI
|
||||
|
|
@ -83,9 +83,9 @@ public final class WSURI
|
|||
}
|
||||
|
||||
/**
|
||||
* Convert to WebSocket <code>ws</code> or <code>wss</code> scheme URIs
|
||||
* Convert to WebSocket {@code ws} or <code>wss</code> scheme URIs
|
||||
* <p>
|
||||
* Converting <code>http</code> and <code>https</code> URIs to their WebSocket equivalent
|
||||
* Converting {@code http} and <code>https</code> URIs to their WebSocket equivalent
|
||||
*
|
||||
* @param inputUrl
|
||||
* the input URI
|
||||
|
|
@ -105,10 +105,10 @@ public final class WSURI
|
|||
}
|
||||
|
||||
/**
|
||||
* Convert to WebSocket <code>ws</code> or <code>wss</code> scheme URIs
|
||||
* Convert to WebSocket {@code ws} or <code>wss</code> scheme URIs
|
||||
*
|
||||
* <p>
|
||||
* Converting <code>http</code> and <code>https</code> URIs to their WebSocket equivalent
|
||||
* Converting {@code http} and <code>https</code> URIs to their WebSocket equivalent
|
||||
*
|
||||
* @param inputUri
|
||||
* the input URI
|
||||
|
|
|
|||
|
|
@ -24,14 +24,14 @@ import java.security.MessageDigest;
|
|||
import org.eclipse.jetty.util.B64Code;
|
||||
|
||||
/**
|
||||
* Logic for working with the <code>Sec-WebSocket-Key</code> and <code>Sec-WebSocket-Accept</code> headers.
|
||||
* Logic for working with the {@code Sec-WebSocket-Key} and <code>Sec-WebSocket-Accept</code> headers.
|
||||
* <p>
|
||||
* This is kept separate from Connection objects to facilitate difference in behavior between client and server, as well as making testing easier.
|
||||
*/
|
||||
public class AcceptHash
|
||||
{
|
||||
/**
|
||||
* Globally Unique Identifier for use in WebSocket handshake within <code>Sec-WebSocket-Accept</code> and <code>Sec-WebSocket-Key</code> http headers.
|
||||
* Globally Unique Identifier for use in WebSocket handshake within {@code Sec-WebSocket-Accept} and <code>Sec-WebSocket-Key</code> http headers.
|
||||
* <p>
|
||||
* See <a href="https://tools.ietf.org/html/rfc6455#section-1.3">Opening Handshake (Section 1.3)</a>
|
||||
*/
|
||||
|
|
@ -42,7 +42,7 @@ public class AcceptHash
|
|||
*
|
||||
* @param key
|
||||
* the key to hash
|
||||
* @return the <code>Sec-WebSocket-Accept</code> header response (per opening handshake spec)
|
||||
* @return the {@code Sec-WebSocket-Accept} header response (per opening handshake spec)
|
||||
*/
|
||||
public static String hashKey(String key)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -33,8 +33,9 @@ import org.eclipse.jetty.util.log.Logger;
|
|||
|
||||
/**
|
||||
* Support class for reading a (single) WebSocket BINARY message via a InputStream.
|
||||
* <p/>
|
||||
* <p>
|
||||
* An InputStream that can access a queue of ByteBuffer payloads, along with expected InputStream blocking behavior.
|
||||
* </p>
|
||||
*/
|
||||
public class MessageInputStream extends InputStream implements MessageSink
|
||||
{
|
||||
|
|
|
|||
|
|
@ -507,7 +507,7 @@ public class WebSocketServerFactory extends ContainerLifeCycle implements WebSoc
|
|||
* @param request the request to upgrade
|
||||
* @param response the response to upgrade
|
||||
* @param websocket the websocket endpoint instance
|
||||
* @throws IOException
|
||||
* @throws IOException if unable to upgrade
|
||||
*/
|
||||
private boolean upgrade(HttpConnection http, ServletUpgradeRequest request, ServletUpgradeResponse response, Object websocket) throws IOException
|
||||
{
|
||||
|
|
|
|||
|
|
@ -164,7 +164,7 @@ public class ServletUpgradeRequest extends UpgradeRequest
|
|||
/**
|
||||
* Equivalent to {@link HttpServletRequest#getLocale()}
|
||||
*
|
||||
* @return the preferred <code>Locale</code> for the client
|
||||
* @return the preferred {@code Locale} for the client
|
||||
*/
|
||||
public Locale getLocale()
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in New Issue