Module io.helidon.builder.config.processor

Package io.helidon.builder.config.processor

Class ConfigBeanBuilderCreator

java.lang.Object

io.helidon.builder.processor.tools.DefaultBuilderCreatorProvider

io.helidon.builder.config.processor.ConfigBeanBuilderCreator

All Implemented Interfaces:

BuilderCreatorProvider

public class ConfigBeanBuilderCreator
extends DefaultBuilderCreatorProvider

A specialization of DefaultBuilderCreatorProvider that supports the additional add-ons to the builder generated classes that binds to the config sub-system.

See Also:

• GeneratedConfigBean
• GeneratedConfigBeanBuilder

Constructor Summary

Constructors

Constructor	Description
ConfigBeanBuilderCreator()	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	appendExtraBuilderMethods(StringBuilder builder, BodyContext ctx)	Adds extra builder methods.
protected void	appendExtraCtorCode(StringBuilder builder, BodyContext ctx, String builderTag)	Adds extra default ctor code.
protected void	appendExtraFields(StringBuilder builder, BodyContext ctx)	Adds extra fields on the main generated class.
protected void	appendExtraImports(StringBuilder builder, BodyContext ctx)	Adds extra imports to the generated builder.
protected void	appendExtraToBuilderBuilderFunctions(StringBuilder builder, BodyContext ctx, String decl)	Adds extra toBuilder() methods.
protected void	appendMetaAttributes(StringBuilder builder, BodyContext ctx)	Appends meta attribute related methods.
protected void	appendMetaProps(StringBuilder builder, BodyContext ctx, String tag, AtomicBoolean needsCustomMapOf)	Adds extra meta properties to the generated code.
protected Optional<TypeName>	baseExtendsBuilderTypeName(BodyContext ctx)	Returns any extra 'extends' type name that should be on the main generated builder type at the base level.
protected Optional<TypeName>	baseExtendsTypeName(BodyContext ctx)	Returns any extra 'extends' type name that should be on the main generated type at the base level.
protected String	generatedVersionFor(BodyContext ctx)	Returns the Generated version identifier.
protected String	instanceIdRef(BodyContext ctx)	The nuanced instance id for the DefaultBuilderCreatorProvider.appendToStringMethod(StringBuilder, BodyContext).
protected boolean	overridesVisitAttributes(BodyContext ctx)	Return true if the visitAttributes() methods is being overridden.
protected void	preValidate(TypeName implTypeName, TypeInfo typeInfo, AnnotationAndValue configBeanAnno)	Validates the integrity of the provided arguments in the context of what is being code generated.
Set<Class<? extends Annotation>>	supportedAnnotationTypes()	The set of Builder-like annotations that this creator knows how to handle.
protected String	toConfigKey(String name, boolean isAttribute)	Applicable if this builder is intended for config beans.

Methods inherited from class io.helidon.builder.processor.tools.DefaultBuilderCreatorProvider

appendAnnotations, appendBasicGetters, appendBuilderBuildPreSteps, appendCtorCodeBody, appendDirectNonOptionalSetter, appendExtraBuilderFields, appendExtraInnerClasses, appendExtraMethods, appendExtraPostCtorCode, appendFields, appendFooter, appendHeader, appendRequiredVisitor, appendSetter, appendToStringMethod, appendVisitAttributes, create, createBodyContext, extraImplementedBuilderContracts, extraImplementedTypeNames, fieldModifier, generatedCopyrightHeaderFor, generatedStickerFor, maybeAppendInterceptor, maybeAppendSingularSetter, maybeSingularFormOf, nameOf, normalizeConfiguredOptionKey, postValidate, toAbstractImplTypeName, toBody, toBuilderImplTypeName, toConfiguredOptionValue, toGenerics, toGenerics, toString, toString, toValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConfigBeanBuilderCreator

@Deprecated
public ConfigBeanBuilderCreator()

Deprecated.

Default constructor.

Method Details

supportedAnnotationTypes

public Set<Class<? extends Annotation>> supportedAnnotationTypes()

Description copied from interface: BuilderCreatorProvider

The set of Builder-like annotations that this creator knows how to handle. Note that this annotation must also be annotated with BuilderTrigger to qualify for inclusion. This is akin to Processor.getSupportedAnnotationTypes().

Specified by:

supportedAnnotationTypes in interface BuilderCreatorProvider

Overrides:

supportedAnnotationTypes in class DefaultBuilderCreatorProvider

Returns:

Implementors should return the set of annotations they can handle

preValidate

protected void preValidate(TypeName implTypeName,
 TypeInfo typeInfo,
 AnnotationAndValue configBeanAnno)

Description copied from class: DefaultBuilderCreatorProvider

Validates the integrity of the provided arguments in the context of what is being code generated.

Overrides:

preValidate in class DefaultBuilderCreatorProvider

Parameters:

implTypeName - the implementation type name

typeInfo - the type info

configBeanAnno - the builder annotation triggering the code generation

generatedVersionFor

protected String generatedVersionFor(BodyContext ctx)

Description copied from class: DefaultBuilderCreatorProvider

Returns the Generated version identifier.

Overrides:

generatedVersionFor in class DefaultBuilderCreatorProvider

Parameters:

ctx - the context

Returns:

the generated version identifier

baseExtendsTypeName

protected Optional<TypeName> baseExtendsTypeName(BodyContext ctx)

Description copied from class: DefaultBuilderCreatorProvider

Returns any extra 'extends' type name that should be on the main generated type at the base level.

Overrides:

baseExtendsTypeName in class DefaultBuilderCreatorProvider

Parameters:

ctx - the context

Returns:

extra contracts implemented

baseExtendsBuilderTypeName

protected Optional<TypeName> baseExtendsBuilderTypeName(BodyContext ctx)

Description copied from class: DefaultBuilderCreatorProvider

Returns any extra 'extends' type name that should be on the main generated builder type at the base level.

Overrides:

baseExtendsBuilderTypeName in class DefaultBuilderCreatorProvider

Parameters:

ctx - the context

Returns:

extra contracts implemented

instanceIdRef

protected String instanceIdRef(BodyContext ctx)

Description copied from class: DefaultBuilderCreatorProvider

The nuanced instance id for the DefaultBuilderCreatorProvider.appendToStringMethod(StringBuilder, BodyContext).

Overrides:

instanceIdRef in class DefaultBuilderCreatorProvider

Parameters:

ctx - the context

Returns:

the instance id

appendExtraImports

protected void appendExtraImports(StringBuilder builder,
 BodyContext ctx)

Description copied from class: DefaultBuilderCreatorProvider

Adds extra imports to the generated builder.

Overrides:

appendExtraImports in class DefaultBuilderCreatorProvider

Parameters:

builder - the builder

ctx - the context

appendMetaAttributes

protected void appendMetaAttributes(StringBuilder builder,
 BodyContext ctx)

Description copied from class: DefaultBuilderCreatorProvider

Appends meta attribute related methods.

Overrides:

appendMetaAttributes in class DefaultBuilderCreatorProvider

Parameters:

builder - the builder

ctx - the context

appendMetaProps

protected void appendMetaProps(StringBuilder builder,
 BodyContext ctx,
 String tag,
 AtomicBoolean needsCustomMapOf)

Description copied from class: DefaultBuilderCreatorProvider

Adds extra meta properties to the generated code.

Overrides:

appendMetaProps in class DefaultBuilderCreatorProvider

Parameters:

builder - the builder

ctx - the context

tag - the tag used to represent the meta props variable on the generated code

needsCustomMapOf - will be set to true if a custom map.of() function needs to be generated (i.e., if over 9 tuples)

appendExtraFields

protected void appendExtraFields(StringBuilder builder,
 BodyContext ctx)

Description copied from class: DefaultBuilderCreatorProvider

Adds extra fields on the main generated class.

Overrides:

appendExtraFields in class DefaultBuilderCreatorProvider

Parameters:

builder - the builder

ctx - the context

appendExtraCtorCode

protected void appendExtraCtorCode(StringBuilder builder,
 BodyContext ctx,
 String builderTag)

Description copied from class: DefaultBuilderCreatorProvider

Adds extra default ctor code.

Overrides:

appendExtraCtorCode in class DefaultBuilderCreatorProvider

Parameters:

builder - the builder

ctx - the context

builderTag - the tag (variable name) used for the builder arg

appendExtraToBuilderBuilderFunctions

protected void appendExtraToBuilderBuilderFunctions(StringBuilder builder,
 BodyContext ctx,
 String decl)

Description copied from class: DefaultBuilderCreatorProvider

Adds extra toBuilder() methods.

Overrides:

appendExtraToBuilderBuilderFunctions in class DefaultBuilderCreatorProvider

Parameters:

builder - the builder

ctx - the context

decl - the declaration template for the toBuilder method

appendExtraBuilderMethods

protected void appendExtraBuilderMethods(StringBuilder builder,
 BodyContext ctx)

Description copied from class: DefaultBuilderCreatorProvider

Adds extra builder methods. This base implementation will write the visitAttributes() method on the generated builder class.

Overrides:

appendExtraBuilderMethods in class DefaultBuilderCreatorProvider

Parameters:

builder - the builder

ctx - the context

overridesVisitAttributes

protected boolean overridesVisitAttributes(BodyContext ctx)

Description copied from class: DefaultBuilderCreatorProvider

Return true if the visitAttributes() methods is being overridden.

Overrides:

overridesVisitAttributes in class DefaultBuilderCreatorProvider

Parameters:

ctx - the context

Returns:

true if overriding visitAttributes();

toConfigKey

protected String toConfigKey(String name,
 boolean isAttribute)

Description copied from class: DefaultBuilderCreatorProvider

Applicable if this builder is intended for config beans.

Overrides:

toConfigKey in class DefaultBuilderCreatorProvider

Parameters:

name - the name

isAttribute - if the name represents an attribute value (otherwise is a config bean name)

Returns:

the config key