From e3971a1a92286a96e5b88d5844df4f90d56d2f82 Mon Sep 17 00:00:00 2001 From: Mark Thomas Date: Sat, 21 Apr 2018 21:27:33 +0100 Subject: [PATCH 1/2] Clean up Javadoc --- .../javax/websocket/ContainerProvider.java | 24 +++++++++---------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/api/client/src/main/java/javax/websocket/ContainerProvider.java b/api/client/src/main/java/javax/websocket/ContainerProvider.java index 11f3cee..497c2dc 100644 --- a/api/client/src/main/java/javax/websocket/ContainerProvider.java +++ b/api/client/src/main/java/javax/websocket/ContainerProvider.java @@ -19,23 +19,21 @@ import java.util.ServiceLoader; /** - * Provider class that allows the developer to get a reference to - * the implementation of the WebSocketContainer. - * The provider class uses the - * ServiceLoader - * to load an implementation of ContainerProvider. Specifically, the fully qualified classname - * of the container implementation of ContainerProvider must be listed in the - * META-INF/services/javax.websocket.ContainerProvider file in the implementation JAR file. + * Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer. The + * provider class uses the + * ServiceLoader to load an + * implementation of ContainerProvider. Specifically, the fully qualified class name of the container implementation of + * ContainerProvider must be listed in the META-INF/services/javax.websocket.ContainerProvider file in the + * implementation JAR file. * * @author dannycoward */ public abstract class ContainerProvider { /** - * Obtain a new instance of a WebSocketContainer. The method looks for the - * ContainerProvider implementation class in the order listed in the META-INF/services/javax.websocket.ContainerProvider - * file, returning the WebSocketContainer implementation from the ContainerProvider implementation - * that is not {@code null}. + * Obtain a new instance of a WebSocketContainer. The method looks for the ContainerProvider implementation class in + * the order listed in the META-INF/services/javax.websocket.ContainerProvider file, returning the first + * WebSocketContainer implementation from the ContainerProvider implementation that is not {@code null}. * @return an implementation provided instance of type WebSocketContainer */ public static WebSocketContainer getWebSocketContainer() { @@ -54,8 +52,8 @@ public static WebSocketContainer getWebSocketContainer() { } /** - * Load the container implementation. - * @return the implementation class + * Create a new instance of the the WebSocket container implementation. + * @return the new instance */ protected abstract WebSocketContainer getContainer(); } From a760c13ab15c4c6c2607243ace9365a27181b0be Mon Sep 17 00:00:00 2001 From: Mark Thomas Date: Mon, 23 Apr 2018 13:54:44 +0100 Subject: [PATCH 2/2] Quote file names --- .../src/main/java/javax/websocket/ContainerProvider.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api/client/src/main/java/javax/websocket/ContainerProvider.java b/api/client/src/main/java/javax/websocket/ContainerProvider.java index 497c2dc..f11dd96 100644 --- a/api/client/src/main/java/javax/websocket/ContainerProvider.java +++ b/api/client/src/main/java/javax/websocket/ContainerProvider.java @@ -23,7 +23,7 @@ * provider class uses the * ServiceLoader to load an * implementation of ContainerProvider. Specifically, the fully qualified class name of the container implementation of - * ContainerProvider must be listed in the META-INF/services/javax.websocket.ContainerProvider file in the + * ContainerProvider must be listed in the "META-INF/services/javax.websocket.ContainerProvider" file in the * implementation JAR file. * * @author dannycoward @@ -32,7 +32,7 @@ public abstract class ContainerProvider { /** * Obtain a new instance of a WebSocketContainer. The method looks for the ContainerProvider implementation class in - * the order listed in the META-INF/services/javax.websocket.ContainerProvider file, returning the first + * the order listed in the "META-INF/services/javax.websocket.ContainerProvider" file, returning the first * WebSocketContainer implementation from the ContainerProvider implementation that is not {@code null}. * @return an implementation provided instance of type WebSocketContainer */