Skip to content

Start claiming the annotations we process + New option inheritRecordAnnotations #276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Randgalt merged 1 commit into from
Jun 23, 2026
Merged

Start claiming the annotations we process + New option inheritRecordAnnotations #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,20 +56,20 @@ The names used for generated methods, classes, etc. can be changed via the follo

## Miscellaneous

| option | details |
|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `@RecordBuilder.Options(inheritComponentAnnotations = true/false)` | If true, any annotations (if applicable) on record components are copied to the builder methods. The default is `true`. |
| `@RecordBuilder.Options(publicBuilderConstructors = true/false)` | Makes the generated builder's constructors public. The default is `false`. |
| `@RecordBuilder.Options(builderClassModifiers = {}})` | Any additional `javax.lang.model.element.Modifier` you wish to apply to the builder. |
| `@RecordBuilder.Options(beanClassName = "Foo")` | If set, the Builder will contain an internal interface with this name. |
| `@RecordBuilder.Options(addClassRetainedGenerated = true/false)` | If true, generated classes are annotated with `RecordBuilderGenerated`. The default is `false`. |
| `@RecordBuilder.Options(addStaticBuilder = true/false)` | If true, a functional-style builder is added so that record instances can be instantiated without `new()`. The default is `true`. |
| `@RecordBuilder.Options(inheritComponentAnnotations = true/false)` | If true, any annotations (if applicable) on record components are copied to the builder methods. The default is `true`. |
| `@RecordBuilder.Options(addConcreteSettersForOptional = <mode>)` | Add non-optional setter methods for optional record components. The default is `ConcreteSettersForOptionalMode.DISABLED`. |
| `@RecordBuilder.Options(nullableAnnotationClass = "com.foo.Nullable")` | Nullability annotation to use when RecordBuilder needs to add one. |
| `@RecordBuilder.Options(useValidationApi = true/false)` | Pass built records through the Java Validation API if it's available in the classpath. The default is `false`. |
| `@RecordBuilder.Options(builderMode = BuilderMode.XXX)` | Whether to add standard builder, staged builder or both. The default is `BuilderMode.STANDARD`. |
| `@RecordBuilder.Options(onceOnlyAssignment = true/false)` | If true, attributes can be set/assigned only 1 time. Attempts to reassign/reset attributes will throw `java.lang.IllegalStateException`. The default is `false`. |
| option | details |
|------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `@RecordBuilder.Options(inheritComponentAnnotations = true/false)` | If true, any annotations (if applicable) on record components are copied to the builder methods. The default is `true`. |
| `@RecordBuilder.Options(publicBuilderConstructors = true/false)` | Makes the generated builder's constructors public. The default is `false`. |
| `@RecordBuilder.Options(builderClassModifiers = {}})` | Any additional `javax.lang.model.element.Modifier` you wish to apply to the builder. |
| `@RecordBuilder.Options(beanClassName = "Foo")` | If set, the Builder will contain an internal interface with this name. |
| `@RecordBuilder.Options(addClassRetainedGenerated = true/false)` | If true, generated classes are annotated with `RecordBuilderGenerated`. The default is `false`. |
| `@RecordBuilder.Options(addStaticBuilder = true/false)` | If true, a functional-style builder is added so that record instances can be instantiated without `new()`. The default is `true`. |
| `@RecordBuilder.Options(addConcreteSettersForOptional = <mode>)` | Add non-optional setter methods for optional record components. The default is `ConcreteSettersForOptionalMode.DISABLED`. |
| `@RecordBuilder.Options(nullableAnnotationClass = "com.foo.Nullable")` | Nullability annotation to use when RecordBuilder needs to add one. |
| `@RecordBuilder.Options(useValidationApi = true/false)` | Pass built records through the Java Validation API if it's available in the classpath. The default is `false`. |
| `@RecordBuilder.Options(builderMode = BuilderMode.XXX)` | Whether to add standard builder, staged builder or both. The default is `BuilderMode.STANDARD`. |
| `@RecordBuilder.Options(onceOnlyAssignment = true/false)` | If true, attributes can be set/assigned only 1 time. Attempts to reassign/reset attributes will throw `java.lang.IllegalStateException`. The default is `false`. |
| `@RecordBuilder.Options(inheritRecordAnnotations = {})` | Set of annotations that are copied from the record to the generated builder when `inheritComponentAnnotations()` is `true`. |

### Staged Builders

Expand Down
8 changes: 8 additions & 0 deletions record-builder-core/src/main/java/io/soabase/recordbuilder/core/RecordBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,14 @@
* @see #nullablePattern
*/
boolean defaultNotNull() default false;

/**
* Set of annotations that are copied from the record to the generated builder if
* {@link #inheritComponentAnnotations()} is true
*
* @return annotations
*/
String[] inheritRecordAnnotations() default { "java.lang.SuppressWarnings" };
}

@Retention(RetentionPolicy.CLASS)
Expand Down
14 changes: 14 additions & 0 deletions ...ssor/src/main/java/io/soabase/recordbuilder/processor/InternalRecordBuilderProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.Element;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import java.lang.annotation.ElementType;
import java.util.*;
import java.util.function.BiConsumer;
Expand Down Expand Up @@ -94,6 +95,8 @@ class InternalRecordBuilderProcessor {
return;
}

addInheritedRecordAnnotations(builder, recordFacade, metaData);

addVisibility(recordFacade.builderIsInRecordPackage(), recordFacade.modifiers());
if (metaData.enableWither()) {
addWithNestedClass();
Expand Down Expand Up @@ -186,6 +189,17 @@ private boolean validateMethodNameConflicts(ProcessingEnvironment processingEnv,
});
}

private void addInheritedRecordAnnotations(TypeSpec.Builder builder, RecordFacade recordFacade,
RecordBuilder.Options metaData) {
if (metaData.inheritComponentAnnotations()) {
Set<String> inheritRecordAnnotationsInclusions = Set.of(metaData.inheritRecordAnnotations());
recordFacade.element().getAnnotationMirrors().stream()
.filter(annotation -> inheritRecordAnnotationsInclusions.contains(
((TypeElement) annotation.getAnnotationType().asElement()).getQualifiedName().toString()))
.map(AnnotationSpec::get).forEach(builder::addAnnotation);
}
}

private void addVisibility(boolean builderIsInRecordPackage, Set<Modifier> modifiers) {
if (builderIsInRecordPackage) {
if (modifiers.contains(Modifier.PUBLIC) || modifiers.contains(Modifier.PRIVATE)
Expand Down
Loading