Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up Javadoc #253

Merged
merged 2 commits into from
Jun 27, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 11 additions & 13 deletions api/client/src/main/java/javax/websocket/ContainerProvider.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <a href="http://docs.oracle.com/javase/7/docs/api/java/util/ServiceLoader.html">ServiceLoader</a>
* 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
* <a href="http://docs.oracle.com/javase/7/docs/api/java/util/ServiceLoader.html">ServiceLoader</a> 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() {
Expand All @@ -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();
}
Expand Down