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

Class CodeGenerator

java.lang.Object

org.tquadrat.foundation.config.ap.impl.CodeGenerator

All Implemented Interfaces:

CodeGeneratorContext

@ClassVersion(sourceVersion="$Id: CodeGenerator.java 1061 2023-09-25 16:32:43Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public final class CodeGenerator
extends Object
implements CodeGeneratorContext

Generates the code for the new configuration bean.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ap.impl.CodeGenerator"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final TypeSpec.Builder	m_ClassBuilder	The class builder.
private final JavaComposer	m_Composer	The instance of JavaComposer that is used for the code generation.
private final CodeGenerationConfiguration	m_Configuration	The configuration for the generation process.
private final MethodSpec.Builder	m_Constructor	The builder for the constructor.
private final CodeBlock.Builder	m_ConstructorCode	The builder for body of the constructor.
private static final Map<SpecialPropertyType,SpecialPropertySpec>	m_SpecialProperties	The special properties.
private final Set<SuppressableWarnings>	m_SuppressedWarningsForConstructor	The list of the suppressed warnings for the constructor of the new configuration bean.

Constructor Summary

Constructors

Constructor	Description
CodeGenerator(CodeGenerationConfiguration configuration)	Creates a new instance of CodeGenerator.

Method Summary

Modifier and Type	Method	Description
final void	addConstructorSuppressedWarning(SuppressableWarnings warning)	Adds a warning to the @SuppressWarnings annotation for the constructor of the new configuration bean.
final JavaFile	createCode()	Generates the code from the configuration provided in the constructor.
final TypeSpec.Builder	getClassBuilder()	Provides access to the class builder for the configuration bean.
final JavaComposer	getComposer()	Provides access to the JavaComposer instance that is used for the code generation.
final CodeGenerationConfiguration	getConfiguration()	Provides access to the configuration.
final MethodSpec.Builder	getConstructorBuilder()	Provides access to the builder for the constructor.
final CodeBlock.Builder	getConstructorCodeBuilder()	Provides access to the code builder for the constructor body.
static final SpecialPropertySpec	getSpecialPropertySpecification(SpecialPropertyType type)	Returns the definition for the special property type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tquadrat.foundation.config.ap.impl.codebuilders.CodeGeneratorContext

retrieveSpecialPropertySpecification

Field Details

m_ClassBuilder

private final TypeSpec.Builder m_ClassBuilder

The class builder.

m_Composer

private final JavaComposer m_Composer

The instance of JavaComposer that is used for the code generation.

m_Configuration

private final CodeGenerationConfiguration m_Configuration

The configuration for the generation process.

m_Constructor

private final MethodSpec.Builder m_Constructor

The builder for the constructor.

m_ConstructorCode

private final CodeBlock.Builder m_ConstructorCode

The builder for body of the constructor.

m_SuppressedWarningsForConstructor

private final Set<SuppressableWarnings> m_SuppressedWarningsForConstructor

The list of the suppressed warnings for the constructor of the new configuration bean.

m_SpecialProperties

private static final Map<SpecialPropertyType,SpecialPropertySpec> m_SpecialProperties

The special properties.

Constructor Details

CodeGenerator

public CodeGenerator(CodeGenerationConfiguration configuration)

Creates a new instance of CodeGenerator.

Parameters:

configuration - The configuration for the generation process.

Method Details

addConstructorSuppressedWarning

public final void addConstructorSuppressedWarning(SuppressableWarnings warning)

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

Specified by:

addConstructorSuppressedWarning in interface CodeGeneratorContext

Parameters:

warning - The warning to suppress.

createCode

public final JavaFile createCode()

Generates the code from the configuration provided in the constructor.

Returns:

The generated code.

getClassBuilder

public final TypeSpec.Builder getClassBuilder()

Provides access to the class builder for the configuration bean.

Specified by:

getClassBuilder in interface CodeGeneratorContext

Returns:

The reference to the class builder.

getComposer

public final JavaComposer getComposer()

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

Specified by:

getComposer in interface CodeGeneratorContext

Returns:

The reference for the composer.

getConfiguration

public final CodeGenerationConfiguration getConfiguration()

Provides access to the configuration.

Specified by:

getConfiguration in interface CodeGeneratorContext

Returns:

The configuration.

getConstructorBuilder

public final MethodSpec.Builder getConstructorBuilder()

Provides access to the builder for the constructor.

Specified by:

getConstructorBuilder in interface CodeGeneratorContext

Returns:

The reference to the constructor builder.

getConstructorCodeBuilder

public final CodeBlock.Builder getConstructorCodeBuilder()

Provides access to the code builder for the constructor body.

Specified by:

getConstructorCodeBuilder in interface CodeGeneratorContext

Returns:

The reference to constructor body code builder.

getSpecialPropertySpecification

public static final SpecialPropertySpec getSpecialPropertySpecification(SpecialPropertyType type)

Returns the definition for the special property type.

Parameters:

type - The special property type.

Returns:

The special property specification.