added support of payload for JBBPAbstractField, it allows user to save some specific extra data in such objects, JBBPdoesn't use the field

raydac · raydac · commit 33b1bf34d20c · 2015-05-21T22:09:05.000+03:00
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPAbstractArrayField.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPAbstractArrayField.java
@@ -97,6 +97,7 @@ public T next() {
         return getElementAt(this.index++);
       }
 
+      @Override
       public void remove() {
         throw new UnsupportedOperationException("Removing is unsupported here");
       }
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPAbstractField.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPAbstractField.java
@@ -20,37 +20,71 @@
 
 /**
  * The Class is the ancestor for all fields and arrays of fields.
+ *
  * @since 1.0
  */
 public abstract class JBBPAbstractField implements Serializable {
-  private static final long serialVersionUID = 8142829902016660630L;
-  
+
+  private static final long serialVersionUID = 6072321795839048728L;
+
   /**
    * The Field contains the field name info
    */
   protected final JBBPNamedFieldInfo fieldNameInfo;
 
+  /**
+   * The Variable can hold some payload. It is not used by JBBP and can be used
+   * without restrictions. By default it is null. The Field is not thread safe.
+   *
+   * @since 1.2.0
+   */
+  protected Serializable payload;
+
+  /**
+   * Set payload value. The Operation is not thread safe.
+   *
+   * @param value payload value, can be null.
+   * @since 1.2.0
+   */
+  public void setPayload(final Serializable value) {
+    this.payload = value;
+  }
+
+  /**
+   * Get payload value saved by user. The Operation is not thread safe.
+   *
+   * @return payload value, can be null
+   * @since 1.2.0
+   */
+  public Serializable getPayload() {
+    return this.payload;
+  }
+
   /**
    * The Constructor.
-   * @param namedField the name field info for the field, it can be null. 
+   *
+   * @param namedField the name field info for the field, it can be null.
    */
-  public JBBPAbstractField(final JBBPNamedFieldInfo namedField){
+  public JBBPAbstractField(final JBBPNamedFieldInfo namedField) {
     this.fieldNameInfo = namedField;
   }
-  
+
   /**
    * Get the field name info.
+   *
    * @return the field name info if it is presented, otherwise null
    */
-  public JBBPNamedFieldInfo getNameInfo(){
+  public JBBPNamedFieldInfo getNameInfo() {
     return this.fieldNameInfo;
   }
-  
+
   /**
    * Get the field path.
-   * @return the field path or null if the field doesn't contain any field name info
+   *
+   * @return the field path or null if the field doesn't contain any field name
+   * info
    */
-  public String getFieldPath(){
+  public String getFieldPath() {
     return this.fieldNameInfo == null ? null : this.fieldNameInfo.getFieldPath();
   }
 
@@ -60,14 +94,15 @@ public String getFieldPath(){
    * @return the field name or null if the field doesn't contain any field name
    * info
    */
-  public String getFieldName(){
+  public String getFieldName() {
     return this.fieldNameInfo == null ? null : this.fieldNameInfo.getFieldName();
   }
 
   /**
    * Get the field type in string representation.
-   * 
-   * @return the string representation of field type, like 'int', 'long', 'bool [123]'
+   *
+   * @return the string representation of field type, like 'int', 'long', 'bool
+   * [123]'
    * @since 1.2.0
    */
   public abstract String getTypeAsString();
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayBit.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayBit.java
@@ -76,7 +76,9 @@ public int size() {
 
   @Override
   public JBBPFieldBit getElementAt(final int index) {
-    return new JBBPFieldBit(this.fieldNameInfo, this.getAsInt(index), this.bitNumber);
+    final JBBPFieldBit result = new JBBPFieldBit(this.fieldNameInfo, this.getAsInt(index), this.bitNumber);
+    result.payload = this.payload;
+    return result;
   }
 
   @Override
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayBoolean.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayBoolean.java
@@ -55,7 +55,9 @@ public int size() {
 
   @Override
   public JBBPFieldBoolean getElementAt(final int index) {
-    return new JBBPFieldBoolean(this.fieldNameInfo, getAsBool(index));
+    final JBBPFieldBoolean result = new JBBPFieldBoolean(this.fieldNameInfo, getAsBool(index));
+    result.payload = this.payload;
+    return result;
   }
 
   @Override
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayByte.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayByte.java
@@ -48,7 +48,9 @@ public int size() {
 
   @Override
   public JBBPFieldByte getElementAt(final int index) {
-    return new JBBPFieldByte(this.fieldNameInfo, this.array[index]);
+    final JBBPFieldByte result = new JBBPFieldByte(this.fieldNameInfo, this.array[index]);
+    result.payload = this.payload;
+    return result;
   }
 
   @Override
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayInt.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayInt.java
@@ -55,7 +55,9 @@ public int size() {
 
   @Override
   public JBBPFieldInt getElementAt(final int index) {
-    return new JBBPFieldInt(this.fieldNameInfo, this.array[index]);
+    final JBBPFieldInt result = new JBBPFieldInt(this.fieldNameInfo, this.array[index]);
+    result.payload = this.payload;
+    return result;
   }
 
   @Override
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayLong.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayLong.java
@@ -55,7 +55,9 @@ public int size() {
 
   @Override
   public JBBPFieldLong getElementAt(final int index) {
-    return new JBBPFieldLong(this.fieldNameInfo, this.array[index]);
+    final JBBPFieldLong result = new JBBPFieldLong(this.fieldNameInfo, this.array[index]);
+    result.payload = this.payload;
+    return result;
   }
 
   @Override
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayShort.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayShort.java
@@ -55,7 +55,9 @@ public int size() {
 
   @Override
   public JBBPFieldShort getElementAt(final int index) {
-    return new JBBPFieldShort(this.fieldNameInfo, this.array[index]);
+    final JBBPFieldShort result = new JBBPFieldShort(this.fieldNameInfo, this.array[index]);
+    result.payload = this.payload;
+    return result;
   }
 
   @Override
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayUByte.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayUByte.java
@@ -48,7 +48,9 @@ public int size() {
 
   @Override
   public JBBPFieldUByte getElementAt(final int index) {
-    return new JBBPFieldUByte(this.fieldNameInfo, this.array[index]);
+    final JBBPFieldUByte result = new JBBPFieldUByte(this.fieldNameInfo, this.array[index]);
+    result.payload = this.payload;
+    return result;
   }
 
   @Override
diff --git a/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayUShort.java b/src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayUShort.java
@@ -55,7 +55,9 @@ public int size() {
 
   @Override
   public JBBPFieldUShort getElementAt(final int index) {
-    return new JBBPFieldUShort(this.fieldNameInfo, this.array[index]);
+    final JBBPFieldUShort result = new JBBPFieldUShort(this.fieldNameInfo, this.array[index]);
+    result.payload = this.payload;
+    return result;
   }
 
   @Override
diff --git a/src/test/java/com/igormaznitsa/jbbp/model/FakePayload.java b/src/test/java/com/igormaznitsa/jbbp/model/FakePayload.java
@@ -0,0 +1,23 @@
+/*
+ * 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 java.io.Serializable;
+
+public class FakePayload implements Serializable {
+  private static final long serialVersionUID = 9192692187614580755L;
+  
+}
diff --git a/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayBitTest.java b/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayBitTest.java
@@ -17,7 +17,7 @@
 
 import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
 import com.igormaznitsa.jbbp.io.JBBPBitNumber;
-import java.util.Random;
+import java.io.Serializable;
 import org.junit.Test;
 import static org.junit.Assert.*;
 
@@ -65,6 +65,18 @@ public void testGetAsInt(){
     }
   }
   
+  @Test
+  public void testGetElementAt(){
+    final int [] etalon = new int[]{255,0,1,2,3};
+    final Serializable payload = new FakePayload();
+    test.setPayload(payload);
+    for(int i=0;i<etalon.length;i++){
+      final JBBPFieldBit f = test.getElementAt(i);
+      assertSame(payload,f.getPayload());
+      assertEquals(etalon[i], f.getAsInt());
+    }
+  }
+  
   @Test
   public void testGetAsLong(){
     final long [] etalon = new long[]{255L,0L,1L,2L,3L};
diff --git a/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayBooleanTest.java b/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayBooleanTest.java
@@ -16,6 +16,7 @@
 package com.igormaznitsa.jbbp.model;
 
 import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
+import java.io.Serializable;
 import org.junit.Test;
 import static org.junit.Assert.*;
 
@@ -71,6 +72,18 @@ public void testGetAsLong() {
     }
   }
 
+  @Test
+  public void testGetElementAt() {
+    final boolean[] etalon = new boolean[]{true, false, true, true, false};
+    final Serializable payload = new FakePayload();
+    test.setPayload(payload);
+    for (int i = 0; i < etalon.length; i++) {
+      final JBBPFieldBoolean f = test.getElementAt(i);
+      assertSame(payload, f.getPayload());
+      assertEquals(etalon[i], f.getAsBool());
+    }
+  }
+
   @Test
   public void testIterable() {
     final boolean[] etalon = new boolean[]{true, false, true, true, false};
diff --git a/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayByteTest.java b/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayByteTest.java
@@ -16,6 +16,7 @@
 package com.igormaznitsa.jbbp.model;
 
 import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
+import java.io.Serializable;
 import org.junit.Test;
 import static org.junit.Assert.*;
 
@@ -74,6 +75,18 @@ public void testIterable() {
     }
   }
 
+  @Test
+  public void testGetElementAt() {
+    final int[] etalon = new int[]{-1, 0, 1, 2, 3};
+    final Serializable payload = new FakePayload();
+    test.setPayload(payload);
+    for (int i = 0; i < etalon.length; i++) {
+      final JBBPFieldByte f = test.getElementAt(i);
+      assertSame(payload, f.getPayload());
+      assertEquals(etalon[i], f.getAsInt());
+    }
+  }
+  
   @Test
   public void testGetValueArrayAsObject() {
     assertArrayEquals(array, (byte[]) test.getValueArrayAsObject(false));
diff --git a/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayIntTest.java b/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayIntTest.java
@@ -16,6 +16,7 @@
 package com.igormaznitsa.jbbp.model;
 
 import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
+import java.io.Serializable;
 import org.junit.Test;
 import static org.junit.Assert.*;
 
@@ -64,6 +65,19 @@ public void testGetAsLong() {
       assertEquals(etalon[i], test.getAsLong(i));
     }
   }
+  
+  @Test
+  public void testGetElementAt() {
+    final int[] etalon = new int[]{-278349, 12223423, 0, -2, 3};
+    final Serializable payload = new FakePayload();
+    test.setPayload(payload);
+    for (int i = 0; i < etalon.length; i++) {
+      final JBBPFieldInt f = test.getElementAt(i);
+      assertSame(payload, f.getPayload());
+      assertEquals(etalon[i], f.getAsInt());
+    }
+  }
+  
 
   @Test
   public void testIterable() {
diff --git a/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayLongTest.java b/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayLongTest.java
@@ -16,6 +16,7 @@
 package com.igormaznitsa.jbbp.model;
 
 import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
+import java.io.Serializable;
 import org.junit.Test;
 import static org.junit.Assert.*;
 
@@ -65,6 +66,19 @@ public void testGetAsLong() {
     }
   }
 
+  @Test
+  public void testGetElementAt() {
+    final long[] etalon = new long[]{-278349872364L, 12223423987439324L, 0L, -2782346872343L, 37238468273412L};
+    final Serializable payload = new FakePayload();
+    test.setPayload(payload);
+    for (int i = 0; i < etalon.length; i++) {
+      final JBBPFieldLong f = test.getElementAt(i);
+      assertSame(payload, f.getPayload());
+      assertEquals(etalon[i], f.getAsLong());
+    }
+  }
+
+  
   @Test
   public void testIterable() {
     final long[] etalon = new long[]{-278349872364L, 12223423987439324L, 0L, -2782346872343L, 37238468273412L};
diff --git a/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayShortTest.java b/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayShortTest.java
@@ -16,6 +16,7 @@
 package com.igormaznitsa.jbbp.model;
 
 import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
+import java.io.Serializable;
 import org.junit.Test;
 import static org.junit.Assert.*;
 
@@ -66,6 +67,18 @@ public void testGetAsLong() {
     }
   }
 
+  @Test
+  public void testGetElementAt() {
+    final int[] etalon = new int[]{-27834, 23423, 0, -2, 3};
+    final Serializable payload = new FakePayload();
+    test.setPayload(payload);
+    for (int i = 0; i < etalon.length; i++) {
+      final JBBPFieldShort f = test.getElementAt(i);
+      assertSame(payload, f.getPayload());
+      assertEquals(etalon[i], f.getAsInt());
+    }
+  }
+  
   @Test
   public void testIterable() {
     final int[] etalon = new int[]{-27834, 23423, 0, -2, 3};
diff --git a/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayUByteTest.java b/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayUByteTest.java
diff --git a/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayUShortTest.java b/src/test/java/com/igormaznitsa/jbbp/model/JBBPFieldArrayUShortTest.java

Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,7 @@ public T next() {`
`97`	`97`	`return getElementAt(this.index++);`
`98`	`98`	`}`
`99`	`99`
	`100`	`+ @Override`
`100`	`101`	`public void remove() {`
`101`	`102`	`throw new UnsupportedOperationException("Removing is unsupported here");`
`102`	`103`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,9 @@ public int size() {`
`76`	`76`
`77`	`77`	`@Override`
`78`	`78`	`public JBBPFieldBit getElementAt(final int index) {`
`79`		`- return new JBBPFieldBit(this.fieldNameInfo, this.getAsInt(index), this.bitNumber);`
	`79`	`+ final JBBPFieldBit result = new JBBPFieldBit(this.fieldNameInfo, this.getAsInt(index), this.bitNumber);`
	`80`	`+ result.payload = this.payload;`
	`81`	`+ return result;`
`80`	`82`	`}`
`81`	`83`
`82`	`84`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,9 @@ public int size() {`
`55`	`55`
`56`	`56`	`@Override`
`57`	`57`	`public JBBPFieldBoolean getElementAt(final int index) {`
`58`		`- return new JBBPFieldBoolean(this.fieldNameInfo, getAsBool(index));`
	`58`	`+ final JBBPFieldBoolean result = new JBBPFieldBoolean(this.fieldNameInfo, getAsBool(index));`
	`59`	`+ result.payload = this.payload;`
	`60`	`+ return result;`
`59`	`61`	`}`
`60`	`62`
`61`	`63`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,9 @@ public int size() {`
`48`	`48`
`49`	`49`	`@Override`
`50`	`50`	`public JBBPFieldByte getElementAt(final int index) {`
`51`		`- return new JBBPFieldByte(this.fieldNameInfo, this.array[index]);`
	`51`	`+ final JBBPFieldByte result = new JBBPFieldByte(this.fieldNameInfo, this.array[index]);`
	`52`	`+ result.payload = this.payload;`
	`53`	`+ return result;`
`52`	`54`	`}`
`53`	`55`
`54`	`56`	`@Override`