refactoring to remove repeated code

Author: raydac

pom.xml

@@ -59,6 +59,27 @@
     </license>
   </licenses>
 
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jxr-plugin</artifactId>
+        <version>2.5</version>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-pmd-plugin</artifactId>
+        <version>3.4</version>
+        <configuration>
+          <detail>true</detail>
+          <aggregate>true</aggregate>
+          <format>html</format>
+          <verbose>true</verbose>
+          <printFailingErrors>true</printFailingErrors>
+        </configuration>
+      </plugin>
+    </plugins>
+  </reporting>
 
   <dependencies>
     <dependency>

src/main/java/com/igormaznitsa/jbbp/io/JBBPBitInputStream.java

@@ -137,23 +137,15 @@ public boolean[] readBoolArray(final int items) throws IOException {
     return result;
   }
 
-  /**
-   * Read array of bit sequence.
-   *
-   * @param bitNumber bit number for each bit sequence item, must be 1..8
-   * @param items number of items to be read, if less than zero then read whole
-   * stream till the end
-   * @return array of read bit items as a byte array
-   * @throws IOException it will be thrown for any transport problem during the
-   * operation
-   */
-  public byte[] readBitsArray(final int items, final JBBPBitNumber bitNumber) throws IOException {
+  private byte [] _readArray(final int items, final JBBPBitNumber bitNumber) throws IOException {
+    final boolean readByteArray = bitNumber == null;
+    
     int pos = 0;
     if (items < 0) {
       byte[] buffer = new byte[INITIAL_ARRAY_BUFFER_SIZE];
       // till end
       while (true) {
-        final int next = readBits(bitNumber);
+        final int next = readByteArray ? read() : readBits(bitNumber);
         if (next < 0) {
           break;
         }
@@ -174,16 +166,37 @@ public byte[] readBitsArray(final int items, final JBBPBitNumber bitNumber) thro
     else {
       // number
       final byte[] buffer = new byte[items];
+      if (readByteArray){
+        final int read = this.read(buffer, 0, items);
+        if (read != items) {
+          throw new EOFException("Have read only " + read + " byte(s) instead of " + items + " byte(s)");
+        }
+      }else{
       for (int i = 0; i < items; i++) {
         final int next = readBits(bitNumber);
         if (next < 0) {
           throw new EOFException("Have read only " + i + " bit portions instead of " + items);
         }
         buffer[i] = (byte) next;
       }
+      }
       return buffer;
     }
   }
+  
+  /**
+   * Read array of bit sequence.
+   *
+   * @param bitNumber bit number for each bit sequence item, must be 1..8
+   * @param items number of items to be read, if less than zero then read whole
+   * stream till the end
+   * @return array of read bit items as a byte array
+   * @throws IOException it will be thrown for any transport problem during the
+   * operation
+   */
+  public byte[] readBitsArray(final int items, final JBBPBitNumber bitNumber) throws IOException {
+    return _readArray(items, bitNumber);
+  }
 
   /**
    * Read number of bytes for the stream.
@@ -195,38 +208,7 @@ public byte[] readBitsArray(final int items, final JBBPBitNumber bitNumber) thro
    * operation
    */
   public byte[] readByteArray(final int items) throws IOException {
-    int pos = 0;
-    if (items < 0) {
-      byte[] buffer = new byte[INITIAL_ARRAY_BUFFER_SIZE];
-      // till end
-      while (true) {
-        final int next = read();
-        if (next < 0) {
-          break;
-        }
-        if (buffer.length == pos) {
-          final byte[] newbuffer = new byte[buffer.length << 1];
-          System.arraycopy(buffer, 0, newbuffer, 0, buffer.length);
-          buffer = newbuffer;
-        }
-        buffer[pos++] = (byte) next;
-      }
-      if (buffer.length == pos) {
-        return buffer;
-      }
-      final byte[] result = new byte[pos];
-      System.arraycopy(buffer, 0, result, 0, pos);
-      return result;
-    }
-    else {
-      // number
-      final byte[] buffer = new byte[items];
-      final int read = this.read(buffer, 0, items);
-      if (read != items) {
-        throw new EOFException("Have read only " + read + " byte(s) instead of " + items + " byte(s)");
-      }
-      return buffer;
-    }
+    return _readArray(items, null);
   }
 
   /**

src/main/java/com/igormaznitsa/jbbp/model/AbstractFieldByteArray.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2015 Igor Maznitsa.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.igormaznitsa.jbbp.model;
+
+import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
+import com.igormaznitsa.jbbp.utils.JBBPUtils;
+
+/**
+ * Inside abstract class to keep common operations for byte array based entities.
+ * @param <T> type of array item.
+ */
+abstract class AbstractFieldByteArray<T extends JBBPAbstractField> extends JBBPAbstractArrayField<T> {
+  private static final long serialVersionUID = -884448637983315507L;
+  
+  protected final byte [] array;
+
+  public AbstractFieldByteArray(final JBBPNamedFieldInfo name, final byte [] array) {
+    super(name);
+    JBBPUtils.assertNotNull(array, "Array must not be null");
+    this.array = array;
+  }
+  
+  @Override
+  public boolean getAsBool(final int index) {
+    return this.array[index] != 0;
+  }
+
+  @Override
+  public long getAsLong(final int index) {
+    return this.getAsInt(index);
+  }
+
+}

src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayByte.java

@@ -22,22 +22,16 @@
  * Describes a byte array.
  * @since 1.0
  */
-public final class JBBPFieldArrayByte extends JBBPAbstractArrayField<JBBPFieldByte>{
+public final class JBBPFieldArrayByte extends AbstractFieldByteArray<JBBPFieldByte>{
   private static final long serialVersionUID = -8100947416351943918L;
-  /**
-   * Inside storage of values.
-   */
-  private final byte [] array;
 
   /**
    * The Constructor.
    * @param name the field name info, it can be null.
    * @param array the values array, it must not be null
    */
   public JBBPFieldArrayByte(final JBBPNamedFieldInfo name, final byte [] array) {
-    super(name);
-    JBBPUtils.assertNotNull(array, "Array must not be null");
-    this.array = array;
+    super(name, array);
   }
 
   /**
@@ -68,11 +62,6 @@ public long getAsLong(final int index) {
     return this.getAsInt(index);
   }
 
-  @Override
-  public boolean getAsBool(final int index) {
-    return this.array[index] != 0;
-  }
-  
   @Override
   public Object getValueArrayAsObject(final boolean reverseBits) {
     final byte[] result;

src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayUByte.java

@@ -16,29 +16,21 @@
 package com.igormaznitsa.jbbp.model;
 
 import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
-import com.igormaznitsa.jbbp.utils.JBBPUtils;
 
 /**
  * Describes a unsigned byte array.
  * @since 1.0
  */
-public final class JBBPFieldArrayUByte extends JBBPAbstractArrayField<JBBPFieldUByte>{
+public final class JBBPFieldArrayUByte extends AbstractFieldByteArray<JBBPFieldUByte>{
   private static final long serialVersionUID = -2568935326782182401L;
 
-  /**
-   * The Inside value storage.
-   */
-  private final byte [] array;
-
   /**
    * The Constructor.
    * @param name a field name info, it can be null.
    * @param array a value array, it must not be null
    */
   public JBBPFieldArrayUByte(final JBBPNamedFieldInfo name, final byte[] array) {
-    super(name);
-    JBBPUtils.assertNotNull(array, "Array must not be null");
-    this.array = array;
+    super(name,array);
   }
 
   /**
@@ -64,16 +56,6 @@ public int getAsInt(final int index) {
     return this.array[index] & 0xFF;
   }
 
-  @Override
-  public long getAsLong(final int index) {
-    return this.getAsInt(index);
-  }
-
-  @Override
-  public boolean getAsBool(final int index) {
-    return this.array[index] != 0;
-  }
-  
   @Override
   public Object getValueArrayAsObject(final boolean reverseBits) {
     final byte[] result;

src/main/java/com/igormaznitsa/jbbp/utils/JBBPTextWriter.java

@@ -97,27 +97,18 @@ private String makeStructDescription(final Object obj, final Field field, final
     }
 
     private String makeArrayDescription(final Field field, final com.igormaznitsa.jbbp.mapper.Bin annotation) {
-      final StringBuilder result = new StringBuilder();
-      if (annotation.name().length() == 0) {
-        result.append(field.getName());
-      }
-      else {
-        result.append(annotation.name());
-      }
-      if (annotation.comment().length() != 0) {
-        result.append(", ").append(annotation.comment());
-      }
-      return result.toString();
+      return makeFieldDescription(field, annotation);
     }
 
     @Override
     protected void onArrayEnd(final Object obj, final Field field, final com.igormaznitsa.jbbp.mapper.Bin annotation) {
       try {
         IndentDec();
         HR();
-        if (field.getType() == String.class){
+        if (field.getType() == String.class) {
           Comment("END STRING : " + makeArrayDescription(field, annotation));
-        }else{
+        }
+        else {
           Comment("END ARRAY : " + makeArrayDescription(field, annotation));
         }
         HR();
@@ -134,9 +125,10 @@ protected void onArrayEnd(final Object obj, final Field field, final com.igormaz
     protected void onArrayStart(final Object obj, final Field field, final com.igormaznitsa.jbbp.mapper.Bin annotation, final int length) {
       try {
         HR();
-        if (field.getType() == String.class){
+        if (field.getType() == String.class) {
           Comment("STRING: " + makeFieldDescription(field, annotation));
-        }else{
+        }
+        else {
           Comment("START ARRAY : " + makeArrayDescription(field, annotation) + " OF " + field.getType().getComponentType().getSimpleName() + " [" + length + ']');
         }
         HR();
@@ -409,7 +401,7 @@ public interface Extra {
    * The Default value postfix.
    */
   private static final String DEFAULT_VALUE_POSTFIX = "";
-  
+
   /**
    * The Default horizontal rule prefix.
    */
@@ -549,7 +541,7 @@ public interface Extra {
    * The Current HR prefix.
    */
   private String prefixHR;
-  
+
   /**
    * The Current line position, 0 is first one.
    */
@@ -807,18 +799,16 @@ private void ensureNewLineMode() throws IOException {
    * @throws IOException it will be thrown for transport errors
    */
   private void printValueString(final String value) throws IOException {
-    if (this.valuesLineCounter > 0) {
-      if (this.valueSeparator.length() > 0) {
-        this.write(this.valueSeparator);
-      }
+    if (this.valuesLineCounter > 0 && this.valueSeparator.length() > 0) {
+      this.write(this.valueSeparator);
     }
 
     if (this.prefixValue.length() > 0) {
       this.write(this.prefixValue);
     }
-    
+
     this.write(value);
-    
+
     if (this.postfixValue.length() > 0) {
       this.write(this.postfixValue);
     }
@@ -867,11 +857,11 @@ public JBBPTextWriter Str(final String... str) throws IOException {
     final String oldPostfix = this.postfixValue;
     this.prefixValue = "";
     this.postfixValue = "";
-    
+
     for (final String s : str) {
       printValueString(s == null ? "<NULL>" : s);
     }
-    
+
     this.prefixValue = oldPrefix;
     this.postfixValue = oldPostfix;
     return this;
@@ -1381,6 +1371,7 @@ public JBBPTextWriter BR() throws IOException {
 
   /**
    * Change parameters for horizontal rule.
+   *
    * @param prefix the prefix to be printed before rule, it can be null
    * @param length the length in symbols.
    * @param ch symbol to draw

src/test/java/com/igormaznitsa/jbbp/it/SNAParsingTest.java

@@ -23,8 +23,7 @@
 import com.igormaznitsa.jbbp.utils.JBBPTextWriter;
 import com.igormaznitsa.jbbp.utils.JBBPUtils;
 import java.io.InputStream;
-import static junit.framework.Assert.assertTrue;
-import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.*;
 import org.junit.Test;
 
 /**

src/test/java/com/igormaznitsa/jbbp/mapper/JBBPMapperTest.java

@@ -111,7 +111,7 @@ private static class MappedWithStaticField{
   public void testMap_IgnoreStaticField() throws Exception {
     final MappedWithStaticField mapped = JBBPParser.prepare("int a;").parse(new byte[]{1,2,3,4}).mapTo(MappedWithStaticField.class);
     assertEquals(0x01020304,mapped.a);
-    assertEquals(111,mapped.ignored);
+    assertEquals(111,MappedWithStaticField.ignored);
   }
 
   @Test