Package org.tquadrat.foundation.config.ap

Class ConfigAnnotationProcessor

java.lang.Object

org.tquadrat.foundation.ap.APBase

org.tquadrat.foundation.config.ap.ConfigAnnotationProcessor

All Implemented Interfaces:

Messager, ProcessingEnvironment, Processor, APHelper

@ClassVersion(sourceVersion="$Id: ConfigAnnotationProcessor.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
@SupportedSourceVersion(RELEASE_17)
@SupportedOptions({"org.tquadrat.foundation.ap.addDebugOutput","org.tquadrat.foundation.ap.maven.goal"})
public class ConfigAnnotationProcessor
extends APBase

The annotation processor for the org.tquadrat.foundation.config module.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ap.ConfigAnnotationProcessor"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final TypeName	DEFAULT_ACCESSOR_TYPE	The type name for the class SimplePreferenceAccessor.
static final TypeName	ENUM_ACCESSOR_TYPE	The type name for the class EnumAccessor.
static final TypeName	LIST_ACCESSOR_TYPE	The type name for the class ListAccessor.
private Optional<String>	m_BaseBundleName	The base bundle name.
private Optional<String>	m_MessagePrefix	The message prefix.
private final Map<TypeName,ClassName>	m_PrefsAccessorClasses	The preferences accessor classes.
private final LazyMap<TypeName,ClassName>	m_StringConvertersForTypeNames	A map of StringConverter implementations that use instances of TypeName as keys.
static final TypeName	MAP_ACCESSOR_TYPE	The type name for the class MapAccessor.
static final String	METHODNAME_ConfigBeanSpec_AddListener	The name for ConfigBeanSpec.addListener(org.tquadrat.foundation.config.ConfigurationChangeListener): "addListener".
static final String	METHODNAME_ConfigBeanSpec_GetResourceBundle	The name for ConfigBeanSpec.getResourceBundle(): "getResourceBundle".
static final String	METHODNAME_ConfigBeanSpec_InitData	The name for the optional initData method: "initData".
static final String	METHODNAME_Map_IsEmpty	The name for Map.isEmpty(): "isEmpty".
static final String	MSG_AccessorMissing	The message that indicates that no accessor class is given for the @SystemPreference annotation: "No accessor is given for the @SystemPreference annotation on \'%1$s\'".
static final String	MSG_AddMethodNotAllowed	The message that indicates the erroneous attempt to define an 'add' method for a property that is not a collection.
static final String	MSG_CannotRetrieveMirror	The message that indicates that a mirror cannot be retrieved: "Cannot retrieve Mirror for \'%1$s\'".
static final String	MSG_CLIAnnotationClash	The message that indicates a clash of CLI annotations.
static final String	MSG_CodeGenerationFailed	The message that indicates the failure of the code generation for the configuration bean specification: "Code generation for \'%1$s.%2$s\' failed".
static final String	MSG_DuplicateOptionName	The message that indicates that an option name was used twice: "Option name \'%s\' for property \'%s\' is already used".
static final String	MSG_DuplicateProperty	The message that indicates that a property was specified twice: "Duplicate property: %1$s".
static final String	MSG_GetterMustBeDEFAULT	The message that indicates a missing default getter for the message prefix: "The getter for the message prefix must be defined as default".
static final String	MSG_IllegalAnnotationOnAddMethod	The message that indicates that an illegal annotation had been applied to an 'add' method: "Invalid annotation \'%1$s\' on \'add\' method \'%2$s\'".
static final String	MSG_IllegalAnnotationOnGetter	The message that indicates that an illegal annotation had been applied to a getter: "Invalid annotation \'%1$s\' on getter \'%2$s\'".
static final String	MSG_IllegalAnnotationOnSetter	The message that indicates that an illegal annotation had been applied to a setter: "Illegal annotation \'%1$s\' on setter \'%2$s\'".
static final String	MSG_IllegalImplementation	The message that indicates that an invalid implementation for an interface was used: "Illegal implementation for \'%1$s\': %2$s".
static final String	MSG_IllegalMutator	The message that indicates that a mutator was provided for an immutable property: "No mutator allowed for property \'%1$s\'".
static final String	MSG_INIGroupMissing	The message that indicates that the attribute INIValue.group() was not properly populated: "The group for @INIValue on \'%s\' is missing".
static final String	MSG_INIKeyMissing	The message that indicates that the attribute INIValue.key() was not properly populated: "The key for @INIValue on \'%s\' is missing".
static final String	MSG_INIPathMissing	The message that indicates that the attribute INIFileConfig.path() was not properly populated: "The path for @INIFileConfig is not set properly".
static final String	MSG_InterfacesOnly	The message that indicates that an annotation is valid only for interfaces: "Only allowed for interfaces".
static final String	MSG_InvalidCLIType	The message that indicates that a CLI property is invalid: "Property \'%s\' is neither argument nor option".
static final String	MSG_MissingEnvironmentVar	The message that indicates a missing environment variable name for a property: "The name of the environment variable is missing for property \'%1$s\'".
static final String	MSG_MissingGetter	The message that indicates a missing getter for a property: "A getter method for the property \'%1$s\' is missing".
static final String	MSG_MissingInterface	The message that indicates that the configuration bean specification does not extend ConfigBeanSpec: "The configuration bean specification \'%1$s\' does not extend \'%2$s\'".
static final String	MSG_MissingPropertyDefinition	The message that indicates a missing definition for a property: "There is neither a getter nor a setter method for the property \'%1$s\', first introduced by the \'add\' method \'%2$s\'".
static final String	MSG_MissingStringConverter	The message that indicates a missing StringConverter for a property: "There is no StringConverter for the property \'%1$s\'".
static final String	MSG_MissingStringConverterWithType	The message that indicates a missing StringConverter for a property: "There is no StringConverter for the property \'%1$s\' than converts \'%2$s\'".
static final String	MSG_MissingSystemProp	The message that indicates a missing system property name for a property: "The name of the system property is missing for property \'%1$s\'".
static final String	MSG_NoArgumentIndex	The message that indicates a missing argument index for a CLI argument property: "No argument index for property \'%s\'".
static final String	MSG_NoBaseBundleName	The message that indicates a missing base bundle name configuration: "There is no public static field providing the base bundle name".
static final String	MSG_NoCollection	The message that indicates that an 'add' method was provided for a non-collection property.
static final String	MSG_NoMessagePrefix	The message that indicates a missing message prefix field: "There is no public static field providing the message prefix".
static final String	MSG_NoOptionName	The message that indicates a missing property name for a CLI option property: "No option name for property \'%s\'".
static final String	MSG_NoSetter	The message that indicates that a given method is not a setter: "The method \'%1$s\' is neither a setter nor an add method".
static final String	MSG_NoType	The message that indicates a missing property type.
static final String	MSG_NoValueForMirror	The message that indicates that a value cannot be retrieved from a mirror: "Cannot get value for \'%2$s\' from Annotation Mirror for \'%1$s\'".
static final String	MSG_PreferenceAnnotationClash	The message that indicates a clash of preference annotations: "Annotations @Preference and @NoPreference are mutually exclusive".
static final String	MSG_PreferencesNotConfigured	The message that indicates invalid "preferences" configuration for a property: "The \'preferences\' configuration for \'%1$s\' is invalid".
static final String	MSG_PrefsKeyMissing	The message that indicates that no Preferences key is given for the @SystemPreference annotation: "No key is given for the @SystemPreference annotation on \'%1$s\'".
static final String	MSG_ResourceBundleWrongReturnType	The message that indicates a wrong return type for ConfigBeanSpec.getResourceBundle(): "The return type of getResourceBundle() must be Optional(ResourceBundle)".
static final String	MSG_SessionPropertyMissing	The message that indicates that the session property was not defined: "Session property was not defined".
static final String	MSG_SpecialPropertyMismatch	The message that indicates a mismatch of the values for the @SpecialProperty annotation: "%1$s annotation value for \'%2$s\' is \'%3$s\', but \'%4$s\' was expected".
static final String	MSG_StringConverterMismatch	The message that indicates that the StringConverter inferred from the setter does not match with that from the getter.
static final String	MSG_StringConverterNotCompatible	The message that indicates that the StringConverter is invalid for the property type.
static final String	MSG_TypeMismatch	The message that indicates a mismatch of the types for the setter argument and the property itself: "Parameter type \'%1$s\' of setter \'%2$s\' does not match with property type \'%3$s\'".
static final TypeName	PREFS_ACCESSOR_TYPE	The type name for the class PreferenceAccessor.
static final TypeName	SET_ACCESSOR_TYPE	The type name for the class SetAccessor.

Fields inherited from class org.tquadrat.foundation.ap.APBase

ADD_DEBUG_OUTPUT, MAVEN_GOAL, MSG_AnnotationOnlyForFields, MSG_FieldsOnly, MSG_IllegalAnnotationUse, MSG_MultipleElements, MSG_MultipleFields, MSG_StringConstantRequired, PACKAGE_NAME

Constructor Summary

Constructors

Constructor	Description
ConfigAnnotationProcessor()	Creates a new ConfigAnnotationProcessor instance.

Method Summary

Modifier and Type	Method	Description
private final void	checkAppropriate(TypeMirror typeName)	Checks whether the given type is inappropriate for a configuration bean property and therefore deserves that an InappropriateTypeError is thrown.
private static final String	composeFieldName(String propertyName)	Composes the name of the field from the given property name.
static final Map<TypeName,ClassName>	createStringConverterRegistry()	Creates a registry of the known StringConverter implementations.
private final CollectionKind	determineCollectionKind(TypeMirror type)	Determines whether the given type is a collection of some type and returns the respective kind.
private final Optional<TypeMirror>	determineElementType(TypeMirror type)	Determines the element type from the given TypeMirror instance representing a collection.
private final String	determinePropertyNameFromMethod(ExecutableElement method)	Retrieves the name of the property from the name of the given executable element for a method that is either a getter, a setter or an 'add' method.
private final TypeMirror	determinePropertyType(TypeMirror type)	Determines the property type from the given TypeMirror instance.
private final Optional<ClassName>	determineStringConverterClass(ExecutableElement method, TypeName type, boolean isEnum)	Determines the implementation of StringConverter that can translate a String into an instance of the given type and vice-versa.
final Optional<ClassName>	extractStringConverterClass(ExecutableElement method)	Retrieves the value for the @StringConversion annotation from the given method.
protected final Collection<Class<? extends Annotation>>	getSupportedAnnotationClasses()
private final void	handleAddMethod(CodeGenerationConfiguration configuration, ExecutableElement addMethod)	Processes the given ExecutableElement instance for an 'add' method.
private final void	handleGetter(CodeGenerationConfiguration configuration, ExecutableElement getter)	Processes the given ExecutableElement instance for a getter method.
private final void	handleSetter(CodeGenerationConfiguration configuration, ExecutableElement setter)	Processes the given ExecutableElement instance for a setter method.
private final Map<TypeName,ClassName>	initStringConvertersForTypeNames()	Initialises the internal attribute m_StringConvertersForTypeNames.
private final void	parseArgumentAnnotation(Argument annotation, ExecutableElement method, PropertySpecImpl property)	Parses the given annotation and updates the given property accordingly.
private final void	parseCLIAnnotation(Annotation annotation, ExecutableElement method, PropertySpecImpl property)	Parses the given CLI annotation and updates the given property accordingly.
private final void	parseEnvironmentVariableAnnotation(EnvironmentVariable annotation, PropertySpecImpl property)	Parses the given annotation and updates the given property accordingly.
private final void	parseOptionAnnotation(Option annotation, ExecutableElement method, PropertySpecImpl property)	Parses the given annotation and updates the given property accordingly.
private final void	parseSystemPropertyAnnotation(SystemProperty annotation, PropertySpecImpl property)	Parses the given annotation and updates the given property accordingly.
final boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnvironment)
private final void	processConfigurationBeanSpecification(TypeElement specification)	Processes the given configuration bean specification and generates the source for the so specified configuration bean.
private final TypeName	retrieveAccessorClass(TypeName accessorType, TypeMirror propertyType, CollectionKind collectionKind)	Retrieves the class for the preference accessor.
private final void	retrieveInitDataMethod(CodeGenerationConfiguration configuration, TypeElement specification)	This methods checks whether the configuration bean specification specifies an initData() method.
private final void	retrieveProperties(CodeGenerationConfiguration configuration, Collection<? extends TypeElement> interfaces)	Scans the configuration bean specification for the properties and stores the result to the configuration.
private final Name	retrieveSetterArgumentName(ExecutableElement setter)	Retrieves the name of the single argument of a setter method.
private static final Collection<Class<?>>	retrieveSubjectClasses(StringConverter<?> converter)	Determines the key class for the given instance of StringConverter.

Methods inherited from class org.tquadrat.foundation.ap.APBase

addDebugOutput, getCompletions, getElementUtils, getFiler, getLocale, getMessager, getOption, getOptions, getSourceVersion, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, getTypeUtils, init, isEnumType, printMessage, printMessage, printMessage, printMessage, retrieveAnnotatedField, retrieveArgumentNames, retrieveGenericTypes, retrieveInterfaces

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.ap.APHelper

getAnnotationMirror, getAnnotationValue, getAnnotationValue, getTypeMirrorFromAnnotationValue, getTypeMirrorFromAnnotationValue, hasAnnotation

Methods inherited from interface javax.annotation.processing.Messager

printError, printError, printNote, printNote, printWarning, printWarning

Methods inherited from interface javax.annotation.processing.ProcessingEnvironment

isPreviewEnabled

Field Details

METHODNAME_ConfigBeanSpec_AddListener

public static final String METHODNAME_ConfigBeanSpec_AddListener

The name for ConfigBeanSpec.addListener(org.tquadrat.foundation.config.ConfigurationChangeListener): "addListener".

See Also:

• Constant Field Values

METHODNAME_ConfigBeanSpec_GetResourceBundle

public static final String METHODNAME_ConfigBeanSpec_GetResourceBundle

The name for ConfigBeanSpec.getResourceBundle(): "getResourceBundle".

See Also:

• Constant Field Values

METHODNAME_ConfigBeanSpec_InitData

public static final String METHODNAME_ConfigBeanSpec_InitData

The name for the optional initData method: "initData".

See Also:

• Constant Field Values

METHODNAME_Map_IsEmpty

public static final String METHODNAME_Map_IsEmpty

The name for Map.isEmpty(): "isEmpty".

See Also:

• Constant Field Values

MSG_AccessorMissing

public static final String MSG_AccessorMissing

The message that indicates that no accessor class is given for the @SystemPreference annotation: "No accessor is given for the @SystemPreference annotation on \'%1$s\'".

See Also:

• Constant Field Values

MSG_AddMethodNotAllowed

public static final String MSG_AddMethodNotAllowed

The message that indicates the erroneous attempt to define an 'add' method for a property that is not a collection.

See Also:

• Constant Field Values

MSG_CannotRetrieveMirror

public static final String MSG_CannotRetrieveMirror

The message that indicates that a mirror cannot be retrieved: "Cannot retrieve Mirror for \'%1$s\'".

See Also:

• Constant Field Values

MSG_CLIAnnotationClash

public static final String MSG_CLIAnnotationClash

The message that indicates a clash of CLI annotations.

See Also:

• Constant Field Values

MSG_CodeGenerationFailed

public static final String MSG_CodeGenerationFailed

The message that indicates the failure of the code generation for the configuration bean specification: "Code generation for \'%1$s.%2$s\' failed".

See Also:

• Constant Field Values

MSG_DuplicateProperty

public static final String MSG_DuplicateProperty

The message that indicates that a property was specified twice: "Duplicate property: %1$s".

See Also:

• Constant Field Values

MSG_DuplicateOptionName

public static final String MSG_DuplicateOptionName

The message that indicates that an option name was used twice: "Option name \'%s\' for property \'%s\' is already used".

See Also:

• Constant Field Values

MSG_GetterMustBeDEFAULT

public static final String MSG_GetterMustBeDEFAULT

The message that indicates a missing default getter for the message prefix: "The getter for the message prefix must be defined as default".

See Also:

• Constant Field Values

MSG_IllegalAnnotationOnAddMethod

public static final String MSG_IllegalAnnotationOnAddMethod

The message that indicates that an illegal annotation had been applied to an 'add' method: "Invalid annotation \'%1$s\' on \'add\' method \'%2$s\'".

See Also:

• Constant Field Values

MSG_IllegalAnnotationOnGetter

public static final String MSG_IllegalAnnotationOnGetter

The message that indicates that an illegal annotation had been applied to a getter: "Invalid annotation \'%1$s\' on getter \'%2$s\'".

See Also:

• Constant Field Values

MSG_IllegalAnnotationOnSetter

public static final String MSG_IllegalAnnotationOnSetter

The message that indicates that an illegal annotation had been applied to a setter: "Illegal annotation \'%1$s\' on setter \'%2$s\'".

See Also:

• Constant Field Values

MSG_IllegalImplementation

public static final String MSG_IllegalImplementation

The message that indicates that an invalid implementation for an interface was used: "Illegal implementation for \'%1$s\': %2$s".

See Also:

• Constant Field Values

MSG_IllegalMutator

public static final String MSG_IllegalMutator

The message that indicates that a mutator was provided for an immutable property: "No mutator allowed for property \'%1$s\'".

See Also:

• Constant Field Values

MSG_INIGroupMissing

public static final String MSG_INIGroupMissing

The message that indicates that the attribute INIValue.group() was not properly populated: "The group for @INIValue on \'%s\' is missing".

See Also:

• Constant Field Values

MSG_INIKeyMissing

public static final String MSG_INIKeyMissing

The message that indicates that the attribute INIValue.key() was not properly populated: "The key for @INIValue on \'%s\' is missing".

See Also:

• Constant Field Values

MSG_INIPathMissing

public static final String MSG_INIPathMissing

The message that indicates that the attribute INIFileConfig.path() was not properly populated: "The path for @INIFileConfig is not set properly".

See Also:

• Constant Field Values

MSG_InterfacesOnly

public static final String MSG_InterfacesOnly

The message that indicates that an annotation is valid only for interfaces: "Only allowed for interfaces".

See Also:

• Constant Field Values

MSG_InvalidCLIType

public static final String MSG_InvalidCLIType

The message that indicates that a CLI property is invalid: "Property \'%s\' is neither argument nor option".

See Also:

• Constant Field Values

MSG_MissingEnvironmentVar

public static final String MSG_MissingEnvironmentVar

The message that indicates a missing environment variable name for a property: "The name of the environment variable is missing for property \'%1$s\'".

See Also:

• Constant Field Values

MSG_MissingGetter

public static final String MSG_MissingGetter

The message that indicates a missing getter for a property: "A getter method for the property \'%1$s\' is missing".

See Also:

• Constant Field Values

MSG_MissingInterface

public static final String MSG_MissingInterface

The message that indicates that the configuration bean specification does not extend ConfigBeanSpec: "The configuration bean specification \'%1$s\' does not extend \'%2$s\'".

See Also:

• Constant Field Values

MSG_MissingPropertyDefinition

public static final String MSG_MissingPropertyDefinition

The message that indicates a missing definition for a property: "There is neither a getter nor a setter method for the property \'%1$s\', first introduced by the \'add\' method \'%2$s\'".

See Also:

• Constant Field Values

MSG_MissingStringConverter

public static final String MSG_MissingStringConverter

The message that indicates a missing StringConverter for a property: "There is no StringConverter for the property \'%1$s\'".

See Also:

• Constant Field Values

MSG_MissingStringConverterWithType

public static final String MSG_MissingStringConverterWithType

The message that indicates a missing StringConverter for a property: "There is no StringConverter for the property \'%1$s\' than converts \'%2$s\'".

See Also:

• Constant Field Values

MSG_MissingSystemProp

public static final String MSG_MissingSystemProp

The message that indicates a missing system property name for a property: "The name of the system property is missing for property \'%1$s\'".

See Also:

• Constant Field Values

MSG_NoArgumentIndex

public static final String MSG_NoArgumentIndex

The message that indicates a missing argument index for a CLI argument property: "No argument index for property \'%s\'".

See Also:

• Constant Field Values

MSG_NoBaseBundleName

public static final String MSG_NoBaseBundleName

The message that indicates a missing base bundle name configuration: "There is no public static field providing the base bundle name".

See Also:

• Constant Field Values

MSG_NoCollection

public static final String MSG_NoCollection

The message that indicates that an 'add' method was provided for a non-collection property.

See Also:

• Constant Field Values

MSG_NoMessagePrefix

public static final String MSG_NoMessagePrefix

The message that indicates a missing message prefix field: "There is no public static field providing the message prefix".

See Also:

• Constant Field Values

MSG_NoOptionName

public static final String MSG_NoOptionName

The message that indicates a missing property name for a CLI option property: "No option name for property \'%s\'".

See Also:

• Constant Field Values

MSG_NoSetter

public static final String MSG_NoSetter

The message that indicates that a given method is not a setter: "The method \'%1$s\' is neither a setter nor an add method".

See Also:

• Constant Field Values

MSG_NoType

public static final String MSG_NoType

The message that indicates a missing property type.

See Also:

• Constant Field Values

MSG_NoValueForMirror

public static final String MSG_NoValueForMirror

The message that indicates that a value cannot be retrieved from a mirror: "Cannot get value for \'%2$s\' from Annotation Mirror for \'%1$s\'".

See Also:

• Constant Field Values

MSG_PreferenceAnnotationClash

public static final String MSG_PreferenceAnnotationClash

The message that indicates a clash of preference annotations: "Annotations @Preference and @NoPreference are mutually exclusive".

See Also:

• Constant Field Values

MSG_PreferencesNotConfigured

public static final String MSG_PreferencesNotConfigured

The message that indicates invalid "preferences" configuration for a property: "The \'preferences\' configuration for \'%1$s\' is invalid".

See Also:

• Constant Field Values

MSG_PrefsKeyMissing

public static final String MSG_PrefsKeyMissing

The message that indicates that no Preferences key is given for the @SystemPreference annotation: "No key is given for the @SystemPreference annotation on \'%1$s\'".

See Also:

• Constant Field Values

MSG_ResourceBundleWrongReturnType

public static final String MSG_ResourceBundleWrongReturnType

The message that indicates a wrong return type for ConfigBeanSpec.getResourceBundle(): "The return type of getResourceBundle() must be Optional(ResourceBundle)".

See Also:

• Constant Field Values

MSG_SessionPropertyMissing

public static final String MSG_SessionPropertyMissing

The message that indicates that the session property was not defined: "Session property was not defined".

See Also:

• SessionBeanSpec.getSessionKey()
• SpecialPropertyType.CONFIG_PROPERTY_SESSION
• Constant Field Values

MSG_SpecialPropertyMismatch

public static final String MSG_SpecialPropertyMismatch

The message that indicates a mismatch of the values for the @SpecialProperty annotation: "%1$s annotation value for \'%2$s\' is \'%3$s\', but \'%4$s\' was expected".

See Also:

• Constant Field Values

MSG_StringConverterMismatch

public static final String MSG_StringConverterMismatch

The message that indicates that the StringConverter inferred from the setter does not match with that from the getter.

See Also:

• Constant Field Values

MSG_StringConverterNotCompatible

public static final String MSG_StringConverterNotCompatible

The message that indicates that the StringConverter is invalid for the property type.

See Also:

• Constant Field Values

MSG_TypeMismatch

public static final String MSG_TypeMismatch

The message that indicates a mismatch of the types for the setter argument and the property itself: "Parameter type \'%1$s\' of setter \'%2$s\' does not match with property type \'%3$s\'".

See Also:

• Constant Field Values

m_BaseBundleName

private Optional<String> m_BaseBundleName

The base bundle name. The value will be set in process(Set, RoundEnvironment) from a String constant that is annotated with the annotation @BaseBundleName.

m_MessagePrefix

private Optional<String> m_MessagePrefix

The message prefix. The value will be set in process(Set, RoundEnvironment) from a String constant that is annotated with the annotation @MessagePrefix.

m_PrefsAccessorClasses

@API(status=INTERNAL,
     since="0.1.0")
private final Map<TypeName,ClassName> m_PrefsAccessorClasses

The preferences accessor classes.

m_StringConvertersForTypeNames

private final LazyMap<TypeName,ClassName> m_StringConvertersForTypeNames

A map of StringConverter implementations that use instances of TypeName as keys.

DEFAULT_ACCESSOR_TYPE

@API(status=INTERNAL,
     since="0.1.0")
public static final TypeName DEFAULT_ACCESSOR_TYPE

The type name for the class SimplePreferenceAccessor.

ENUM_ACCESSOR_TYPE

@API(status=INTERNAL,
     since="0.0.1")
public static final TypeName ENUM_ACCESSOR_TYPE

The type name for the class EnumAccessor.

LIST_ACCESSOR_TYPE

@API(status=INTERNAL,
     since="0.1.0")
public static final TypeName LIST_ACCESSOR_TYPE

The type name for the class ListAccessor.

MAP_ACCESSOR_TYPE

@API(status=INTERNAL,
     since="0.1.0")
public static final TypeName MAP_ACCESSOR_TYPE

The type name for the class MapAccessor.

PREFS_ACCESSOR_TYPE

@API(status=INTERNAL,
     since="0.0.1")
public static final TypeName PREFS_ACCESSOR_TYPE

The type name for the class PreferenceAccessor.

SET_ACCESSOR_TYPE

@API(status=INTERNAL,
     since="0.1.0")
public static final TypeName SET_ACCESSOR_TYPE

The type name for the class SetAccessor.

Constructor Details

ConfigAnnotationProcessor

public ConfigAnnotationProcessor()

Creates a new ConfigAnnotationProcessor instance.

Method Details

checkAppropriate

private final void checkAppropriate(TypeMirror typeName)
                             throws InappropriateTypeError

Checks whether the given type is inappropriate for a configuration bean property and therefore deserves that an InappropriateTypeError is thrown.

Parameters:

typeName - The type to check.

Throws:

InappropriateTypeError - The given type may not be chosen for a configuration bean property.

See Also:

• InputStream
• Stream
• DoubleStream
• IntStream
• LongStream

composeFieldName

private static final String composeFieldName(String propertyName)

Composes the name of the field from the given property name.

Parameters:

propertyName - The name of the property.

Returns:

The name of the field.

createStringConverterRegistry

@API(status=INTERNAL,
     since="0.1.0")
public static final Map<TypeName,ClassName> createStringConverterRegistry()
                                                                   throws IOException

Creates a registry of the known StringConverter implementations.

The TypeName of the subject class is the key for that map, the TypeName for the Class implementing the StringConverter is the value.

Returns:

An immutable map of StringConverter implementations.

Throws:

IOException - Failed to read the resource files with the StringConverter implementations.

determineCollectionKind

private final CollectionKind determineCollectionKind(TypeMirror type)

Determines whether the given type is a collection of some type and returns the respective kind.

Parameters:

type - The type to check.

Returns:

The collection kind.

determineElementType

private final Optional<TypeMirror> determineElementType(TypeMirror type)

Determines the element type from the given TypeMirror instance representing a collection.

Parameters:

type - The type.

Returns:

An instance of Optional that holds the element type.

determinePropertyNameFromMethod

private final String determinePropertyNameFromMethod(ExecutableElement method)

Retrieves the name of the property from the name of the given executable element for a method that is either a getter, a setter or an 'add' method.

Alternatively the method has an annotation that provides the name of the property.

Parameters:

method - The method.

Returns:

The name of the property.

See Also:

• PropertyName
• SpecialProperty
• SpecialPropertyType

determinePropertyType

private final TypeMirror determinePropertyType(TypeMirror type)

Determines the property type from the given TypeMirror instance. This is either the return type of a getter or the argument type of a setter.

Usually the property type will be the respective TypeMirror for the given type as is, only in case of Optional, it will be the parameter type.

Parameters:

type - The type.

Returns:

The property type.

determineStringConverterClass

private final Optional<ClassName> determineStringConverterClass(ExecutableElement method,
 TypeName type,
 boolean isEnum)

Determines the implementation of StringConverter that can translate a String into an instance of the given type and vice-versa.

Parameters:

method - The annotated method; it is only used to get the instance of @StringConversion from it.

type - The target type.

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

Returns:

An instance of Optional that holds the determined class.

extractStringConverterClass

public final Optional<ClassName> extractStringConverterClass(ExecutableElement method)

Retrieves the value for the @StringConversion annotation from the given method.

The type for the annotation value is an instance of Class<? extends StringConverter>, so it cannot be retrieved directly. Therefore this method will return the TypeName for the StringConverter implementation class.

Parameters:

method - The annotated method.

Returns:

An instance of Optional holding the type name that represents the annotation value "stringConverter".

getSupportedAnnotationClasses

protected final Collection<Class<? extends Annotation>> getSupportedAnnotationClasses()

Specified by:

getSupportedAnnotationClasses in class APBase

handleAddMethod

private final void handleAddMethod(CodeGenerationConfiguration configuration,
 ExecutableElement addMethod)

Processes the given ExecutableElement instance for an 'add' method.

Parameters:

configuration - The code generation configuration.

addMethod - The 'add' method.

handleGetter

private final void handleGetter(CodeGenerationConfiguration configuration,
 ExecutableElement getter)

Processes the given ExecutableElement instance for a getter method.

Parameters:

configuration - The code generation configuration.

getter - The getter method.

handleSetter

private final void handleSetter(CodeGenerationConfiguration configuration,
 ExecutableElement setter)

Processes the given ExecutableElement instance for a setter method.

Parameters:

configuration - The code generation configuration.

setter - The setter method.

initStringConvertersForTypeNames

@API(status=INTERNAL,
     since="0.1.0")
private final Map<TypeName,ClassName> initStringConvertersForTypeNames()

Initialises the internal attribute m_StringConvertersForTypeNames.

Returns:

The map of StringConverter implementations.

parseArgumentAnnotation

private final void parseArgumentAnnotation(Argument annotation,
 ExecutableElement method,
 PropertySpecImpl property)

Parses the given annotation and updates the given property accordingly.

Parameters:

annotation - The annotation.

method - The annotated method.

property - The property.

parseCLIAnnotation

private final void parseCLIAnnotation(Annotation annotation,
 ExecutableElement method,
 PropertySpecImpl property)

Parses the given CLI annotation and updates the given property accordingly.

annotation may be only of type Argument or Option, although this is not explicitly checked (the method is private!).

Usually, the method is only called by the methods parseArgumentAnnotation(Argument, ExecutableElement, PropertySpecImpl) and parseOptionAnnotation(Option, ExecutableElement, PropertySpecImpl), with the proper arguments.

Parameters:

annotation - The annotation.

method - The annotated method.

property - The property.

parseEnvironmentVariableAnnotation

private final void parseEnvironmentVariableAnnotation(EnvironmentVariable annotation,
 PropertySpecImpl property)

Parses the given annotation and updates the given property accordingly.

Parameters:

annotation - The annotation.

property - The property.

parseOptionAnnotation

private final void parseOptionAnnotation(Option annotation,
 ExecutableElement method,
 PropertySpecImpl property)

Parses the given annotation and updates the given property accordingly.

Parameters:

annotation - The annotation.

method - The annotated method.

property - The property.

parseSystemPropertyAnnotation

private final void parseSystemPropertyAnnotation(SystemProperty annotation,
 PropertySpecImpl property)

Parses the given annotation and updates the given property accordingly.

Parameters:

annotation - The annotation.

property - The property.

process

public final boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnvironment)

Specified by:

process in interface Processor

Specified by:

process in class APBase

processConfigurationBeanSpecification

private final void processConfigurationBeanSpecification(TypeElement specification)
                                                  throws IOException

Processes the given configuration bean specification and generates the source for the so specified configuration bean.

Parameters:

specification - The specification interface.

Throws:

IOException - A problem occurred when writing the source file.

retrieveAccessorClass

@API(status=INTERNAL,
     since="0.0.1")
private final TypeName retrieveAccessorClass(TypeName accessorType,
 TypeMirror propertyType,
 CollectionKind collectionKind)
                                      throws IllegalAnnotationError

Retrieves the class for the preference accessor.

Parameters:

accessorType - The accessor class as defined in the annotation; if this is PreferenceAccessor.class, the effective handler class has to inferred from the propertyType.

propertyType - The type of the property that should be accessed.

collectionKind - The kind of collection that is represented by the property type.

Returns:

The effective accessor class.

Throws:

IllegalAnnotationError - There is no accessor for the given property type.

retrieveInitDataMethod

private final void retrieveInitDataMethod(CodeGenerationConfiguration configuration,
 TypeElement specification)

This methods checks whether the configuration bean specification specifies an initData() method. This method has to meet the requirements below:

• the name has to be "initData"
• it does not take any arguments
• it returns an instance of Map<String,Object>
• it is either static or default or implemented in a base class, although this is not checked here

Is such a method exists, a MethodSpec for it will be created and added to the configuration.

Note:

• If a base class for the new configuration bean is defined, the method may be abstract, but if that base class does not implement the method it will be detected only by the final compiler run, not by the code generation here.

Parameters:

configuration - The configuration for the code generation.

specification - The configuration bean specification interface.

retrieveProperties

private final void retrieveProperties(CodeGenerationConfiguration configuration,
 Collection<? extends TypeElement> interfaces)

Scans the configuration bean specification for the properties and stores the result to the configuration.

A property is defined primarily by the respective getter method with its annotations, but it is also possible to define it by a setter method only – especially when the configuration bean specification extends the interface Map.

Parameters:

configuration - The code generation configuration.

interfaces - The interfaces that have to implemented by the new configuration bean.

retrieveSetterArgumentName

private final Name retrieveSetterArgumentName(ExecutableElement setter)

Retrieves the name of the single argument of a setter method.

This method will return the name of the argument as defined in the configuration bean specification if the compiler flag -parameters is set; otherwise, the arguments are just counted (arg0, arg1, arg2, …).

Parameters:

setter - The setter method.

Returns:

The name of the argument as defined in the configuration bean specification, or "arg0"

retrieveSubjectClasses

private static final Collection<Class<?>> retrieveSubjectClasses(StringConverter<?> converter)

Determines the key class for the given instance of StringConverter.

Note:

• This method was copied from org.tquadrat.foundation.base/org.tquadrat.foundation.lang.internal.StringConverterService.

Parameters:

converter - The converter instance.

Returns:

The subject class.