#1591 #1521 class retention and meta-annotation AllStructural support for structural serialization

elucash · elucash · commit 7e30323164c0 · 2025-09-24T12:57:40.000-04:00
diff --git a/serial/src/org/immutables/serial/Serial.java b/serial/src/org/immutables/serial/Serial.java
@@ -40,7 +40,7 @@
    */
   @Target({ElementType.TYPE, ElementType.PACKAGE, ElementType.ANNOTATION_TYPE})
   @Retention(RetentionPolicy.SOURCE)
-  public @interface Version {
+  @interface Version {
     long value();
   }
 
@@ -61,5 +61,15 @@
    */
   @Target({ElementType.TYPE, ElementType.PACKAGE, ElementType.ANNOTATION_TYPE})
   @Retention(RetentionPolicy.SOURCE)
-  public @interface Structural {}
+  @interface Structural {}
+
+  /**
+   * Class-retention variant of {@link Structural}. Used to cover packages and style meta-annotation
+   * across module/jar boundaries where source code is not available. Originally, {@link Structural}
+   * were class retention annotation, but it was changed due to some (former) issues to be
+   * the source retained.
+   */
+  @Target({ElementType.TYPE, ElementType.PACKAGE, ElementType.ANNOTATION_TYPE})
+  @Retention(RetentionPolicy.CLASS)
+  @interface AllStructural {}
 }
diff --git a/value-fixture/src/org/immutables/fixture/serial/StructStyle.java b/value-fixture/src/org/immutables/fixture/serial/StructStyle.java
@@ -0,0 +1,8 @@
+package org.immutables.fixture.serial;
+
+import org.immutables.serial.Serial;
+import org.immutables.value.Value;
+
+@Value.Style(allParameters = true)
+@Serial.AllStructural
+public @interface StructStyle {}
diff --git a/value-fixture/src/org/immutables/fixture/serial/Structed.java b/value-fixture/src/org/immutables/fixture/serial/Structed.java
@@ -0,0 +1,10 @@
+package org.immutables.fixture.serial;
+
+import org.immutables.value.Value;
+
+@StructStyle
+@Value.Immutable
+public interface Structed {
+  int a();
+  String b();
+}
diff --git a/value-fixture/test/org/immutables/fixture/serial/SerialTest.java b/value-fixture/test/org/immutables/fixture/serial/SerialTest.java
@@ -22,11 +22,17 @@
 import java.io.Serializable;
 import java.lang.reflect.Field;
 import org.junit.jupiter.api.Test;
-import static org.immutables.check.Checkers.*;
+import static org.immutables.check.Checkers.check;
 
 public class SerialTest {
-  @Test
-  public void readResolveInterned() throws Exception {
+  @Test void hasReadReplace() throws NoSuchMethodException {
+    // this checks if AllStructural were applied
+    var writeReplaceMethod = ImmutableStructed.class.getDeclaredMethod("writeReplace");
+    // actually exception will be thrown, this is just to avoid unused variable warning
+    check(writeReplaceMethod).notNull();
+  }
+
+  @Test void readResolveInterned() throws Exception {
     ImmutableSomeSer instance0 = ImmutableSomeSer.builder().build();
     ImmutableSomeSer instance1 = ImmutableSomeSer.builder().regular(1).build();
     ImmutableSomeSer instance1_2 = ImmutableSomeSer.builder().regular(1).build();
@@ -40,8 +46,7 @@ public void readResolveInterned() throws Exception {
     check(deserialize(serialize(ImmutableOthSer.of()))).same(ImmutableOthSer.builder().build());
   }
 
-  @Test
-  public void copySerialVersion() throws Exception {
+  @Test void copySerialVersion() throws Exception {
     for (Field field : ImmutableSomeSer.class.getDeclaredFields()) {
       field.setAccessible(true);
       if (field.getName().equals("serialVersionUID") && field.get(null).equals(1L)) {
@@ -52,15 +57,13 @@ public void copySerialVersion() throws Exception {
     check(false);
   }
 
-  @Test
-  public void serializeModifiable() throws Exception {
+  @Test void serializeModifiable() throws Exception {
     ModifiableSomeSer instance = ModifiableSomeSer.create().setRegular(1);
     // interning
     check(deserialize(serialize(instance))).is(ModifiableSomeSer.create().setRegular(1));
   }
 
-  @Test
-  public void copySerialVersionModifiable() throws Exception {
+  @Test void copySerialVersionModifiable() throws Exception {
     for (Field field : ModifiableSomeSer.class.getDeclaredFields()) {
       field.setAccessible(true);
       if (field.getName().equals("serialVersionUID") && field.get(null).equals(1L)) {
diff --git a/value-processor/src/org/immutables/value/processor/meta/Proto.java b/value-processor/src/org/immutables/value/processor/meta/Proto.java
@@ -182,14 +182,14 @@ public Optional<Long> serialVersion() {
       Optional<VersionMirror> version = VersionMirror.find(element());
       return version.isPresent()
           ? Optional.of(version.get().value())
-          : Optional.<Long>absent();
+          : Optional.absent();
     }
 
     @Value.Derived
     @Value.Auxiliary
     public boolean isSerialStructural() {
       return environment().hasSerialModule()
-          && StructuralMirror.isPresent(element());
+          && (StructuralMirror.isPresent(element()) || AllStructuralMirror.isPresent(element()));
     }
 
     @Value.Derived
@@ -771,12 +771,22 @@ public Optional<Long> serialVersion() {
         }
       }
 
-      return Optional.<Long>absent();
+      return Optional.absent();
     }
 
     @Value.Lazy
     public boolean isSerialStructural() {
-      return StructuralMirror.isPresent(element());
+      if (!environment().hasSerialModule()) return false;
+
+      if (StructuralMirror.isPresent(element()) || AllStructuralMirror.isPresent(element())) {
+        return true;
+      }
+
+      for (MetaAnnotated m : metaAnnotated()) {
+        if (m.isSerialStructural()) return true;
+      }
+
+      return false;
     }
 
     @Value.Lazy
diff --git a/value-processor/src/org/immutables/value/processor/meta/SerialMirrors.java b/value-processor/src/org/immutables/value/processor/meta/SerialMirrors.java
@@ -27,4 +27,7 @@ private SerialMirrors() {}
 
   @Mirror.Annotation("org.immutables.serial.Serial.Structural")
   public @interface Structural {}
+  
+  @Mirror.Annotation("org.immutables.serial.Serial.AllStructural")
+  public @interface AllStructural {}
 }

Original file line number	Diff line number	Diff line change
`@@ -27,4 +27,7 @@ private SerialMirrors() {}`
`27`	`27`
`28`	`28`	`@Mirror.Annotation("org.immutables.serial.Serial.Structural")`
`29`	`29`	`public @interface Structural {}`
	`30`	`+`
	`31`	`+ @Mirror.Annotation("org.immutables.serial.Serial.AllStructural")`
	`32`	`+ public @interface AllStructural {}`
`30`	`33`	`}`