added JBBPOut.Bin to override @bin field values in written objects

Author: raydac

.gitignore

@@ -1,7 +1,7 @@
 /**/target/
 /target/
 /nbproject/
-/.idea/
+/**/.idea/
 *.iml
 /jbbp-plugins/jbbp-gradle/.gradle/
 /jbbp-plugins/jbbp-gradle/build/
@@ -39,4 +39,4 @@
 /jbbp-plugins/jbbp-gradle/bin/
 /jbbp-plugins/jbbp-gradle/.classpath
 /jbbp-plugins/jbbp-gradle/.project
-/.vscode/
+/**/.vscode/

README.md

@@ -13,6 +13,7 @@ Java has some embedded features to parse binary data (for instance ByteBuffer),
 
 # Change log
 - **2.0.2 (SNAPSHOT)**
+  - added `JBBPOut#Bin` variant to override `@Bin` annotation fields in written objects. 
   - [#28](https://github.com/raydac/java-binary-block-parser/issues/28) added `JBBPOut#BinForceByteOrder` to override byte order defined in `@Bin` annotations of written object.
 
 - **2.0.1 (04-feb-2020)**
@@ -29,13 +30,6 @@ Java has some embedded features to parse binary data (for instance ByteBuffer),
   - added generating of `makeFIELD()` method for structure types in Java class converter
   - refactoring
 
-- **1.4.1 (20-aug-2018)**
-  - fixed incompatibility in tokenizer regex syntax for Android SDK [#23](https://github.com/raydac/java-binary-block-parser/issues/23)
-  - added DslBinCustom annotation to provide way to mark custom type fields for JBBPDslBuilder
-  - fixed NPE in JBBPDslBuilder for not-provided outBitNumber attribute in annotated field  marked as type BIT or BIT_ARRAY [#20](https://github.com/raydac/java-binary-block-parser/issues/20)
-  - naming of fields has been made more tolerant, now it is allowed to have field names with names similar to data types
-  - improved check of field names in JBBPDslBuilder [#21](https://github.com/raydac/java-binary-block-parser/issues/21)
-
 [Full changelog](https://github.com/raydac/java-binary-block-parser/blob/master/changelog.txt)   
 
 # Maven dependency

changelog.txt

@@ -1,4 +1,5 @@
 2.0.2 (SNAPSHOT)
+ - added `JBBPOut#Bin` variant to override `@Bin` annotation fields in written objects.
  - [#28](https://github.com/raydac/java-binary-block-parser/issues/28) added `JBBPOut#BinForceByteOrder` to override byte order defined in `@Bin` annotations of written object.
 
 2.0.1

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

@@ -76,12 +76,17 @@ private static void assertFieldArray(final Field field) {
    *
    * @param obj                  an object which is an instance of a mapped class, must not be null
    * @param field                a field where the object has been found, it can be null for first call
-   * @param forceByteOrder       value to replace all byte order values in processing oject, can be null
+   * @param binAnnotationWrapper wrapper to replace Bin annotation values for processing fields, can be null to be ignored
    * @param customFieldProcessor a processor for custom fields, it can be null
    * @see Bin
    * @since 2.0.2
    */
-  protected void processObject(final Object obj, Field field, final JBBPByteOrder forceByteOrder, final Object customFieldProcessor) {
+  protected void processObject(
+      final Object obj,
+      final Field field,
+      final BinAnnotationWrapper binAnnotationWrapper,
+      final Object customFieldProcessor
+  ) {
     JBBPUtils.assertNotNull(obj, "Object must not be null");
 
     final List<MappedFieldRecord> orderedFields = JBBPMapper.findAffectedFields(obj);
@@ -92,13 +97,13 @@ protected void processObject(final Object obj, Field field, final JBBPByteOrder
     this.onStructStart(obj, field, clazzAnno == null ? fieldAnno : clazzAnno);
 
     for (final MappedFieldRecord rec : orderedFields) {
-      Bin binAnno = rec.binAnnotation;
+      final Bin binAnno = binAnnotationWrapper == null ? rec.binAnnotation : binAnnotationWrapper.setWrapped(rec.binAnnotation);
 
       if (binAnno.custom() && customFieldProcessor == null) {
-        throw new JBBPIllegalArgumentException("Class '" + obj.getClass().getName() + "' contains field '" + rec.mappingField.getName() + "\' which is custom one, you must provide JBBPCustomFieldWriter instance to save it.");
+        throw new JBBPIllegalArgumentException("Class '" + obj.getClass().getName() + "' contains field '" + rec.mappingField.getName() + "' which is custom one, you must provide JBBPCustomFieldWriter instance to save it.");
       }
 
-      processObjectField(obj, rec, forceByteOrder, binAnno, customFieldProcessor);
+      processObjectField(obj, rec, binAnno, customFieldProcessor);
     }
 
     this.onStructEnd(obj, field, clazzAnno == null ? fieldAnno : clazzAnno);
@@ -109,7 +114,6 @@ protected void processObject(final Object obj, Field field, final JBBPByteOrder
    *
    * @param obj                  the object which field under processing, must not be null
    * @param fieldRecord          internal record about the field, must not be null
-   * @param forceByteOrder       byte order to replace byte order defined for field, can be null
    * @param annotation           the annotation to be used as data source about the field,
    *                             must not be null
    * @param customFieldProcessor an object which will be provided for processing
@@ -119,21 +123,16 @@ protected void processObject(final Object obj, Field field, final JBBPByteOrder
   protected void processObjectField(
       final Object obj,
       final MappedFieldRecord fieldRecord,
-      final JBBPByteOrder forceByteOrder,
-      Bin annotation,
+      final Bin annotation,
       final Object customFieldProcessor
   ) {
     final Field field = fieldRecord.mappingField;
 
-    if (forceByteOrder != null) {
-      annotation = new BinAnnotationWrapper(annotation).setByteOrder(forceByteOrder);
-    }
-
     if (annotation.custom()) {
       this.onFieldCustom(obj, field, annotation, customFieldProcessor, readFieldValue(obj, fieldRecord));
     } else {
       final Class<?> fieldType = field.getType();
-
+      final BinAnnotationWrapper wrapper = annotation instanceof BinAnnotationWrapper ? (BinAnnotationWrapper) annotation : null;
       final BinType type;
       if (annotation.type() == BinType.UNDEFINED) {
         type = BinType.findCompatible(fieldType);
@@ -249,7 +248,7 @@ protected void processObjectField(
         }
         break;
         case STRUCT: {
-          processObject(readFieldValue(obj, fieldRecord), field, forceByteOrder, customFieldProcessor);
+          processObject(readFieldValue(obj, fieldRecord), field, wrapper, customFieldProcessor);
         }
         break;
         default: {
@@ -444,7 +443,7 @@ protected void processObjectField(
               final int len = Array.getLength(array);
               this.onArrayStart(obj, field, annotation, len);
               for (int i = 0; i < len; i++) {
-                this.processObject(Array.get(array, i), field, forceByteOrder, customFieldProcessor);
+                this.processObject(Array.get(array, i), field, wrapper, customFieldProcessor);
               }
               this.onArrayEnd(obj, field, annotation);
             }

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

@@ -20,6 +20,7 @@
 import com.igormaznitsa.jbbp.mapper.Bin;
 import com.igormaznitsa.jbbp.mapper.JBBPMapper;
 import com.igormaznitsa.jbbp.model.JBBPFieldShort;
+import com.igormaznitsa.jbbp.utils.BinAnnotationWrapper;
 import com.igormaznitsa.jbbp.utils.JBBPUtils;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
@@ -998,35 +999,53 @@ protected void assertNotEnded() {
    * through {@link Bin#order()} field, NB! By default Java doesn't keep field
    * outOrder. Ordered fields of class will be saved into internal cache for speed
    * but the cache can be reset through {@link JBBPMapper#clearFieldCache()}
+   * <b>Warning!</b> it doesn't affect byte order provided in Bin annotations of object.
    *
    * @param object an object to be saved into stream, must not be null
    * @return the context
    * @throws IOException it will be thrown for any transport error
    * @see JBBPMapper#clearFieldCache()
+   * @see #BinForceByteOrder(Object)
    * @see Bin
    * @since 1.1
    */
   public JBBPOut Bin(final Object object) throws IOException {
-    return this.Bin(object, null);
+    return this.Bin(object, null, null);
   }
 
   /**
    * Save fields of an object marked by Bin annotation. Fields will be ordered
    * through {@link Bin#order()} field, NB! By default Java doesn't keep field
    * outOrder. Ordered fields of class will be saved into internal cache for speed
    * but the cache can be reset through {@link JBBPMapper#clearFieldCache()}
+   * <b>Warning!</b> it doesn't affect byte order provided in Bin annotations of object.
    *
    * @param object            an object to be saved into stream, must not be null
    * @param customFieldWriter a custom field writer to be used for saving of
    *                          custom fields of the object, it can be null
    * @return the context
    * @see JBBPMapper#clearFieldCache()
    * @see Bin
+   * @see #BinForceByteOrder(Object, JBBPCustomFieldWriter)
    * @since 1.1
    */
   public JBBPOut Bin(final Object object, final JBBPCustomFieldWriter customFieldWriter) {
+    return this.Bin(object, null, customFieldWriter);
+  }
+
+  /**
+   * Save fields of object but bin annotation wrapper can be provided to replace some annnotation field values in <b>all</b> field annotations.
+   *
+   * @param object               an object to be saved into stream, must not be null
+   * @param binAnnotationWrapper wrapper for all bin annotations, can be null
+   * @param customFieldWriter    a custom field writer to be used for saving of
+   *                             custom fields of the object, it can be null
+   * @return the context
+   * @since 2.0.2
+   */
+  public JBBPOut Bin(final Object object, final BinAnnotationWrapper binAnnotationWrapper, final JBBPCustomFieldWriter customFieldWriter) {
     if (this.processCommands) {
-      this.processObject(object, null, null, customFieldWriter);
+      this.processObject(object, null, binAnnotationWrapper, customFieldWriter);
     }
     return this;
   }
@@ -1047,20 +1066,18 @@ public JBBPOut BinForceByteOrder(final Object object) throws IOException {
   }
 
   /**
-   * Works like {@link #Bin(Object, JBBPCustomFieldWriter)} but forcing override of all annotation byte order values by the JBBPOut byte order.
+   * Works like {@link #Bin(Object, JBBPCustomFieldWriter)} but forcing override of all annotation byte order values by the context byte order.
    *
    * @param object            an object to be saved into stream, must not be null
    * @param customFieldWriter a custom field writer to be used for saving of
    *                          custom fields of the object, it can be null
    * @return the context
+   * @see #ByteOrder(JBBPByteOrder)
    * @see Bin#byteOrder()
    * @since 2.0.2
    */
   public JBBPOut BinForceByteOrder(final Object object, final JBBPCustomFieldWriter customFieldWriter) {
-    if (this.processCommands) {
-      this.processObject(object, null, this.byteOrder, customFieldWriter);
-    }
-    return this;
+    return this.Bin(object, new BinAnnotationWrapper().setByteOrder(this.byteOrder), customFieldWriter);
   }
 
   @Override

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

@@ -8,12 +8,13 @@
 import java.lang.annotation.Annotation;
 
 /**
- * Auxiliary class to replace Bin annotation fields during internal processing
+ * Auxiliary class to replace Bin annotation field values.
+ * <b>Not thread safe!</b>
  *
- * @since 2.0.
+ * @since 2.0.2
  */
-public class BinAnnotationWrapper implements Bin {
-  private final Bin bin;
+public final class BinAnnotationWrapper implements Bin {
+  private Bin bin;
   private String name;
   private String path;
   private String customType;
@@ -27,8 +28,12 @@ public class BinAnnotationWrapper implements Bin {
   private Integer order;
   private String comment;
 
-  public BinAnnotationWrapper(final Bin bin) {
+  public BinAnnotationWrapper() {
+  }
+
+  public BinAnnotationWrapper setWrapped(final Bin bin) {
     this.bin = bin;
+    return this;
   }
 
   public BinAnnotationWrapper setName(final String value) {
@@ -38,6 +43,7 @@ public BinAnnotationWrapper setName(final String value) {
 
   @Override
   public String name() {
+    assert this.bin != null;
     return this.name == null ? this.bin.name() : this.name;
   }
 
@@ -48,6 +54,7 @@ public BinAnnotationWrapper setPath(final String value) {
 
   @Override
   public String path() {
+    assert this.bin != null;
     return this.path == null ? this.bin.path() : this.path;
   }
 
@@ -58,6 +65,7 @@ public BinAnnotationWrapper setCustomType(final String value) {
 
   @Override
   public String customType() {
+    assert this.bin != null;
     return this.customType == null ? this.bin.customType() : this.customType;
   }
 
@@ -68,6 +76,7 @@ public BinAnnotationWrapper setArraySizeExpr(final String value) {
 
   @Override
   public String arraySizeExpr() {
+    assert this.bin != null;
     return this.arraySizeExpr == null ? this.bin.arraySizeExpr() : this.arraySizeExpr;
   }
 
@@ -78,6 +87,7 @@ public BinAnnotationWrapper setType(final BinType value) {
 
   @Override
   public BinType type() {
+    assert this.bin != null;
     return this.type == null ? this.bin.type() : this.type;
   }
 
@@ -88,6 +98,7 @@ public BinAnnotationWrapper setBitOrder(final JBBPBitOrder value) {
 
   @Override
   public JBBPBitOrder bitOrder() {
+    assert this.bin != null;
     return this.bitOrder == null ? this.bin.bitOrder() : this.bitOrder;
   }
 
@@ -98,6 +109,7 @@ public BinAnnotationWrapper setCustom(final Boolean value) {
 
   @Override
   public boolean custom() {
+    assert this.bin != null;
     return this.custom == null ? this.bin.custom() : this.custom;
   }
 
@@ -108,6 +120,7 @@ public BinAnnotationWrapper setParamExpr(final String value) {
 
   @Override
   public String paramExpr() {
+    assert this.bin != null;
     return this.paramExpr == null ? this.bin.paramExpr() : this.paramExpr;
   }
 
@@ -118,6 +131,7 @@ public BinAnnotationWrapper setBitNumber(final JBBPBitNumber value) {
 
   @Override
   public JBBPBitNumber bitNumber() {
+    assert this.bin != null;
     return this.bitNumber == null ? this.bin.bitNumber() : this.bitNumber;
   }
 
@@ -128,6 +142,7 @@ public BinAnnotationWrapper setByteOrder(final JBBPByteOrder value) {
 
   @Override
   public JBBPByteOrder byteOrder() {
+    assert this.bin != null;
     return this.byteOrder == null ? this.bin.byteOrder() : this.byteOrder;
   }
 
@@ -138,6 +153,7 @@ public BinAnnotationWrapper setOrder(final Integer value) {
 
   @Override
   public int order() {
+    assert this.bin != null;
     return this.order == null ? this.bin.order() : this.order;
   }
 
@@ -148,11 +164,12 @@ public BinAnnotationWrapper setComment(final String value) {
 
   @Override
   public String comment() {
+    assert this.bin != null;
     return this.comment == null ? this.bin.comment() : this.comment;
   }
 
   @Override
   public Class<? extends Annotation> annotationType() {
-    return this.bin.getClass();
+    return Bin.class;
   }
 }

jbbp/src/test/java/com/igormaznitsa/jbbp/io/JBBPOutTest.java

@@ -32,9 +32,12 @@
 import com.igormaznitsa.jbbp.mapper.BinType;
 import com.igormaznitsa.jbbp.model.JBBPFieldInt;
 import com.igormaznitsa.jbbp.model.JBBPFieldLong;
+import com.igormaznitsa.jbbp.utils.BinAnnotationWrapper;
 import com.igormaznitsa.jbbp.utils.JBBPUtils;
 import java.io.ByteArrayOutputStream;
 import java.io.DataOutputStream;
+import java.io.IOException;
+import java.lang.reflect.Field;
 import org.junit.jupiter.api.Test;
 
 public class JBBPOutTest {
@@ -842,6 +845,28 @@ class Test {
     assertArrayEquals(new byte[] {(byte) 0x55, 0x0C}, BeginBin().Bin(new Test((byte) 0x05, (byte) 0x0A, (byte) 0x0C)).End().toByteArray());
   }
 
+  @Test
+  public void testBin_OverrideAnnotationValues() throws Exception {
+    class Test {
+      @Bin(bitNumber = JBBPBitNumber.BITS_4, type = BinType.BIT)
+      byte a = (byte) 0b10101010;
+    }
+
+    assertArrayEquals(new byte[] {(byte) 0b00001010}, BeginBin().Bin(new Test(), null, null).End().toByteArray());
+    assertArrayEquals(new byte[] {(byte) 0b10101010}, BeginBin().Bin(new Test(), new BinAnnotationWrapper().setBitNumber(JBBPBitNumber.BITS_8), null).End().toByteArray());
+    assertArrayEquals(new byte[] {(byte) 0b00000101}, BeginBin().Bin(new Test(), new BinAnnotationWrapper().setBitOrder(JBBPBitOrder.MSB0), null).End().toByteArray());
+    assertArrayEquals(new byte[] {(byte) 0b10101010}, BeginBin().Bin(new Test(), new BinAnnotationWrapper().setType(BinType.BYTE), null).End().toByteArray());
+
+    final JBBPCustomFieldWriter customFieldWriter = new JBBPCustomFieldWriter() {
+      @Override
+      public void writeCustomField(JBBPOut context, JBBPBitOutputStream outStream, Object instanceToSave, Field instanceCustomField, Bin fieldAnnotation, Object value) throws IOException {
+        outStream.write(123);
+      }
+    };
+
+    assertArrayEquals(new byte[] {(byte) 123}, BeginBin().Bin(new Test(), new BinAnnotationWrapper().setCustom(true), customFieldWriter).End().toByteArray());
+  }
+
   @Test
   public void testBin_UndefinedType_Short() throws Exception {
     class Test {