Move all source files into the "net.tootallnate.websocket" package. Make 'WebSocket' public, but constructor protected, since instances must be exposed through 'WebSocketServer', and therefore must be included in the JavaDoc. Slight doc improvements.

TooTallNate · TooTallNate · commit f45ed9934965 · 2010-07-24T13:41:46.000-07:00
diff --git a/src/net/tootallnate/websocket/WebSocket.java b/src/net/tootallnate/websocket/WebSocket.java
@@ -1,3 +1,4 @@
+package net.tootallnate.websocket;
 
 import java.io.IOException;
 import java.nio.ByteBuffer;
@@ -13,10 +14,12 @@
  *
  * This is an inner class, used by <tt>WebSocketClient</tt> and
  * <tt>WebSocketServer</tt>, and should never need to be instantiated directly
- * by your code.
+ * by your code. However, instances are exposed in <tt>WebSocketServer</tt>
+ * through the <i>onClientOpen</i>, <i>onClientClose</i>,
+ * <i>onClientMessage</i> callbacks.
  * @author Nathan Rajlich
  */
-final class WebSocket {
+public final class WebSocket {
   // CONSTANTS ///////////////////////////////////////////////////////////////
   /**
    * The default port of WebSockets, as defined in the spec. If the nullary
@@ -84,22 +87,21 @@ final class WebSocket {
    * @param listener The {@link WebSocketListener} to notify of events when
    *                 they occur.
    */
-  public WebSocket(SocketChannel socketChannel, WebSocketListener listener) {
+  WebSocket(SocketChannel socketChannel, WebSocketListener listener) {
     this.socketChannel = socketChannel;
     this.handshakeComplete = false;
     this.remoteHandshake = this.currentFrame = null;
     this.buffer = ByteBuffer.allocate(1);
     this.wsl = listener;
   }
 
-  // PUBLIC INSTANCE METHODS /////////////////////////////////////////////////
   /**
    * Should be called when a Selector has a key that is writable for this
    * WebSocket's SocketChannel connection.
    * @throws IOException When socket related I/O errors occur.
    * @throws NoSuchAlgorithmException 
    */
-  public void handleRead() throws IOException, NoSuchAlgorithmException {
+  void handleRead() throws IOException, NoSuchAlgorithmException {
     this.buffer.rewind();
     
     int bytesRead = -1;
@@ -120,6 +122,7 @@ public void handleRead() throws IOException, NoSuchAlgorithmException {
     }
   }
 
+  // PUBLIC INSTANCE METHODS /////////////////////////////////////////////////
   /**
    * Closes the underlying SocketChannel, and calls the listener's onClose
    * event handler.
diff --git a/src/net/tootallnate/websocket/WebSocketClient.java b/src/net/tootallnate/websocket/WebSocketClient.java
@@ -1,3 +1,4 @@
+package net.tootallnate.websocket;
 
 import java.io.IOException;
 import java.net.InetSocketAddress;
diff --git a/src/net/tootallnate/websocket/WebSocketListener.java b/src/net/tootallnate/websocket/WebSocketListener.java
@@ -1,3 +1,4 @@
+package net.tootallnate.websocket;
 
 import java.io.IOException;
 import java.security.NoSuchAlgorithmException;
diff --git a/src/net/tootallnate/websocket/WebSocketServer.java b/src/net/tootallnate/websocket/WebSocketServer.java
@@ -1,3 +1,4 @@
+package net.tootallnate.websocket;
 
 import java.io.IOException;
 import java.nio.ByteBuffer;

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+package net.tootallnate.websocket;`
`1`	`2`
`2`	`3`	`import java.io.IOException;`
`3`	`4`	`import java.net.InetSocketAddress;`