Package org.tquadrat.foundation.i18n.ap

Class I18nAnnotationProcessor

java.lang.Object

org.tquadrat.foundation.ap.APBase

org.tquadrat.foundation.i18n.ap.I18nAnnotationProcessor

All Implemented Interfaces:

Messager, ProcessingEnvironment, Processor, APHelper

@ClassVersion(sourceVersion="$Id: I18nAnnotationProcessor.java 1062 2023-09-25 23:11:41Z tquadrat $")
@API(status=STABLE,
     since="0.0.1")
@SupportedSourceVersion(RELEASE_17)
@SupportedOptions({"org.tquadrat.foundation.ap.addDebugOutput","org.tquadrat.foundation.ap.maven.goal","org.tquadrat.foundation.i18n.ap.textLocation"})
public class I18nAnnotationProcessor
extends APBase

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

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: I18nAnnotationProcessor.java 1062 2023-09-25 23:11:41Z tquadrat $

Since:

0.0.1

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.i18n.ap.I18nAnnotationProcessor"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private String	m_BaseBundleName	The base bundle name.
private Locale	m_DefaultLanguage	The default language.
private String	m_MessagePrefix	The message prefix.

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
I18nAnnotationProcessor()	Creates a new I18NAnnotationProcessor instance.

Method Summary

Modifier and Type	Method	Description
private final void	generateResourceBundle(Optional<String> textFileLocation, Map<Locale,SortedMap<String,TextEntry>> texts, Element... elements)	Generates the resource bundles from the given texts.
protected final Collection<Class<? extends Annotation>>	getSupportedAnnotationClasses()
private final void	parseTextsFile(Map<Locale,SortedMap<String,TextEntry>> texts, InputSource inputSource)	Parses a texts XML file.
final boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnvironment)
private final Optional<InputSource>	searchAdditionalTextsOnConfiguredLocation()	Searches the file with the additional texts ("AdditionalTexts.xml") on the location configured with the annotation processor option "org.tquadrat.foundation.i18n.ap.textLocation".
private final Optional<InputSource>	searchAdditionalTextsOnProvidedLocation(String location)	Searches the file with the additional texts ("AdditionalTexts.xml") on the location provided by the annotation @UseAdditionalTexts.
private final Optional<InputSource>	searchAdditionalTextsOnSourceTree(Filer filer)	Searches the file with the additional texts ("AdditionalTexts.xml") on the location determined by StandardLocation.SOURCE_PATH.
private final void	writeResourceBundleFile(Collection<TextEntry> data, Writer writer)	Write the resource bundle properties to the given Writer.

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

m_BaseBundleName

private String m_BaseBundleName

The base bundle name.

m_DefaultLanguage

private Locale m_DefaultLanguage

The default language.

m_MessagePrefix

private String m_MessagePrefix

The message prefix.

Constructor Details

I18nAnnotationProcessor

public I18nAnnotationProcessor()

Creates a new I18NAnnotationProcessor instance.

Method Details

generateResourceBundle

private final void generateResourceBundle(Optional<String> textFileLocation,
 Map<Locale,SortedMap<String,TextEntry>> texts,
 Element... elements)

Generates the resource bundles from the given texts.

Parameters:

textFileLocation - The provided location for "AdditionalTexts.xml".

texts - The texts.

elements - The annotated elements.

getSupportedAnnotationClasses

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

Specified by:

getSupportedAnnotationClasses in class APBase

parseTextsFile

private final void parseTextsFile(Map<Locale,SortedMap<String,TextEntry>> texts,
 InputSource inputSource)
                           throws IOException,
ParserConfigurationException,
SAXException

Parses a texts XML file.

Parameters:

texts - The data structure that takes the parsed texts.

inputSource - The XML input stream.

Throws:

IOException - Reading the input failed.

ParserConfigurationException - It was not possible to obtain a SAXParserFactory or it could not be configured properly.

SAXException - Parsing the input file failed.

process

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

Specified by:

process in interface Processor

Specified by:

process in class APBase

searchAdditionalTextsOnConfiguredLocation

private final Optional<InputSource> searchAdditionalTextsOnConfiguredLocation()

Searches the file with the additional texts ("AdditionalTexts.xml") on the location configured with the annotation processor option "org.tquadrat.foundation.i18n.ap.textLocation".

Returns:

An instance of Optional that holds the InputSource for the file.

searchAdditionalTextsOnProvidedLocation

private final Optional<InputSource> searchAdditionalTextsOnProvidedLocation(String location)

Searches the file with the additional texts ("AdditionalTexts.xml") on the location provided by the annotation @UseAdditionalTexts.

Parameters:

location - The location for the file with the additional texts.

Returns:

An instance of Optional that holds the InputSource for the file.

searchAdditionalTextsOnSourceTree

private final Optional<InputSource> searchAdditionalTextsOnSourceTree(Filer filer)

Searches the file with the additional texts ("AdditionalTexts.xml") on the location determined by StandardLocation.SOURCE_PATH.

Parameters:

filer - The Filer instance that provides the SOURCE_PATH location.

Returns:

An instance of Optional that holds the InputSource for the file.

writeResourceBundleFile

private final void writeResourceBundleFile(Collection<TextEntry> data,
 Writer writer)
                                    throws IOException

Write the resource bundle properties to the given Writer.

Parameters:

data - The properties.

writer - The target Writer instance.

Throws:

IOException - Writing the resource bundle file failed.