Index
All Classes and Interfaces|All Packages
A
- addClassRetainedGenerated() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If true, generated classes are annotated with
RecordBuilderGenerated
which has a retention policy ofCLASS
. - addConcreteSettersForOptional() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Add non-optional setter methods for optional record components.
- addFunctionalMethodsToWith() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
When enabled, adds functional methods to the nested "With" class (such as
map()
andaccept()
). - addRecordBuilder() - Element in annotation interface io.soabase.recordbuilder.core.RecordInterface
- addRecordBuilder() - Element in annotation interface io.soabase.recordbuilder.core.RecordInterface.Include
-
If true the generated record is annotated with
@RecordBuilder
- addSingleItemCollectionBuilders() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
When enabled, collection types (
List
,Set
andMap
) are handled specially. - addStaticBuilder() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If true, a functional-style builder is added so that record instances can be instantiated without
new
. - allowNullableCollections() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
- asRecordInterface() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Template
B
- beanClassName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If set, the Builder will contain an internal interface with this name.
- booleanPrefix() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If set, all boolean builder getter methods will be prefixed with this string.
- builderClassModifiers() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Any additional
Modifier
you wish to apply to the builder. - builderMethodName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The name to use for the builder
- builderMode() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Whether to add standard builder, staged builder or both
- buildMethodName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The name to use for the build method
C
- classes() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Include
-
Synonym for
value()
. - classes() - Element in annotation interface io.soabase.recordbuilder.core.RecordInterface.Include
-
Synonym for
value()
. - componentsMethodName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The name to use for the method that returns the record components as a stream
- copyMethodName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The name to use for the copy builder
E
- emptyDefaultForOptional() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Set the default value of
Optional
record components toOptional.empty()
- enableGetters() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If true, getters will be generated for the Builder class.
- enableWither() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If true, a "With" interface is generated and an associated static factory
F
- fileComment() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Return the comment to place at the top of generated files.
- fileIndent() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Return the file indent to use
- fromMethodName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The name to use for the from-to-wither method
- fromWithClassName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The
RecordBuilder.Options.fromMethodName()
method instantiates an internal private class.
G
- getterPrefix() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If set, all builder getter methods will be prefixed with this string.
I
- IgnoreDefaultMethod - Annotation Interface in io.soabase.recordbuilder.core
- inheritComponentAnnotations() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If true, any annotations (if applicable) on record components are copied to the builder methods
- interfaceSuffix() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Used by
RecordInterface
. - interpretNotNulls() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Add not-null checks for record components annotated with any annotation named either "NotNull", "NoNull", or "NonNull" (see
RecordBuilder.Options.interpretNotNullsPattern()
for the actual regex matching pattern). - interpretNotNullsPattern() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If
RecordBuilder.Options.interpretNotNulls()
is true, this is the regex pattern used to determine if an annotation name means "not null" - io.soabase.recordbuilder.core - module io.soabase.recordbuilder.core
- io.soabase.recordbuilder.core - package io.soabase.recordbuilder.core
M
- mutableListClassName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If
RecordBuilder.Options.addSingleItemCollectionBuilders()
andRecordBuilder.Options.useImmutableCollections()
are enabled the builder uses an internal class to track changes to lists. - mutableMapClassName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If
RecordBuilder.Options.addSingleItemCollectionBuilders()
andRecordBuilder.Options.useImmutableCollections()
are enabled the builder uses an internal class to track changes to maps. - mutableSetClassName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If
RecordBuilder.Options.addSingleItemCollectionBuilders()
andRecordBuilder.Options.useImmutableCollections()
are enabled the builder uses an internal class to track changes to sets.
O
- onceOnlyAssignment() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If true, attributes can be set/assigned only 1 time.
- onceOnlyAssignmentName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
RecordBuilder.Options.onceOnlyAssignment()
method instantiates an internal private boolean array. - options() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Template
P
- packagePattern() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Include
-
Pattern used to generate the package for the generated class.
- packagePattern() - Element in annotation interface io.soabase.recordbuilder.core.RecordInterface.Include
-
Pattern used to generate the package for the generated class.
- packages() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Include
-
Optional list of package names.
- prefixEnclosingClassNames() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If the record is declared inside another class, the outer class's name will be prefixed to the builder name if this returns true.
- publicBuilderConstructors() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Makes the generated builder's constructors public
R
- RecordBuilder - Annotation Interface in io.soabase.recordbuilder.core
- RecordBuilder.BuilderMode - Enum Class in io.soabase.recordbuilder.core
- RecordBuilder.Include - Annotation Interface in io.soabase.recordbuilder.core
- RecordBuilder.Initializer - Annotation Interface in io.soabase.recordbuilder.core
-
Apply to record components to specify a field initializer for the generated builder
- RecordBuilder.Options - Annotation Interface in io.soabase.recordbuilder.core
- RecordBuilder.Template - Annotation Interface in io.soabase.recordbuilder.core
- RecordBuilderFull - Annotation Interface in io.soabase.recordbuilder.core
-
An alternate form of
@RecordBuilder
that has most optional features turned on - RecordBuilderGenerated - Annotation Interface in io.soabase.recordbuilder.core
-
Jacoco ignores classes and methods annotated with `*Generated`
- RecordInterface - Annotation Interface in io.soabase.recordbuilder.core
- RecordInterface.Include - Annotation Interface in io.soabase.recordbuilder.core
S
- setterPrefix() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
If set, all builder setter methods will be prefixed with this string.
- singleItemBuilderPrefix() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The prefix for adder methods when
RecordBuilder.Options.addSingleItemCollectionBuilders()
is enabled - source() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Initializer
-
The source class that contains the method/field specified by
value()
. - STAGED - Enum constant in enum class io.soabase.recordbuilder.core.RecordBuilder.BuilderMode
- stagedBuilderMethodName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The name to use for the staged builder if present
- stagedBuilderMethodSuffix() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The suffix to use for the staged builder interfaces if present
- STANDARD - Enum constant in enum class io.soabase.recordbuilder.core.RecordBuilder.BuilderMode
- STANDARD_AND_STAGED - Enum constant in enum class io.soabase.recordbuilder.core.RecordBuilder.BuilderMode
- suffix() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The builder class name will be the name of the record (prefixed with any enclosing class) plus this suffix.
U
- useImmutableCollections() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
- useUnmodifiableCollections() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
- useValidationApi() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
Pass built records through the Java Validation API if it's available in the classpath.
V
- value() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Include
- value() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Initializer
-
The name of a public static method or a public static final field in the source to use as the initializer
- value() - Element in annotation interface io.soabase.recordbuilder.core.RecordInterface.Include
- valueOf(String) - Static method in enum class io.soabase.recordbuilder.core.RecordBuilder.BuilderMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.soabase.recordbuilder.core.RecordBuilder.BuilderMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withClassMethodPrefix() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The prefix to use for the methods in the With class
- withClassName() - Element in annotation interface io.soabase.recordbuilder.core.RecordBuilder.Options
-
The name to use for the nested With class
All Classes and Interfaces|All Packages