org.checkerframework.checker.formatter

Class FormatterTreeUtil.FormatCall

java.lang.Object

org.checkerframework.checker.formatter.FormatterTreeUtil.FormatCall

Enclosing class:

FormatterTreeUtil

public class FormatterTreeUtil.FormatCall
extends java.lang.Object

Represents a format method invocation in the syntax tree.

Constructor Summary

Constructors

Constructor and Description
FormatCall(com.sun.source.tree.MethodInvocationTree node, AnnotatedTypeFactory atypeFactory)

Method Summary

Modifier and Type	Method and Description
ConversionCategory[]	getFormatCategories() Returns the conversion category for every parameter.
FormatterTreeUtil.Result<FormatterTreeUtil.InvocationType>	getInvocationType() Returns the type of method invocation.
FormatterTreeUtil.Result<javax.lang.model.type.TypeMirror>[]	getParamTypes() Returns the type of the function's parameters.
FormatterTreeUtil.Result<java.lang.String>	hasFormatAnnotation() Returns null if the format-string argument's type is annotated as @Format.
boolean	isParameterNull(javax.lang.model.type.TypeMirror type) Checks if the parameter returned from getParamTypes() is a null expression.
boolean	isValidParameter(ConversionCategory formatCat, javax.lang.model.type.TypeMirror paramType) Checks if the type of a parameter returned from getParamTypes() is valid for the passed ConversionCategory.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatCall

public FormatCall(com.sun.source.tree.MethodInvocationTree node,
                  AnnotatedTypeFactory atypeFactory)

Method Detail

hasFormatAnnotation

public final FormatterTreeUtil.Result<java.lang.String> hasFormatAnnotation()

Returns null if the format-string argument's type is annotated as @Format. Returns an error description if not annotated as @Format.

getInvocationType

public final FormatterTreeUtil.Result<FormatterTreeUtil.InvocationType> getInvocationType()

Returns the type of method invocation.

See Also:

FormatterTreeUtil.InvocationType

getFormatCategories

public final ConversionCategory[] getFormatCategories()

Returns the conversion category for every parameter.

See Also:

ConversionCategory

getParamTypes

public final FormatterTreeUtil.Result<javax.lang.model.type.TypeMirror>[] getParamTypes()

Returns the type of the function's parameters. Use isValidParameter and isParameterNull to work with the result.

isValidParameter

public final boolean isValidParameter(ConversionCategory formatCat,
                                      javax.lang.model.type.TypeMirror paramType)

Checks if the type of a parameter returned from getParamTypes() is valid for the passed ConversionCategory.

isParameterNull

public final boolean isParameterNull(javax.lang.model.type.TypeMirror type)

Checks if the parameter returned from getParamTypes() is a null expression.