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

Class CodeBuilderBase

java.lang.Object

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

All Implemented Interfaces:

CodeBuilder

Direct Known Subclasses:

CLIBeanBuilder, ConfigBeanBuilder, I18nSupportBuilder, INIBeanBuilder, MapImplementor, PreferencesBeanBuilder, SessionBeanBuilder

@ClassVersion(sourceVersion="$Id: CodeBuilderBase.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
abstract sealed class CodeBuilderBase
extends Object
implements CodeBuilder
permits CLIBeanBuilder, ConfigBeanBuilder, I18nSupportBuilder, INIBeanBuilder, MapImplementor, PreferencesBeanBuilder, SessionBeanBuilder

The abstract base class for all the code builders.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: CodeBuilderBase.java 1105 2024-02-28 12:58:46Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

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

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CodeBuilderBase.StringConverterInstantiation	The various type to instantiate a StringConverter class.

Nested classes/interfaces inherited from interface org.tquadrat.foundation.config.ap.impl.CodeBuilder

CodeBuilder.StandardField, CodeBuilder.StandardMethod

Field Summary

Fields

Modifier and Type	Field	Description
private final TypeSpec.Builder	m_ClassBuilder	The class builder.
private final JavaComposer	m_Composer	The composer.
private final CodeGenerationConfiguration	m_Configuration	The configuration for the code generation.
private final CodeBlock.Builder	m_ConstructorCode	The builder for body of the constructor.
private final CodeGeneratorContext	m_Context	The code generator context.
private static final Map<TypeName,ClassName>	m_ConverterRegistry	The registry for the known implementations of StringConverter implementations.
private final boolean	m_IsSynchronized	The synchronised flag.
private static final Map<CodeBuilder.StandardField,FieldSpec>	m_StandardFields	The standard fields.
private static final Map<CodeBuilder.StandardMethod,MethodSpec>	m_StandardMethods	The standard methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CodeBuilderBase(CodeGeneratorContext context)	Creates a new instance of CodeBuilderBase.

Method Summary

Modifier and Type	Method	Description
protected final void	addConstructorArgument(ParameterSpec argument)	Adds an argument to the constructor.
protected final void	addConstructorCode(CodeBlock code)	Adds code to the constructor body.
protected final void	addConstructorSuppressedWarning(SuppressableWarnings warning)	Adds a warning to the @SuppressWarnings annotation for the constructor of the new configuration bean.
protected final void	addField(CodeBuilder.StandardField reference, FieldSpec field)	Adds the given standard field to the new class.
protected final void	addField(FieldSpec field)	Adds the given field to the new class.
protected final void	addMethod(CodeBuilder.StandardMethod reference, MethodSpec method)	Adds the given method to the new class.
protected final void	addMethod(MethodSpec method)	Adds the given method to the new class.
abstract void	build()	Generates the relevant code.
static MethodSpec	composeAddMethod(CodeBuilder codeBuilder, PropertySpecImpl property)	The default implementation of the method that composes an 'add' method for the given property.
static CodeBlock	composeConstructorFragment4Environment(CodeBuilder codeBuilder, PropertySpecImpl property)	The default implementation of the method that composes a constructor fragment for the initialisation of the given property in cases it is annotated with @EnvironmentVariable.
static CodeBlock	composeConstructorFragment4SystemPreference(CodeBuilder codeBuilder, PropertySpecImpl property)	The default implementation of the method that composes a constructor fragment for the initialisation of the given property in cases it is annotated with @EnvironmentVariable.
static CodeBlock	composeConstructorFragment4SystemProp(CodeBuilder codeBuilder, PropertySpecImpl property)	The default implementation of the method that composes a constructor fragment for the initialisation of the given property in cases it is annotated with @EnvironmentVariable.
static FieldSpec	composeField(CodeBuilder codeBuilder, PropertySpecImpl property)	The default implementation of the method that composes a field for the given property.
static MethodSpec	composeGetter(CodeBuilder codeBuilder, PropertySpecImpl property)	The default implementation of the method that composes a getter for the given property.
static MethodSpec	composeSetter(CodeBuilder codeBuilder, PropertySpecImpl property)	The default implementation of the method that composes a setter for the given property.
protected static final CodeBuilderBase.StringConverterInstantiation	determineStringConverterInstantiation(TypeName stringConverterClass, boolean isEnum)	Determines how to instantiate the given implementation of StringConverter.
final JavaComposer	getComposer()	Provides access to the composer.
final CodeGenerationConfiguration	getConfiguration()	Provides access to the code builder configuration.
final FieldSpec	getField(CodeBuilder.StandardField reference)	Returns the specification for a standard field.
final MethodSpec	getMethod(CodeBuilder.StandardMethod reference)	Returns the specification for a standard method.
protected final Iterator<PropertySpec>	getProperties()	Returns an iterator over the configured properties.
protected static final Optional<TypeName>	getStringConverter(TypeName type)	Returns the StringConverter type for the given type.
protected final boolean	isSynchronized()	Returns the flag that controls whether the configuration bean has to be generated thread safe.

Methods inherited from class java.lang.Object

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

Field Details

m_ClassBuilder

private final TypeSpec.Builder m_ClassBuilder

The class builder.

m_Composer

private final JavaComposer m_Composer

The composer.

m_Configuration

private final CodeGenerationConfiguration m_Configuration

The configuration for the code generation.

m_ConstructorCode

private final CodeBlock.Builder m_ConstructorCode

The builder for body of the constructor.

m_Context

private final CodeGeneratorContext m_Context

The code generator context.

m_IsSynchronized

private final boolean m_IsSynchronized

The synchronised flag.

m_StandardFields

private static final Map<CodeBuilder.StandardField,FieldSpec> m_StandardFields

The standard fields.

m_StandardMethods

private static final Map<CodeBuilder.StandardMethod,MethodSpec> m_StandardMethods

The standard methods.

m_ConverterRegistry

private static final Map<TypeName,ClassName> m_ConverterRegistry

The registry for the known implementations of StringConverter implementations.

Constructor Details

CodeBuilderBase

protected CodeBuilderBase(CodeGeneratorContext context)

Creates a new instance of CodeBuilderBase.

Parameters:

context - The code generator context.

Method Details

addConstructorArgument

protected final void addConstructorArgument(ParameterSpec argument)

Adds an argument to the constructor.

Parameters:

argument - The parameter to add.

addConstructorCode

protected final void addConstructorCode(CodeBlock code)

Adds code to the constructor body.

Parameters:

code - The code to add.

addConstructorSuppressedWarning

protected final 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.

addField

protected final void addField(FieldSpec field)

Adds the given field to the new class.

Parameters:

field - The field to add.

addField

protected final void addField(CodeBuilder.StandardField reference,
 FieldSpec field)

Adds the given standard field to the new class.

Parameters:

reference - The identifier for the standard field.

field - The field to add.

addMethod

protected final void addMethod(MethodSpec method)

Adds the given method to the new class.

Parameters:

method - The method to add.

addMethod

protected final void addMethod(CodeBuilder.StandardMethod reference,
 MethodSpec method)

Adds the given method to the new class.

Parameters:

reference - The identifier for the standard method.

method - The method to add.

build

public abstract void build()

Generates the relevant code.

Specified by:

build in interface CodeBuilder

composeAddMethod

public static MethodSpec composeAddMethod(CodeBuilder codeBuilder,
 PropertySpecImpl property)

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

Parameters:

codeBuilder - The factory for the code generation.

property - The property.

Returns:

The method specification.

composeConstructorFragment4Environment

public static CodeBlock composeConstructorFragment4Environment(CodeBuilder codeBuilder,
 PropertySpecImpl property)

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

Parameters:

codeBuilder - The factory for the code generation.

property - The property.

Returns:

The field specification.

composeConstructorFragment4SystemPreference

public static CodeBlock composeConstructorFragment4SystemPreference(CodeBuilder codeBuilder,
 PropertySpecImpl property)

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

Parameters:

codeBuilder - The factory for the code generation.

property - The property.

Returns:

The field specification.

composeConstructorFragment4SystemProp

public static CodeBlock composeConstructorFragment4SystemProp(CodeBuilder codeBuilder,
 PropertySpecImpl property)

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

Parameters:

codeBuilder - The factory for the code generation.

property - The property.

Returns:

The field specification.

composeField

public static FieldSpec composeField(CodeBuilder codeBuilder,
 PropertySpecImpl property)

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

Parameters:

codeBuilder - The factory for the code generation.

property - The property.

Returns:

The field specification.

composeGetter

public static MethodSpec composeGetter(CodeBuilder codeBuilder,
 PropertySpecImpl property)

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

Parameters:

codeBuilder - The factory for the code generation.

property - The property.

Returns:

The method specification.

composeSetter

public static MethodSpec composeSetter(CodeBuilder codeBuilder,
 PropertySpecImpl property)

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

Parameters:

codeBuilder - The factory for the code generation.

property - The property.

Returns:

The method specification.

determineStringConverterInstantiation

protected static final CodeBuilderBase.StringConverterInstantiation determineStringConverterInstantiation(TypeName stringConverterClass,
 boolean isEnum)

Determines how to instantiate the given implementation of StringConverter.

Parameters:

stringConverterClass - The String converter class.

isEnum - true if the property is of an enum type, false otherwise.

Returns:

The type of instantiation.

getComposer

public final JavaComposer getComposer()

Provides access to the composer.

Specified by:

getComposer in interface CodeBuilder

Returns:

The composer.

getConfiguration

public final CodeGenerationConfiguration getConfiguration()

Provides access to the code builder configuration.

Specified by:

getConfiguration in interface CodeBuilder

Returns:

The configuration.

getField

public final FieldSpec getField(CodeBuilder.StandardField reference)

Returns the specification for a standard field.

Specified by:

getField in interface CodeBuilder

Parameters:

reference - The identifier for the standard field.

Returns:

The field.

getMethod

public final MethodSpec getMethod(CodeBuilder.StandardMethod reference)

Returns the specification for a standard method.

Specified by:

getMethod in interface CodeBuilder

Parameters:

reference - The identifier for the standard method.

Returns:

The method.

getProperties

protected final Iterator<PropertySpec> getProperties()

Returns an iterator over the configured properties.

Returns:

The iterator.

getStringConverter

protected static final Optional<TypeName> getStringConverter(TypeName type)

Returns the StringConverter type for the given type.

Parameters:

type - The type.

Returns:

An instance of Optional that holds the requested implementation of StringConverter.

isSynchronized

protected final boolean isSynchronized()

Returns the flag that controls whether the configuration bean has to be generated thread safe.

Returns:

true if lock support is required, false otherwise.