Extend JavaDoc coverage

marci4 · marci4 · commit ddb673d3a0bf · 2018-01-29T19:18:54.000+01:00
diff --git a/src/main/java/org/java_websocket/client/package-info.java b/src/main/java/org/java_websocket/client/package-info.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2010-2018 Nathan Rajlich
+ *
+ *  Permission is hereby granted, free of charge, to any person
+ *  obtaining a copy of this software and associated documentation
+ *  files (the "Software"), to deal in the Software without
+ *  restriction, including without limitation the rights to use,
+ *  copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the
+ *  Software is furnished to do so, subject to the following
+ *  conditions:
+ *
+ *  The above copyright notice and this permission notice shall be
+ *  included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ *  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ *  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ *  OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * This package encapsulates all implementations in relation with the WebSocketClient.
+ */
+package org.java_websocket.client;
diff --git a/src/main/java/org/java_websocket/drafts/package-info.java b/src/main/java/org/java_websocket/drafts/package-info.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2010-2018 Nathan Rajlich
+ *
+ *  Permission is hereby granted, free of charge, to any person
+ *  obtaining a copy of this software and associated documentation
+ *  files (the "Software"), to deal in the Software without
+ *  restriction, including without limitation the rights to use,
+ *  copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the
+ *  Software is furnished to do so, subject to the following
+ *  conditions:
+ *
+ *  The above copyright notice and this permission notice shall be
+ *  included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ *  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ *  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ *  OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * This package encapsulates all implementations in relation with the WebSocket drafts.
+ */
+package org.java_websocket.drafts;
diff --git a/src/main/java/org/java_websocket/exceptions/package-info.java b/src/main/java/org/java_websocket/exceptions/package-info.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2010-2018 Nathan Rajlich
+ *
+ *  Permission is hereby granted, free of charge, to any person
+ *  obtaining a copy of this software and associated documentation
+ *  files (the "Software"), to deal in the Software without
+ *  restriction, including without limitation the rights to use,
+ *  copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the
+ *  Software is furnished to do so, subject to the following
+ *  conditions:
+ *
+ *  The above copyright notice and this permission notice shall be
+ *  included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ *  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ *  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ *  OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * This package encapsulates all implementations in relation with the exceptions thrown in this lib.
+ */
+package org.java_websocket.exceptions;
diff --git a/src/main/java/org/java_websocket/extensions/package-info.java b/src/main/java/org/java_websocket/extensions/package-info.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2010-2018 Nathan Rajlich
+ *
+ *  Permission is hereby granted, free of charge, to any person
+ *  obtaining a copy of this software and associated documentation
+ *  files (the "Software"), to deal in the Software without
+ *  restriction, including without limitation the rights to use,
+ *  copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the
+ *  Software is furnished to do so, subject to the following
+ *  conditions:
+ *
+ *  The above copyright notice and this permission notice shall be
+ *  included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ *  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ *  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ *  OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * This package encapsulates all interfaces and implementations in relation with the WebSocket Sec-WebSocket-Extensions.
+ */
+package org.java_websocket.extensions;
diff --git a/src/main/java/org/java_websocket/framing/ControlFrame.java b/src/main/java/org/java_websocket/framing/ControlFrame.java
@@ -29,7 +29,7 @@
 import org.java_websocket.exceptions.InvalidFrameException;
 
 /**
- * Absstract class to represent control frames
+ * Abstract class to represent control frames
  */
 public abstract class ControlFrame extends FramedataImpl1 {
 
diff --git a/src/main/java/org/java_websocket/framing/DataFrame.java b/src/main/java/org/java_websocket/framing/DataFrame.java
@@ -28,7 +28,7 @@
 import org.java_websocket.exceptions.InvalidDataException;
 
 /**
- * Absstract class to represent data frames
+ * Abstract class to represent data frames
  */
 public abstract class DataFrame extends FramedataImpl1 {
 
diff --git a/src/main/java/org/java_websocket/framing/Framedata.java b/src/main/java/org/java_websocket/framing/Framedata.java
@@ -27,6 +27,9 @@
 
 import java.nio.ByteBuffer;
 
+/**
+ * The interface for the frame
+ */
 public interface Framedata {
 	/**
 	 * Enum which contains the different valid opcodes
diff --git a/src/main/java/org/java_websocket/framing/FramedataImpl1.java b/src/main/java/org/java_websocket/framing/FramedataImpl1.java
@@ -30,6 +30,9 @@
 
 import java.nio.ByteBuffer;
 
+/**
+ * Abstract implementation of a frame
+ */
 public abstract class FramedataImpl1 implements Framedata {
 
     /**
diff --git a/src/main/java/org/java_websocket/framing/package-info.java b/src/main/java/org/java_websocket/framing/package-info.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2010-2018 Nathan Rajlich
+ *
+ *  Permission is hereby granted, free of charge, to any person
+ *  obtaining a copy of this software and associated documentation
+ *  files (the "Software"), to deal in the Software without
+ *  restriction, including without limitation the rights to use,
+ *  copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the
+ *  Software is furnished to do so, subject to the following
+ *  conditions:
+ *
+ *  The above copyright notice and this permission notice shall be
+ *  included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ *  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ *  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ *  OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * This package encapsulates all interfaces and implementations in relation with the WebSocket frames.
+ */
+package org.java_websocket.framing;
diff --git a/src/main/java/org/java_websocket/handshake/ClientHandshake.java b/src/main/java/org/java_websocket/handshake/ClientHandshake.java
@@ -25,7 +25,11 @@
 
 package org.java_websocket.handshake;
 
+/**
+ * The interface for a client handshake
+ */
 public interface ClientHandshake extends Handshakedata {
+
 	/**
 	 * returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2
 	 * @return the HTTP Request-URI
diff --git a/src/main/java/org/java_websocket/handshake/ClientHandshakeBuilder.java b/src/main/java/org/java_websocket/handshake/ClientHandshakeBuilder.java
@@ -25,6 +25,14 @@
 
 package org.java_websocket.handshake;
 
+/**
+ * The interface for building a handshake for the client
+ */
 public interface ClientHandshakeBuilder extends HandshakeBuilder, ClientHandshake {
+
+	/**
+	 * Set a specific resource descriptor
+	 * @param resourceDescriptor the resource descriptior to set
+	 */
 	void setResourceDescriptor( String resourceDescriptor );
 }
diff --git a/src/main/java/org/java_websocket/handshake/HandshakeBuilder.java b/src/main/java/org/java_websocket/handshake/HandshakeBuilder.java
@@ -25,7 +25,21 @@
 
 package org.java_websocket.handshake;
 
+/**
+ * The interface for building a handshake
+ */
 public interface HandshakeBuilder extends Handshakedata {
+
+	/**
+	 * Setter for the content of the handshake
+	 * @param content the content to set
+	 */
 	void setContent( byte[] content );
+
+	/**
+	 * Adding a specific field with a specific value
+	 * @param name the http field
+	 * @param value the value for this field
+	 */
 	void put( String name, String value );
 }
diff --git a/src/main/java/org/java_websocket/handshake/HandshakeImpl1Client.java b/src/main/java/org/java_websocket/handshake/HandshakeImpl1Client.java
@@ -25,15 +25,24 @@
 
 package org.java_websocket.handshake;
 
+/**
+ * Implementation for a client handshake
+ */
 public class HandshakeImpl1Client extends HandshakedataImpl1 implements ClientHandshakeBuilder {
+
+	/**
+	 * Attribute for the resource descriptor
+	 */
 	private String resourceDescriptor = "*";
 
+	@Override
 	public void setResourceDescriptor( String resourceDescriptor ) throws IllegalArgumentException {
 		if(resourceDescriptor==null)
 			throw new IllegalArgumentException( "http resource descriptor must not be null" );
 		this.resourceDescriptor = resourceDescriptor;
 	}
 
+	@Override
 	public String getResourceDescriptor() {
 		return resourceDescriptor;
 	}
diff --git a/src/main/java/org/java_websocket/handshake/HandshakeImpl1Server.java b/src/main/java/org/java_websocket/handshake/HandshakeImpl1Server.java
@@ -25,8 +25,19 @@
 
 package org.java_websocket.handshake;
 
+/**
+ * Implementation for a server handshake
+ */
 public class HandshakeImpl1Server extends HandshakedataImpl1 implements ServerHandshakeBuilder {
+
+	/**
+	 * Attribute for the http status
+	 */
 	private short httpstatus;
+
+	/**
+	 * Attribute for the http status message
+	 */
 	private String httpstatusmessage;
 
 	@Override
@@ -39,13 +50,13 @@ public short getHttpStatus() {
 		return httpstatus;
 	}
 
+	@Override
 	public void setHttpStatusMessage( String message ) {
 		this.httpstatusmessage = message;
 	}
 
+	@Override
 	public void setHttpStatus( short status ) {
 		httpstatus = status;
 	}
-
-
 }
diff --git a/src/main/java/org/java_websocket/handshake/Handshakedata.java b/src/main/java/org/java_websocket/handshake/Handshakedata.java
@@ -27,9 +27,34 @@
 
 import java.util.Iterator;
 
+/**
+ * The interface for the data of a handshake
+ */
 public interface Handshakedata {
+
+	/**
+	 * Iterator for the http fields
+	 * @return the http fields
+	 */
 	Iterator<String> iterateHttpFields();
+
+	/**
+	 * Gets the value of the field
+	 * @param name The name of the field
+	 * @return the value of the field or an empty String if not in the handshake
+	 */
 	String getFieldValue( String name );
+
+	/**
+	 * Checks if this handshake contains a specific field
+	 * @param name The name of the field
+	 * @return true, if it contains the field
+	 */
 	boolean hasFieldValue( String name );
+
+	/**
+	 * Get the content of the handshake
+	 * @return the content as byte-array
+	 */
 	byte[] getContent();
 }
diff --git a/src/main/java/org/java_websocket/handshake/HandshakedataImpl1.java b/src/main/java/org/java_websocket/handshake/HandshakedataImpl1.java
@@ -29,26 +29,28 @@
 import java.util.Iterator;
 import java.util.TreeMap;
 
+/**
+ * Implementation of a handshake builder
+ */
 public class HandshakedataImpl1 implements HandshakeBuilder {
+
+	/**
+	 * Attribute for the content of the handshake
+	 */
 	private byte[] content;
+
+	/**
+	 * Attribute for the http fields and values
+	 */
 	private TreeMap<String,String> map;
 
+	/**
+	 * Constructor for handshake implementation
+	 */
 	public HandshakedataImpl1() {
 		map = new TreeMap<String,String>( String.CASE_INSENSITIVE_ORDER );
 	}
 
-	/*public HandshakedataImpl1( Handshakedata h ) {
-		httpstatusmessage = h.getHttpStatusMessage();
-		resourcedescriptor = h.getResourceDescriptor();
-		content = h.getContent();
-		map = new LinkedHashMap<String,String>();
-		Iterator<String> it = h.iterateHttpFields();
-		while ( it.hasNext() ) {
-			String key = (String) it.next();
-			map.put( key, h.getFieldValue( key ) );
-		}
-	}*/
-
 	@Override
 	public Iterator<String> iterateHttpFields() {
 		return Collections.unmodifiableSet( map.keySet() ).iterator();// Safety first
diff --git a/src/main/java/org/java_websocket/handshake/ServerHandshake.java b/src/main/java/org/java_websocket/handshake/ServerHandshake.java
@@ -25,7 +25,20 @@
 
 package org.java_websocket.handshake;
 
+/**
+ * Interface for the server handshake
+ */
 public interface ServerHandshake extends Handshakedata {
+
+	/**
+	 * Get the http status code
+	 * @return the http status code
+	 */
 	short getHttpStatus();
+
+	/**
+	 * Get the http status message
+	 * @return the http status message
+	 */
 	String getHttpStatusMessage();
 }
diff --git a/src/main/java/org/java_websocket/handshake/ServerHandshakeBuilder.java b/src/main/java/org/java_websocket/handshake/ServerHandshakeBuilder.java
diff --git a/src/main/java/org/java_websocket/handshake/package-info.java b/src/main/java/org/java_websocket/handshake/package-info.java
diff --git a/src/main/java/org/java_websocket/protocols/package-info.java b/src/main/java/org/java_websocket/protocols/package-info.java
diff --git a/src/main/java/org/java_websocket/server/package-info.java b/src/main/java/org/java_websocket/server/package-info.java
diff --git a/src/main/java/org/java_websocket/util/package-info.java b/src/main/java/org/java_websocket/util/package-info.java
