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

Class CLIBeanBuilder

java.lang.Object

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

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

All Implemented Interfaces:

CodeBuilder

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

The code builder implementation for the CLI stuff, as defined in CLIBeanSpec.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: CLIBeanBuilder.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.CLIBeanBuilder"

⁠

Nested Class Summary

Nested classes/interfaces inherited from class org.tquadrat.foundation.config.ap.impl.codebuilders.CodeBuilderBase

CodeBuilderBase.StringConverterInstantiation

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 Map<TypeName,ClassName>	m_HandlerClasses	The handler classes.

Constructor Summary

Constructors

Constructor	Description
CLIBeanBuilder(CodeGeneratorContext context)	Creates a new instance of CLIBeanBuilder.

Method Summary

Modifier and Type	Method	Description
final void	build()	Generates the relevant code.
private final String	composeValueHandlerCreation(PropertySpec property)	Composes the code that creates the CLI value handler for the given property.
private final void	createDumpParamFileTemplate()	Creates the implementation for the method CLIBeanSpec.dumpParamFileTemplate(OutputStream).
private final void	createParseCommandLine(FieldSpec registry, FieldSpec errorMsgHolder)	Creates the implementation for the method CLIBeanSpec.parseCommandLine(String[]).
private final void	createPrintUsage(FieldSpec registry)	Creates the implementation for the method CLIBeanSpec.printUsage(OutputStream, CharSequence).
private final void	createRetrieveParseErrorMessage(FieldSpec errorMsgHolder)	Creates the implementation for the method CLIBeanSpec.retrieveParseErrorMessage().
private final void	doBuild()	Is called by build() to do the work – only if there is work to do …
private final Optional<TypeName>	retrieveValueHandlerClass(PropertySpec property)	Retrieves the class for the value handler for the given property.

Methods inherited from class org.tquadrat.foundation.config.ap.impl.codebuilders.CodeBuilderBase

addConstructorArgument, addConstructorCode, addConstructorSuppressedWarning, addField, addField, addMethod, addMethod, composeAddMethod, composeConstructorFragment4Environment, composeConstructorFragment4SystemPreference, composeConstructorFragment4SystemProp, composeField, composeGetter, composeSetter, determineStringConverterInstantiation, getComposer, getConfiguration, getField, getMethod, getProperties, getStringConverter, isSynchronized

Methods inherited from class java.lang.Object

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

Field Details

m_HandlerClasses

private final Map<TypeName,ClassName> m_HandlerClasses

The handler classes.

Constructor Details

CLIBeanBuilder

public CLIBeanBuilder(CodeGeneratorContext context)

Creates a new instance of CLIBeanBuilder.

Parameters:

context - The code generator context.

Method Details

build

public final void build()

Generates the relevant code.

This method checks whether there are any properties that are either options or arguments, and does the build only when there is at least one.

Not building CLI stuff will let crash the compilation of the generated code, but this is intended: either the annotation for the CLI properties is missing, or the interface CLIBeanSpec was added to the configuration bean specification in error.

Specified by:

build in interface CodeBuilder

Specified by:

build in class CodeBuilderBase

composeValueHandlerCreation

private final String composeValueHandlerCreation(PropertySpec property)

Composes the code that creates the CLI value handler for the given property.

Parameters:

property - The property.

Returns:

The name of the method that creates the CLI value handler for this property.

createDumpParamFileTemplate

private final void createDumpParamFileTemplate()

Creates the implementation for the method CLIBeanSpec.dumpParamFileTemplate(OutputStream).

createParseCommandLine

private final void createParseCommandLine(FieldSpec registry,
 FieldSpec errorMsgHolder)

Creates the implementation for the method CLIBeanSpec.parseCommandLine(String[]).

Parameters:

registry - The registry of the properties that are exposed for the CLI.

errorMsgHolder - The field for the parse errors.

createPrintUsage

private final void createPrintUsage(FieldSpec registry)

Creates the implementation for the method CLIBeanSpec.printUsage(OutputStream, CharSequence).

Parameters:

registry - The registry of the properties that are exposed for the CLI.

createRetrieveParseErrorMessage

private final void createRetrieveParseErrorMessage(FieldSpec errorMsgHolder)

Creates the implementation for the method CLIBeanSpec.retrieveParseErrorMessage().

Parameters:

errorMsgHolder - The field for the parse errors.

doBuild

private final void doBuild()

Is called by build() to do the work – only if there is work to do …

retrieveValueHandlerClass

private final Optional<TypeName> retrieveValueHandlerClass(PropertySpec property)

Retrieves the class for the value handler for the given property. If returning Optional.empty() empty}, an instance of SimpleCmdLineValueHandler must be used that will be instantiated with the StringConverter retrieved by a call to PropertySpec.getStringConverterClass().

Parameters:

property - The property.

Returns:

An instance of Optional that holds the respective type name.