Package org.jboss.logging.processor.apt

Class TranslationFileGenerator

java.lang.Object

org.jboss.logging.processor.apt.AbstractGenerator

org.jboss.logging.processor.apt.TranslationFileGenerator

@SupportedOptions({"generatedTranslationFilesPath","org.jboss.logging.tools.level","org.jboss.logging.tools.generated.skip.index"})
final class TranslationFileGenerator
extends AbstractGenerator

The generator of skeletal translations files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	TranslationFileGenerator.LevelComparator

Field Summary

Fields

Modifier and Type	Field	Description
private final TranslationFileGenerator.LevelComparator	comparator
private static final String	DEFAULT_FILE_COMMENT
private static final String	DEFAULT_FILE_EXTENSION
private static final String	EMPTY_STRING
(package private) static final String	GENERATED_FILE_EXTENSION
(package private) static final String	GENERATED_FILES_PATH_OPTION
private final String	generatedFilesPath
private static final String	JAVA_DOC_PARAM
(package private) static final String	LEVEL_OPTION
private static final Map<String,Integer>	levels
private static final Pattern	PATTERN
(package private) static final String	SKIP_INDEX
private final boolean	skipIndex

Fields inherited from class org.jboss.logging.processor.apt.AbstractGenerator

processingEnv

Constructor Summary

Constructors

Constructor	Description
TranslationFileGenerator(ProcessingEnvironment processingEnv)	The constructor.

Method Summary

Modifier and Type	Method	Description
private String	addIndexesToFormat(MessageMethod method)
private void	generateDefaultTranslationFile(MessageInterface messageInterface)	Generates a default i18n properties file.
private void	generateSkeletalTranslationFile(String relativePath, String fileName, MessageInterface messageInterface)	Generate the translation file containing the given translations.
private static String	getPrimaryClassNamePrefix(TypeElement element)	Returns the primary class simple name prefix for an element who represents a MessageBundle or MessageLogger interface.
private boolean	isMethodWritable(MessageMethod method)
private Map<String,String>	parseParameterComments(MessageMethod messageMethod)
void	processTypeElement(TypeElement annotation, TypeElement element, MessageInterface messageInterface)	Processes a type element.
private static void	writeSeparatorLine(BufferedWriter writer)
private void	writeSkeletonMessageMethod(BufferedWriter writer, MessageMethod messageMethod)

Methods inherited from class org.jboss.logging.processor.apt.AbstractGenerator

getName, getSupportedOptions, logger

Methods inherited from class java.lang.Object

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

Field Details

levels

private static final Map<String,Integer> levels

PATTERN

private static final Pattern PATTERN

EMPTY_STRING

private static final String EMPTY_STRING

See Also:

• Constant Field Values

JAVA_DOC_PARAM

private static final String JAVA_DOC_PARAM

See Also:

• Constant Field Values

DEFAULT_FILE_EXTENSION

private static final String DEFAULT_FILE_EXTENSION

See Also:

• Constant Field Values

DEFAULT_FILE_COMMENT

private static final String DEFAULT_FILE_COMMENT

See Also:

• Constant Field Values

GENERATED_FILES_PATH_OPTION

static final String GENERATED_FILES_PATH_OPTION

See Also:

• Constant Field Values

GENERATED_FILE_EXTENSION

static final String GENERATED_FILE_EXTENSION

See Also:

• Constant Field Values

LEVEL_OPTION

static final String LEVEL_OPTION

See Also:

• Constant Field Values

SKIP_INDEX

static final String SKIP_INDEX

See Also:

• Constant Field Values

generatedFilesPath

private final String generatedFilesPath

comparator

private final TranslationFileGenerator.LevelComparator comparator

skipIndex

private final boolean skipIndex

Constructor Details

TranslationFileGenerator

TranslationFileGenerator(ProcessingEnvironment processingEnv)

The constructor.

Parameters:

processingEnv - the processing env

Method Details

processTypeElement

public void processTypeElement(TypeElement annotation,
 TypeElement element,
 MessageInterface messageInterface)

Description copied from class: AbstractGenerator

Processes a type element.

Specified by:

processTypeElement in class AbstractGenerator

Parameters:

annotation - the annotation who trigger the processing

element - the element that contains the methods.

messageInterface - the message interface to implement.

generateSkeletalTranslationFile

private void generateSkeletalTranslationFile(String relativePath,
 String fileName,
 MessageInterface messageInterface)

Generate the translation file containing the given translations.

Parameters:

relativePath - the relative path

fileName - the file name

messageInterface - the message interface

generateDefaultTranslationFile

private void generateDefaultTranslationFile(MessageInterface messageInterface)

Generates a default i18n properties file.

Parameters:

messageInterface - the message interface

writeSkeletonMessageMethod

private void writeSkeletonMessageMethod(BufferedWriter writer,
 MessageMethod messageMethod)
                                 throws IOException

Throws:

IOException

parseParameterComments

private Map<String,String> parseParameterComments(MessageMethod messageMethod)
                                           throws IOException

Throws:

IOException

isMethodWritable

private boolean isMethodWritable(MessageMethod method)

writeSeparatorLine

private static void writeSeparatorLine(BufferedWriter writer)
                                throws IOException

Throws:

IOException

getPrimaryClassNamePrefix

private static String getPrimaryClassNamePrefix(TypeElement element)

Returns the primary class simple name prefix for an element who represents a MessageBundle or MessageLogger interface.

Parameters:

element - the element

Returns:

the translation file name prefix

Throws:

IllegalArgumentException - if element is null or the element is not an interface

addIndexesToFormat

private String addIndexesToFormat(MessageMethod method)