GFテスト,javadoc コメント修正

Author: okomeki

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>net.siisise</groupId>
     <artifactId>softlib.module</artifactId>
-    <version>1.1.17</version>
+    <version>1.1.18-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>SoftLib</name>
     <description>Java simple API Packet io, base64, etc...</description>
@@ -45,12 +45,12 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.13.0</version>
+                <version>3.14.0</version>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>3.10.0</version>
+                <version>3.11.2</version>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
@@ -64,7 +64,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-gpg-plugin</artifactId>
-                <version>3.2.5</version>
+                <version>3.2.8</version>
                 <executions>
                     <execution>
                         <id>sign-artifacts</id>
@@ -92,31 +92,19 @@
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>
-            <version>[5.12.0,)</version>
+            <version>[5.13.0,5.99.99)</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-params</artifactId>
-            <version>[5.12.0,)</version>
+            <version>[5.13.0,5.99.99)</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-engine</artifactId>
-            <version>[5.12.0,)</version>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.13.2</version>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.hamcrest</groupId>
-            <artifactId>hamcrest-core</artifactId>
-            <version>1.3</version>
+            <version>[5.13.0,5.99.99)</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

src/main/java/net/siisise/io/ArrayOutputStream.java

@@ -48,8 +48,8 @@ public ArrayOutputStream(byte[] data) {
 
     /**
      * 配列の特定位置からストリーム出力先にする。
-     * @param data
-     * @param offset 
+     * @param data ソース配列
+     * @param offset 位置
      */
     public ArrayOutputStream(byte[] data, int offset) {
         buff = data;

src/main/java/net/siisise/io/IndexOutput.java

@@ -21,11 +21,16 @@
 public interface IndexOutput {
 
     /**
-     * 上書き.
-     * @param index
-     * @param d 
+     * overwrite 上書き.
+     * @param index 位置
+     * @param d データ
      */
     void put(long index, byte d);
+    /**
+     * overwrite 上書き.
+     * @param index 位置
+     * @param d データ列
+     */
     void put(long index, byte[] d);
     void put(long index, byte[] d, int offset, int length);
 }

src/main/java/net/siisise/io/Input.java

@@ -83,14 +83,38 @@ default long read(Output dst) {
         return dst.write(this);
     }
 
+    /**
+     * 1バイト読み.
+     * @return 1バイトデータ
+     */
     byte get();
 
+    /**
+     * 特定サイズ取得.
+     * @param b 出力先
+     * @return 取得サイズ
+     */
     default long get(byte[] b) {
         return get(b, 0, b.length);
     }
 
+    /**
+     * 配列の途中にデータ取得.
+     * lengthがsizeより大きい場合はException
+     * @param b 配列
+     * @param offset 位置
+     * @param length　サイズ
+     * @return 取得サイズ
+     */
     long get(byte[] b, int offset, int length);
 
+    /**
+     * ここからoutにデータ複製または移動.
+     * outは固定サイズ、または可変サイズ
+     * 固定サイズの場合は上限まで読み込む.
+     * @param out 出力先
+     * @return 
+     */
     default long get(Output out) {
         if (out instanceof OverBlock && ((OverBlock) out).hasArray()) {
             ByteBlock o = (ByteBlock) out;
@@ -152,8 +176,8 @@ default int read(ByteBuffer dst) {
      * サイズが読み込めるかどうか.
      * length だと細かいデータのとき遅いかも.
      *
-     * @param size
-     * @return
+     * @param size 読み込み予定サイズ
+     * @return size以上のデータの有無
      */
     default boolean readable(long size) {
         return length() >= size;
@@ -215,6 +239,13 @@ public byte get() {
             return (byte) b[0];
         }
 
+        /**
+         * 部分読み込み.
+         * @param b 読み込み先
+         * @param offset 位置
+         * @param length サイズ
+         * @return 取得サイズ
+         */
         @Override
         public long get(byte[] b, int offset, int length) {
             int len = size();

src/main/java/net/siisise/io/NetReader.java

@@ -33,8 +33,8 @@ public class NetReader extends FilterReader {
     private final static char LF = '\n';
 
     /**
-     *
-     * @param r
+     * Readerつなぎ.
+     * @param r 読み出し元
      */
     public NetReader(Reader r) {
         super(r);
@@ -43,7 +43,7 @@ public NetReader(Reader r) {
     /**
      * 不正な文字コードが混入していないかUnicodeに変換してから一応チェック
      *
-     * @return
+     * @return 1行
      * @throws java.io.IOException
      */
     public String readLine() throws IOException {

src/main/java/net/siisise/io/Output.java

@@ -80,7 +80,7 @@ public interface Output {
      *
      * @param pac データ
      * @param length pac data length
-     * @return
+     * @return 移動サイズ
      */
     long write(Input pac, long length);
 
@@ -179,7 +179,7 @@ public void dwrite(byte[] d) {
         }
 
         /**
-         * 
+         * データの移動.
          * @param src 入力元
          * @return データ移動したサイズ
          */
@@ -188,6 +188,12 @@ public long write(Input src) {
             return Output.write(this, src, src.length());
         }
 
+        /**
+         * データの移動.
+         * @param pac 移動元
+         * @param length サイズ
+         * @return 移動したサイズ
+         */
         @Override
         public long write(Input pac, long length) {
             return Output.write(this, pac, length);

src/main/java/net/siisise/io/PacketA.java

@@ -176,7 +176,7 @@ public int read(byte[] b, int offset, int length) {
      * @param b 入れ物
      * @param offset b offset
      * @param length b length
-     * @return 
+     * @return 読み込めた長さ
      */
     @Override
     public int backRead(byte[] b, int offset, int length) {
@@ -289,12 +289,22 @@ public void write(byte[] src, int offset, int length) {
             offset += d.length;
         }
     }
-    
+
+    /**
+     * 直書き.
+     * @param d データ領域
+     */
     @Override
     public void dwrite(byte[] d) {
         nullPack.addPrev(d);        
     }
 
+    /**
+     * 逆書き.
+     * @param src 元データ
+     * @param offset 位置
+     * @param length データ長さ
+     */
     @Override
     public void backWrite(byte[] src, int offset, int length) {
         PacketIn nn = nullPack.next;
@@ -320,11 +330,19 @@ public void backWrite(byte[] src, int offset, int length) {
         }
     }
 
+    /**
+     * 直逆書き.
+     * @param d データ領域
+     */
     @Override
     public void dbackWrite(byte[] d) {
         nullPack.next.addPrev(d);
     }
 
+    /**
+     * read方向の長さ.
+     * @return 残りサイズ
+     */
     @Override
     public long length() {
         long length = 0;
@@ -335,7 +353,12 @@ public long length() {
         }
         return length;
     }
-    
+
+    /**
+     * 読み込み可能サイズの確認.
+     * @param size サイズ
+     * @return 可否
+     */
     @Override
     public boolean readable(long size) {
         PacketIn pc = nullPack.next;
@@ -454,7 +477,7 @@ public long skip(long length) {
     /**
      * backSkip 戻る
      * @param length 長さ
-     * @return 
+     * @return 戻れた長さ
      */
     @Override
     public long back(long length) {
@@ -468,7 +491,7 @@ public long back(long length) {
      * @param b データ
      * @param offset データ位置
      * @param length 長さ
-     * @return 
+     * @return 読み込めたデータ
      */
     @Override
     public PacketA get(long index, byte[] b, int offset, int length) {

src/main/java/net/siisise/io/RevInput.java

@@ -46,9 +46,9 @@ public interface RevInput {
     int backRead(byte[] buf, int offset, int length);
     int backRead(byte[] buf);
     /**
-     * 逆読み
-     * @param length
-     * @return 
+     * 逆読み.
+     * @param length 長さ
+     * @return パケットで分割
      */
     Packet backReadPacket(long length);
     /**