Package org.checkerframework.framework.type

Class DefaultAnnotatedTypeFormatter.FormattingVisitor

java.lang.Object

org.checkerframework.framework.type.DefaultAnnotatedTypeFormatter.FormattingVisitor

All Implemented Interfaces:

AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Direct Known Subclasses:

NullnessAnnotatedTypeFormatter.NullnessFormattingVisitor, UnitsAnnotatedTypeFormatter.UnitsFormattingVisitor

Enclosing class:

DefaultAnnotatedTypeFormatter

protected static class DefaultAnnotatedTypeFormatter.FormattingVisitor
extends Object
implements AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

A scanning visitor that prints the entire AnnotatedTypeMirror passed to visit.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotationFormatter	annoFormatter	The object responsible for converting annotations to strings.
protected boolean	currentlyPrintingRaw	Whether the visitor is currently printing a raw type.
protected boolean	currentPrintInvisibleSetting	For a given call to format, this setting specifies whether or not to printInvisibles.
protected boolean	currentPrintVerboseGenerics	Prints type variables in a less ambiguous manner using [] to delimit them.
protected final boolean	defaultInvisiblesSetting	Represents whether or not invisible annotations should be printed if the client of this class does not use the printInvisibleAnnos parameter.
protected final boolean	defaultPrintVerboseGenerics	Default value of currentPrintVerboseGenerics.

Constructor Summary

Constructors

Constructor	Description
FormattingVisitor(AnnotationFormatter annoFormatter, boolean printVerboseGenerics, boolean defaultInvisiblesSetting)	Creates the visitor.

Method Summary

Modifier and Type	Method	Description
protected String	formatFlatType(AnnotatedTypeMirror flatType)
protected void	printBound(String keyWord, AnnotatedTypeMirror field, Set<AnnotatedTypeMirror> visiting, StringBuilder sb)	Print, to sb, keyWord followed by field.
protected void	resetPrintVerboseSettings()	Set verbose settings to the default.
protected void	setVerboseSettings(boolean printVerbose)	Set the current verbose settings to use while printing.
String	visit(AnnotatedTypeMirror type)	A convenience method equivalent to v.visit(t, null).
String	visit(AnnotatedTypeMirror type, Set<AnnotatedTypeMirror> annotatedTypeVariables)	Visits a type.
String	visitArray(AnnotatedTypeMirror.AnnotatedArrayType type, Set<AnnotatedTypeMirror> visiting)	Visits an array type.
String	visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType type, Set<AnnotatedTypeMirror> visiting)	Visits a declared type.
String	visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType type, Set<AnnotatedTypeMirror> visiting)	Visits an executable type.
String	visitIntersection(AnnotatedTypeMirror.AnnotatedIntersectionType type, Set<AnnotatedTypeMirror> visiting)	Visits an intersection type.
String	visitNoType(AnnotatedTypeMirror.AnnotatedNoType type, Set<AnnotatedTypeMirror> visiting)	Visits NoType type.
String	visitNull(AnnotatedTypeMirror.AnnotatedNullType type, Set<AnnotatedTypeMirror> visiting)	Visits a null type.
String	visitPrimitive(AnnotatedTypeMirror.AnnotatedPrimitiveType type, Set<AnnotatedTypeMirror> visiting)	Visits a primitive type.
String	visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable type, Set<AnnotatedTypeMirror> visiting)	Visits a type variable.
String	visitUnion(AnnotatedTypeMirror.AnnotatedUnionType type, Set<AnnotatedTypeMirror> visiting)	Visits an union type.
String	visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType type, Set<AnnotatedTypeMirror> visiting)	Visits a wildcard type.

Methods inherited from class java.lang.Object

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

Field Details

annoFormatter

protected final AnnotationFormatter annoFormatter

The object responsible for converting annotations to strings.

defaultInvisiblesSetting

protected final boolean defaultInvisiblesSetting

Represents whether or not invisible annotations should be printed if the client of this class does not use the printInvisibleAnnos parameter.

currentPrintInvisibleSetting

protected boolean currentPrintInvisibleSetting

For a given call to format, this setting specifies whether or not to printInvisibles. If a user did not specify a printInvisible parameter in the call to format then this value will equal DefaultAnnotatedTypeFormatter.defaultInvisibleSettings for this object

defaultPrintVerboseGenerics

protected final boolean defaultPrintVerboseGenerics

Default value of currentPrintVerboseGenerics.

currentPrintVerboseGenerics

protected boolean currentPrintVerboseGenerics

Prints type variables in a less ambiguous manner using [] to delimit them. Always prints both bounds even if they lower bound is an AnnotatedNull type.

currentlyPrintingRaw

protected boolean currentlyPrintingRaw

Whether the visitor is currently printing a raw type.

Constructor Details

FormattingVisitor

public FormattingVisitor(AnnotationFormatter annoFormatter,
 boolean printVerboseGenerics,
 boolean defaultInvisiblesSetting)

Creates the visitor.

Parameters:

annoFormatter - formatter used for AnnotationMirrors

printVerboseGenerics - whether to verbosely print type variables and wildcards

defaultInvisiblesSetting - whether to print invisible qualifiers

Method Details

setVerboseSettings

protected void setVerboseSettings(boolean printVerbose)

Set the current verbose settings to use while printing.

resetPrintVerboseSettings

protected void resetPrintVerboseSettings()

Set verbose settings to the default.

printBound

@SideEffectFree
protected void printBound(String keyWord,
 AnnotatedTypeMirror field,
 Set<AnnotatedTypeMirror> visiting,
 StringBuilder sb)

Print, to sb, keyWord followed by field. NULL types are substituted with their annotations followed by " Void"

visit

@SideEffectFree
public String visit(AnnotatedTypeMirror type)

Description copied from interface: AnnotatedTypeVisitor

A convenience method equivalent to v.visit(t, null).

Specified by:

visit in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

Returns:

a visitor-specified result

visit

public String visit(AnnotatedTypeMirror type,
 Set<AnnotatedTypeMirror> annotatedTypeVariables)

Description copied from interface: AnnotatedTypeVisitor

Visits a type.

Specified by:

visit in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

annotatedTypeVariables - a visitor-specified parameter

Returns:

a visitor-specified result

visitDeclared

public String visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits a declared type.

Specified by:

visitDeclared in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

visitIntersection

public String visitIntersection(AnnotatedTypeMirror.AnnotatedIntersectionType type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits an intersection type.

Specified by:

visitIntersection in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

visitUnion

public String visitUnion(AnnotatedTypeMirror.AnnotatedUnionType type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits an union type.

Specified by:

visitUnion in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

visitExecutable

public String visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits an executable type.

Specified by:

visitExecutable in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

visitArray

public String visitArray(AnnotatedTypeMirror.AnnotatedArrayType type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits an array type.

Specified by:

visitArray in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

visitTypeVariable

public String visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits a type variable.

Specified by:

visitTypeVariable in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

visitPrimitive

@SideEffectFree
public String visitPrimitive(AnnotatedTypeMirror.AnnotatedPrimitiveType type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits a primitive type.

Specified by:

visitPrimitive in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

visitNoType

@SideEffectFree
public String visitNoType(AnnotatedTypeMirror.AnnotatedNoType type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits NoType type.

Specified by:

visitNoType in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

visitNull

@SideEffectFree
public String visitNull(AnnotatedTypeMirror.AnnotatedNullType type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits a null type.

Specified by:

visitNull in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

visitWildcard

public String visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType type,
 Set<AnnotatedTypeMirror> visiting)

Description copied from interface: AnnotatedTypeVisitor

Visits a wildcard type.

Specified by:

visitWildcard in interface AnnotatedTypeVisitor<String,Set<AnnotatedTypeMirror>>

Parameters:

type - the type to visit

visiting - a visitor-specified parameter

Returns:

a visitor-specified result

formatFlatType

@SideEffectFree
protected String formatFlatType(AnnotatedTypeMirror flatType)