Update the document of PerMessageDeflateExtension

Author: dota17

src/main/java/org/java_websocket/extensions/permessage_deflate/PerMessageDeflateExtension.java

@@ -6,7 +6,13 @@
 importorg.java_websocket.extensions.CompressionExtension;
 importorg.java_websocket.extensions.ExtensionRequestData;
 importorg.java_websocket.extensions.IExtension;
-importorg.java_websocket.framing.*;
+importorg.java_websocket.framing.BinaryFrame;
+importorg.java_websocket.framing.CloseFrame;
+importorg.java_websocket.framing.ContinuousFrame;
+importorg.java_websocket.framing.DataFrame;
+importorg.java_websocket.framing.Framedata;
+importorg.java_websocket.framing.FramedataImpl1;
+importorg.java_websocket.framing.TextFrame;
 
 importjava.io.ByteArrayOutputStream;
 importjava.nio.ByteBuffer;
@@ -16,6 +22,12 @@
 importjava.util.zip.Deflater;
 importjava.util.zip.Inflater;
 
+/**
+ * PerMessage Deflate Extension (<a href="https://tools.ietf.org/html/rfc7692#section-7">7&#46; The "permessage-deflate" Extension</a> in
+ * <a href="https://tools.ietf.org/html/rfc7692">RFC 7692</a>).
+ *
+ * @see <a href="https://tools.ietf.org/html/rfc7692#section-7">7&#46; The "permessage-deflate" Extension in RFC 7692</a>
+ */
 publicclassPerMessageDeflateExtensionextendsCompressionExtension{
 
 // Name of the extension as registered by IETF https://tools.ietf.org/html/rfc7692#section-9.
@@ -28,7 +40,7 @@ public class PerMessageDeflateExtension extends CompressionExtension{
 privatestaticfinalStringCLIENT_MAX_WINDOW_BITS = "client_max_window_bits";
 privatestaticfinalintserverMaxWindowBits = 1 << 15;
 privatestaticfinalintclientMaxWindowBits = 1 << 15;
-privatestaticfinalbyte[] TAIL_BYTES ={0x00, 0x00, (byte)0xFF, (byte)0xFF};
+privatestaticfinalbyte[] TAIL_BYTES ={ (byte)0x00, (byte)0x00, (byte)0xFF, (byte)0xFF};
 privatestaticfinalintBUFFER_SIZE = 1 << 10;
 
 privatebooleanserverNoContextTakeover = true;
@@ -40,6 +52,24 @@ public class PerMessageDeflateExtension extends CompressionExtension{
 privateInflaterinflater = newInflater(true);
 privateDeflaterdeflater = newDeflater(Deflater.DEFAULT_COMPRESSION, true);
 
+/**
+ *
+ * @return serverNoContextTakeover
+ */
+publicbooleanisServerNoContextTakeover()
+{
+returnserverNoContextTakeover;
+ }
+
+/**
+ *
+ * @return clientNoContextTakeover
+ */
+publicbooleanisClientNoContextTakeover()
+{
+returnclientNoContextTakeover;
+ }
+
 /*
  An endpoint uses the following algorithm to decompress a message.
  1. Append 4 octets of 0x00 0x00 0xff 0xff to the tail end of the
@@ -93,6 +123,12 @@ We can check the getRemaining() method to see whether the data we supplied has b
  ((FramedataImpl1) inputFrame).setPayload(ByteBuffer.wrap(output.toByteArray(), 0, output.size()));
  }
 
+/**
+ *
+ * @param data the bytes of date
+ * @param outputBuffer the output stream
+ * @throws DataFormatException
+ */
 privatevoiddecompress(byte[] data, ByteArrayOutputStreamoutputBuffer) throwsDataFormatException{
 inflater.setInput(data);
 byte[] buffer = newbyte[BUFFER_SIZE];
@@ -146,6 +182,11 @@ public void encodeFrame(Framedata inputFrame){
  ((FramedataImpl1) inputFrame).setPayload(ByteBuffer.wrap(outputBytes, 0, outputLength));
  }
 
+/**
+ *
+ * @param data the bytes of data
+ * @return true if the data is OK
+ */
 privatebooleanendsWithTail(byte[] data){
 if(data.length < 4)
 returnfalse;

src/main/java/org/java_websocket/framing/FramedataImpl1.java

@@ -183,7 +183,7 @@ public void setFin(boolean fin){
 /**
  * Set the rsv1 of this frame to the provided boolean
  *
- * @param rsv1 true if fin has to be set
+ * @param rsv1 true if rsv1 has to be set
  */
 publicvoidsetRSV1(booleanrsv1){
 this.rsv1 = rsv1;
@@ -192,7 +192,7 @@ public void setRSV1(boolean rsv1){
 /**
  * Set the rsv2 of this frame to the provided boolean
  *
- * @param rsv2 true if fin has to be set
+ * @param rsv2 true if rsv2 has to be set
  */
 publicvoidsetRSV2(booleanrsv2){
 this.rsv2 = rsv2;
@@ -201,7 +201,7 @@ public void setRSV2(boolean rsv2){
 /**
  * Set the rsv3 of this frame to the provided boolean
  *
- * @param rsv3 true if fin has to be set
+ * @param rsv3 true if rsv3 has to be set
  */
 publicvoidsetRSV3(booleanrsv3){
 this.rsv3 = rsv3;

src/test/java/org/java_websocket/extensions/PerMessageDeflateExtensionTest.java

@@ -117,4 +117,18 @@ public void testToString() throws Exception{
 PerMessageDeflateExtensiondeflateExtension = newPerMessageDeflateExtension();
 assertEquals( "PerMessageDeflateExtension", deflateExtension.toString() );
  }
+
+@Test
+publicvoidtestIsServerNoContextTakeover()
+{
+PerMessageDeflateExtensiondeflateExtension = newPerMessageDeflateExtension();
+assertTrue(deflateExtension.isServerNoContextTakeover());
+ }
+
+@Test
+publicvoidtestIsClientNoContextTakeover()
+{
+PerMessageDeflateExtensiondeflateExtension = newPerMessageDeflateExtension();
+assertFalse(deflateExtension.isClientNoContextTakeover());
+ }
 }