org.checkerframework.checker.i18nformatter

Class I18nFormatterTreeUtil

java.lang.Object

org.checkerframework.checker.i18nformatter.I18nFormatterTreeUtil

public class I18nFormatterTreeUtil
extends java.lang.Object

This class provides a collection of utilities to ease working with syntax trees that have something to do with I18nFormatters.

See the Checker Framework Manual:

Internationalization Format String Checker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	I18nFormatterTreeUtil.FormatType Describe the format annotation type.
class	I18nFormatterTreeUtil.I18nFormatCall Represents a format method invocation in the syntax tree.

Field Summary

Fields

Modifier and Type	Field and Description
BaseTypeChecker	checker
javax.annotation.processing.ProcessingEnvironment	processingEnv

Constructor Summary

Constructors

Constructor and Description
I18nFormatterTreeUtil(BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
javax.lang.model.element.AnnotationMirror	categoriesToFormatAnnotation(I18nConversionCategory[] args) Takes a list of ConversionCategory elements, and returns a syntax tree element that represents a I18nFormat annotation with the list as value.
I18nFormatterTreeUtil.I18nFormatCall	createFormatForCall(com.sun.source.tree.MethodInvocationTree tree, MethodInvocationNode node, I18nFormatterAnnotatedTypeFactory atypeFactory) Returns an I18nFormatCall instance, only if FormatFor is called.
javax.lang.model.element.AnnotationMirror	exceptionToInvalidFormatAnnotation(java.lang.IllegalArgumentException ex) Takes an exception that describes an invalid formatter string and returns a syntax trees element that represents a I18nInvalidFormat annotation with the exception's error message as value.
<E> void	failure(FormatterTreeUtil.Result<E> res, @CompilerMessageKey java.lang.String msg, java.lang.Object... args) Reports an error.
I18nConversionCategory[]	formatAnnotationToCategories(javax.lang.model.element.AnnotationMirror anno) Takes a syntax tree element that represents a I18nFormat annotation, and returns its value.
FormatterTreeUtil.Result<I18nConversionCategory[]>	getHasFormatCallCategories(MethodInvocationNode node)
java.lang.String	invalidFormatAnnotationToErrorMessage(javax.lang.model.element.AnnotationMirror anno) Takes a syntax tree element that represents a I18nInvalidFormat annotation, and returns its value.
boolean	isHasFormatCall(MethodInvocationNode node, AnnotatedTypeFactory atypeFactory) Returns true if the call is to a method with the @I18nChecksFormat annotation.
boolean	isIsFormatCall(MethodInvocationNode node, AnnotatedTypeFactory atypeFactory) Returns true if the call is to a method with the @I18nValidFormat annotation.
boolean	isMakeFormatCall(MethodInvocationNode node, AnnotatedTypeFactory atypeFactory) Returns true if the call is to a method with the @I18nMakeFormat annotation.
FormatterTreeUtil.Result<I18nConversionCategory[]>	makeFormatCallCategories(MethodInvocationNode node, I18nFormatterAnnotatedTypeFactory atypeFactory)
<E> void	warning(FormatterTreeUtil.Result<E> res, @CompilerMessageKey java.lang.String msg, java.lang.Object... args) Reports an warning.

Methods inherited from class java.lang.Object

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

Field Detail

checker

public final BaseTypeChecker checker

processingEnv

public final javax.annotation.processing.ProcessingEnvironment processingEnv

Constructor Detail

I18nFormatterTreeUtil

public I18nFormatterTreeUtil(BaseTypeChecker checker)

Method Detail

exceptionToInvalidFormatAnnotation

public javax.lang.model.element.AnnotationMirror exceptionToInvalidFormatAnnotation(java.lang.IllegalArgumentException ex)

Takes an exception that describes an invalid formatter string and returns a syntax trees element that represents a I18nInvalidFormat annotation with the exception's error message as value.

invalidFormatAnnotationToErrorMessage

public java.lang.String invalidFormatAnnotationToErrorMessage(javax.lang.model.element.AnnotationMirror anno)

Takes a syntax tree element that represents a I18nInvalidFormat annotation, and returns its value.

categoriesToFormatAnnotation

public javax.lang.model.element.AnnotationMirror categoriesToFormatAnnotation(I18nConversionCategory[] args)

Takes a list of ConversionCategory elements, and returns a syntax tree element that represents a I18nFormat annotation with the list as value.

formatAnnotationToCategories

public I18nConversionCategory[] formatAnnotationToCategories(javax.lang.model.element.AnnotationMirror anno)

Takes a syntax tree element that represents a I18nFormat annotation, and returns its value.

isHasFormatCall

public boolean isHasFormatCall(MethodInvocationNode node,
                               AnnotatedTypeFactory atypeFactory)

Returns true if the call is to a method with the @I18nChecksFormat annotation. An example of such a method is I18nFormatUtil.hasFormat.

isIsFormatCall

public boolean isIsFormatCall(MethodInvocationNode node,
                              AnnotatedTypeFactory atypeFactory)

Returns true if the call is to a method with the @I18nValidFormat annotation. An example of such a method is I18nFormatUtil.isFormat.

isMakeFormatCall

public boolean isMakeFormatCall(MethodInvocationNode node,
                                AnnotatedTypeFactory atypeFactory)

Returns true if the call is to a method with the @I18nMakeFormat annotation. An example of such a method is ResourceBundle.getString.

failure

public final <E> void failure(FormatterTreeUtil.Result<E> res,
                              @CompilerMessageKey java.lang.String msg,
                              java.lang.Object... args)

Reports an error. Takes a FormatterTreeUtil.Result to report the location.

warning

public final <E> void warning(FormatterTreeUtil.Result<E> res,
                              @CompilerMessageKey java.lang.String msg,
                              java.lang.Object... args)

Reports an warning. Takes a FormatterTreeUtil.Result to report the location.

getHasFormatCallCategories

public FormatterTreeUtil.Result<I18nConversionCategory[]> getHasFormatCallCategories(MethodInvocationNode node)

makeFormatCallCategories

public FormatterTreeUtil.Result<I18nConversionCategory[]> makeFormatCallCategories(MethodInvocationNode node,
                                                                                   I18nFormatterAnnotatedTypeFactory atypeFactory)

createFormatForCall

public I18nFormatterTreeUtil.I18nFormatCall createFormatForCall(com.sun.source.tree.MethodInvocationTree tree,
                                                                MethodInvocationNode node,
                                                                I18nFormatterAnnotatedTypeFactory atypeFactory)

Returns an I18nFormatCall instance, only if FormatFor is called. Otherwise, returns null.