Package org.tquadrat.foundation.config.ap.impl.codebuilders

Interface CodeGeneratorContext

All Known Implementing Classes:

CodeGenerator

@ClassVersion(sourceVersion="$Id: CodeGeneratorContext.java 1061 2023-09-25 16:32:43Z tquadrat $")
@API(status=MAINTAINED,
     since="0.1.0")
public interface CodeGeneratorContext

The API that provides access to the code generator context, including the already generated code.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: CodeGeneratorContext.java 1061 2023-09-25 16:32:43Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ap.impl.codebuilders.CodeGeneratorContext"

⁠

Method Summary

Modifier and Type	Method	Description
void	addConstructorSuppressedWarning(SuppressableWarnings warning)	Adds a warning to the @SuppressWarnings annotation for the constructor of the new configuration bean.
static BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>	getAddMethodComposer()	Provides the default implementation of the method that composes an 'add' method for a given property.
TypeSpec.Builder	getClassBuilder()	Provides access to the class builder for the configuration bean.
JavaComposer	getComposer()	Provides access to the JavaComposer instance that is used for the code generation.
CodeGenerationConfiguration	getConfiguration()	Provides access to the configuration.
MethodSpec.Builder	getConstructorBuilder()	Provides access to the builder for the constructor.
CodeBlock.Builder	getConstructorCodeBuilder()	Provides access to the code builder for the constructor body.
static BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock>	getConstructorFragment4EnvironmentComposer()	Provides the default implementation of the method that composes a constructor fragment for the initialisation of a given property in case it is annotated with @EnvironmentVariable.
static BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock>	getConstructorFragment4SystemPreferenceComposer()	Provides the default implementation of the method that composes a constructor fragment for the initialisation of a given property in case it is annotated with @EnvironmentVariable.
static BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock>	getConstructorFragment4SystemPropComposer()	Provides the default implementation of the method that composes a constructor fragment for the initialisation of a given property in case it is annotated with @EnvironmentVariable.
static BiFunction<CodeBuilder,PropertySpecImpl,FieldSpec>	getFieldComposer()	Provides the default implementation of the method that composes a field for a given property.
static BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>	getGetterComposer()	Provides the default implementation of the method that composes a getter for a given property.
static BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec>	getSetterComposer()	Provides the default implementation of the method that composes a setter for a given property.
default SpecialPropertySpec	retrieveSpecialPropertySpecification(SpecialPropertyType type)	Returns the definition for the special property type.

Method Details

addConstructorSuppressedWarning

void addConstructorSuppressedWarning(SuppressableWarnings warning)

Adds a warning to the @SuppressWarnings annotation for the constructor of the new configuration bean.

Parameters:

warning - The warning to suppress.

getClassBuilder

TypeSpec.Builder getClassBuilder()

Provides access to the class builder for the configuration bean.

Returns:

The reference to the class builder.

getComposer

JavaComposer getComposer()

Provides access to the JavaComposer instance that is used for the code generation.

Returns:

The reference for the composer.

getAddMethodComposer

static BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec> getAddMethodComposer()

Provides the default implementation of the method that composes an 'add' method for a given property.

Returns:

The composer method.

getConstructorFragment4EnvironmentComposer

static BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock> getConstructorFragment4EnvironmentComposer()

Provides the default implementation of the method that composes a constructor fragment for the initialisation of a given property in case it is annotated with @EnvironmentVariable.

Returns:

The composer method.

getConstructorFragment4SystemPreferenceComposer

static BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock> getConstructorFragment4SystemPreferenceComposer()

Provides the default implementation of the method that composes a constructor fragment for the initialisation of a given property in case it is annotated with @EnvironmentVariable.

Returns:

The composer method.

getConstructorFragment4SystemPropComposer

static BiFunction<CodeBuilder,PropertySpecImpl,CodeBlock> getConstructorFragment4SystemPropComposer()

Provides the default implementation of the method that composes a constructor fragment for the initialisation of a given property in case it is annotated with @EnvironmentVariable.

Returns:

The composer method.

getFieldComposer

static BiFunction<CodeBuilder,PropertySpecImpl,FieldSpec> getFieldComposer()

Provides the default implementation of the method that composes a field for a given property.

Returns:

The composer method.

getGetterComposer

static BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec> getGetterComposer()

Provides the default implementation of the method that composes a getter for a given property.

Returns:

The composer method.

getSetterComposer

static BiFunction<CodeBuilder,PropertySpecImpl,MethodSpec> getSetterComposer()

Provides the default implementation of the method that composes a setter for a given property.

Returns:

The composer method.

getConfiguration

CodeGenerationConfiguration getConfiguration()

Provides access to the configuration.

Returns:

The configuration.

getConstructorBuilder

MethodSpec.Builder getConstructorBuilder()

Provides access to the builder for the constructor.

Returns:

The reference to the constructor builder.

getConstructorCodeBuilder

CodeBlock.Builder getConstructorCodeBuilder()

Provides access to the code builder for the constructor body.

Returns:

The reference to constructor body code builder.

retrieveSpecialPropertySpecification

default SpecialPropertySpec retrieveSpecialPropertySpecification(SpecialPropertyType type)

Returns the definition for the special property type.

Parameters:

type - The special property type.

Returns:

The special property specification.