Package org.tquadrat.foundation.i18n.ap

Class TextCollector

java.lang.Object

javax.lang.model.util.AbstractElementVisitor6<Void,Map<Locale,SortedMap<String,TextEntry>>>

javax.lang.model.util.SimpleElementVisitor6<Void,Map<Locale,SortedMap<String,TextEntry>>>

javax.lang.model.util.SimpleElementVisitor7<Void,Map<Locale,SortedMap<String,TextEntry>>>

javax.lang.model.util.SimpleElementVisitor8<Void,Map<Locale,SortedMap<String,TextEntry>>>

javax.lang.model.util.SimpleElementVisitor9<Void,Map<Locale,SortedMap<String,TextEntry>>>

org.tquadrat.foundation.i18n.ap.TextCollector

All Implemented Interfaces:

ElementVisitor<Void,Map<Locale,SortedMap<String,TextEntry>>>

@ClassVersion(sourceVersion="$Id: TextCollector.java 1062 2023-09-25 23:11:41Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public class TextCollector
extends SimpleElementVisitor9<Void,Map<Locale,SortedMap<String,TextEntry>>>

A visitor class that collects the texts for resource bundle properties files from the annotations.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.2

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Elements	m_ElementUtils	Some helper utilities for the work with Element instances.
private final APHelper	m_Environment	The processing environment.
private final String	m_MessagePrefix	The prefix for the message ids.

Fields inherited from class javax.lang.model.util.SimpleElementVisitor6

DEFAULT_VALUE

Constructor Summary

Constructors

Constructor	Description
TextCollector(APHelper environment, String messagePrefix)	Creates a new TextCollector instance.

Method Summary

Modifier and Type	Method	Description
private final void	addTextEntry(Map<Locale,SortedMap<String,TextEntry>> texts, Element element, String key, String description, String className, boolean isMessage, Translation[] translations)	Adds the text entries to the texts map.
private final void	processTextAnnotation(Map<Locale,SortedMap<String,TextEntry>> texts, Element element, Text annotation, String className)	Processes a text annotation.
final Void	visitExecutable(ExecutableElement element, Map<Locale,SortedMap<String,TextEntry>> texts)
final Void	visitVariable(VariableElement element, Map<Locale,SortedMap<String,TextEntry>> texts)

Methods inherited from class javax.lang.model.util.SimpleElementVisitor9

visitModule

Methods inherited from class javax.lang.model.util.SimpleElementVisitor6

defaultAction, visitPackage, visitType, visitTypeParameter

Methods inherited from class javax.lang.model.util.AbstractElementVisitor6

visit, visit, visitRecordComponent, visitUnknown

Methods inherited from class java.lang.Object

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

Field Details

m_ElementUtils

private final Elements m_ElementUtils

Some helper utilities for the work with Element instances.

m_MessagePrefix

private final String m_MessagePrefix

The prefix for the message ids.

m_Environment

private final APHelper m_Environment

The processing environment.

Constructor Details

TextCollector

public TextCollector(APHelper environment,
 String messagePrefix)

Creates a new TextCollector instance.

Parameters:

environment - The processing environment for the annotation processor.

messagePrefix - The configured message prefix.

Method Details

addTextEntry

private final void addTextEntry(Map<Locale,SortedMap<String,TextEntry>> texts,
 Element element,
 String key,
 String description,
 String className,
 boolean isMessage,
 Translation[] translations)

Adds the text entries to the texts map.

Parameters:

texts - The texts map.

element - The annotated element.

key - The resource bundle key.

description - The description for the text.

className - The fully qualified name of the class that defines the text.

isMessage - true if the text is a message, false otherwise.

translations - The texts in the various languages.

processTextAnnotation

private final void processTextAnnotation(Map<Locale,SortedMap<String,TextEntry>> texts,
 Element element,
 Text annotation,
 String className)

Processes a text annotation.

Parameters:

texts - The texts map.

element - The annotated element.

annotation - The text annotation.

className - The fully qualified name of the class that defines the text.

visitExecutable

public final Void visitExecutable(ExecutableElement element,
 Map<Locale,SortedMap<String,TextEntry>> texts)

Specified by:

visitExecutable in interface ElementVisitor<Void,Map<Locale,SortedMap<String,TextEntry>>>

Overrides:

visitExecutable in class SimpleElementVisitor6<Void,Map<Locale,SortedMap<String,TextEntry>>>

visitVariable

public final Void visitVariable(VariableElement element,
 Map<Locale,SortedMap<String,TextEntry>> texts)

Specified by:

visitVariable in interface ElementVisitor<Void,Map<Locale,SortedMap<String,TextEntry>>>

Overrides:

visitVariable in class SimpleElementVisitor7<Void,Map<Locale,SortedMap<String,TextEntry>>>