#1483 strictModifiable=false

elucash · elucash · commit c4597efc3ef3 · 2023-09-24T03:07:06.000-04:00
diff --git a/value-annotations/src/org/immutables/value/Value.java b/value-annotations/src/org/immutables/value/Value.java
@@ -635,7 +635,7 @@
     String underrideToString() default "";
 
     /**
-     * Delegates {@code toString} implementation completely to a fully qualified path to a method name, example {@code delegateToString="com.whatever.packg.ToStringer.strigify"}. The path will be used literally in generated code, and a single parameter will be passed to it, {@code this} immutable object instance.
+     * Delegates {@code toString} implementation completely to a fully qualified path to a method name, example {@code delegateToString="com.whatever.packg.ToStringer.stringify"}. The path will be used literally in generated code, and a single parameter will be passed to it, {@code this} immutable object instance.
      * <p><em>Note: If specified, it will take precedence over any other {@code toString} customization mechanism</em>
      * @return fully qualified static method name, if empty (by default) will not be used
      */
@@ -839,6 +839,14 @@
      */
     boolean strictBuilder() default false;
 
+    /**
+     * Strict modifiable will refuse any accessor value (by throwing {@link IllegalStateException})
+     * which is mandatory. Enabled by default. Set it to {@code false} and it will allow to get
+     * current field value even if not initialized ({@code null} for references, {@code 0}, {@code false} &mdash; for primitives).
+     * @return default is {@code true}, enabling strict modifiable
+     */
+    boolean strictModifiable() default true;
+
     /**
      * When {@code true} &mdash; disables check that all required attributes have been provided to a
      * builder.
diff --git a/value-fixture/src/org/immutables/fixture/modifiable/FromTypesModifiables.java b/value-fixture/src/org/immutables/fixture/modifiable/FromTypesModifiables.java
@@ -26,10 +26,11 @@ public abstract class FromManyTypes implements Iface {
   }
 
   @Value.Immutable
-  @Value.Style(from = "")
+  @Value.Style(from = "", strictModifiable = false)
   @Value.Modifiable
   interface NoFrom {
     int a();
+    String b();
     class Builder extends ImmutableNoFrom.Builder {}
   }
 }
diff --git a/value-fixture/test/org/immutables/fixture/modifiable/ModifiablesTest.java b/value-fixture/test/org/immutables/fixture/modifiable/ModifiablesTest.java
@@ -355,4 +355,19 @@ public void nullableMap() {
     check(nlm).is(nlm2);
     nlm2.clear(); // no NPE
   }
+
+  @Test void nonStrict() {
+    ModifiableNoFrom m = ModifiableNoFrom.create();
+    check(!m.isInitialized());
+    check(!m.aIsSet());
+    check(!m.bIsSet());
+    check(m.a()).is(0);
+    check(m.b()).isNull();
+    try {
+      m.toImmutable();
+      check(false);
+    } catch (IllegalStateException e) {
+      check(true);
+    }
+  }
 }
diff --git a/value-processor/src/org/immutables/value/processor/Modifiables.generator b/value-processor/src/org/immutables/value/processor/Modifiables.generator
@@ -500,9 +500,9 @@ public [thisReturnType type] [type.names.from]([type.typeModifiable] instance) {
 @Override
 [v.access][if not v.beanFriendlyModifiable]final [/if][v.atNullability][v.implementationModifiableType] [v.names.get]() {
 [if v.mandatory]
-  if (![isSet v]()) {[-- opportunistically reuse attributes check --]
-    [disambiguateAccessor type 'checkRequiredAttributes']();
-  }
+  [if type.useStrictModifiable][-- opportunistically reuse attributes check --]
+  if (![isSet v]()) [disambiguateAccessor type 'checkRequiredAttributes']();
+  [/if]
 [/if]
 [if v.generateLazy]
   [if v.attributeValueKindModifyFrom]
diff --git a/value-processor/src/org/immutables/value/processor/meta/StyleInfo.java b/value-processor/src/org/immutables/value/processor/meta/StyleInfo.java
@@ -201,6 +201,10 @@ public Class<? extends Annotation> annotationType() {
   @Override
   public abstract boolean strictBuilder();
 
+  @Value.Parameter
+  @Override
+  public abstract boolean strictModifiable();
+
   @Value.Parameter
   @Override
   public abstract ValidationMethod validationMethod();
@@ -504,6 +508,7 @@ static StyleInfo infoFrom(StyleMirror input) {
         input.packageGenerated(),
         ToImmutableInfo.FUNCTION.apply(input.defaults()),
         input.strictBuilder(),
+        input.strictModifiable(),
         input.validationMethod(),
         input.allParameters(),
         input.defaultAsDefault(),
diff --git a/value-processor/src/org/immutables/value/processor/meta/ValueMirrors.java b/value-processor/src/org/immutables/value/processor/meta/ValueMirrors.java
@@ -177,6 +177,8 @@ private ValueMirrors() {}
 
     boolean strictBuilder() default false;
 
+    boolean strictModifiable() default true;
+
     ValidationMethod validationMethod() default ValidationMethod.SIMPLE;
 
     boolean allParameters() default false;
diff --git a/value-processor/src/org/immutables/value/processor/meta/ValueType.java b/value-processor/src/org/immutables/value/processor/meta/ValueType.java
@@ -1055,6 +1055,10 @@ public boolean isUseStrictBuilder() {
         || style().stagedBuilder();
   }
 
+  public boolean isUseStrictModifiable() {
+    return style().strictModifiable();
+  }
+
   public boolean isUseJavaValidationApi() {
     return style().validationMethod() == ValueMirrors.Style.ValidationMethod.VALIDATION_API;
   }

Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,11 @@ public abstract class FromManyTypes implements Iface {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`@Value.Immutable`
`29`		`- @Value.Style(from = "")`
	`29`	`+ @Value.Style(from = "", strictModifiable = false)`
`30`	`30`	`@Value.Modifiable`
`31`	`31`	`interface NoFrom {`
`32`	`32`	`int a();`
	`33`	`+ String b();`
`33`	`34`	`class Builder extends ImmutableNoFrom.Builder {}`
`34`	`35`	`}`
`35`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1055,6 +1055,10 @@ public boolean isUseStrictBuilder() {`
`1055`	`1055`	`\|\| style().stagedBuilder();`
`1056`	`1056`	`}`
`1057`	`1057`
	`1058`	`+ public boolean isUseStrictModifiable() {`
	`1059`	`+ return style().strictModifiable();`
	`1060`	`+ }`
	`1061`	`+`
`1058`	`1062`	`public boolean isUseJavaValidationApi() {`
`1059`	`1063`	`return style().validationMethod() == ValueMirrors.Style.ValidationMethod.VALIDATION_API;`
`1060`	`1064`	`}`