Package org.checkerframework.framework.type

Class DefaultAnnotatedTypeFormatter

java.lang.Object

org.checkerframework.framework.type.DefaultAnnotatedTypeFormatter

All Implemented Interfaces:

AnnotatedTypeFormatter

Direct Known Subclasses:

NullnessAnnotatedTypeFormatter, UnitsAnnotatedTypeFormatter

public class DefaultAnnotatedTypeFormatter
extends Object
implements AnnotatedTypeFormatter

An AnnotatedTypeFormatter used by default by all AnnotatedTypeFactory (and therefore all annotated types).

See Also:

• AnnotatedTypeFormatter
• AnnotatedTypeMirror.toString()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DefaultAnnotatedTypeFormatter.FormattingVisitor	A scanning visitor that prints the entire AnnotatedTypeMirror passed to visit.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DefaultAnnotatedTypeFormatter.FormattingVisitor	formattingVisitor

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultAnnotatedTypeFormatter()	Constructs a DefaultAnnotatedTypeFormatter that does not print invisible annotations by default.
	DefaultAnnotatedTypeFormatter(boolean printVerboseGenerics, boolean defaultPrintInvisibleAnnos)
protected	DefaultAnnotatedTypeFormatter(DefaultAnnotatedTypeFormatter.FormattingVisitor visitor)	Used by subclasses and other constructors to specify the underlying implementation of this DefaultAnnotatedTypeFormatter.
	DefaultAnnotatedTypeFormatter(AnnotationFormatter formatter, boolean printVerboseGenerics, boolean defaultPrintInvisibleAnnos)

Method Summary

Modifier and Type	Method	Description
String	format(AnnotatedTypeMirror type)	Formats type into a String.
String	format(AnnotatedTypeMirror type, boolean printVerbose)	Formats type into a String.

Methods inherited from class java.lang.Object

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

Field Details

formattingVisitor

protected final DefaultAnnotatedTypeFormatter.FormattingVisitor formattingVisitor

Constructor Details

DefaultAnnotatedTypeFormatter

public DefaultAnnotatedTypeFormatter()

Constructs a DefaultAnnotatedTypeFormatter that does not print invisible annotations by default.

DefaultAnnotatedTypeFormatter

public DefaultAnnotatedTypeFormatter(boolean printVerboseGenerics,
 boolean defaultPrintInvisibleAnnos)

Parameters:

printVerboseGenerics - for type parameters, their uses, and wildcards, print more information

defaultPrintInvisibleAnnos - whether or not this AnnotatedTypeFormatter should print invisible annotations

DefaultAnnotatedTypeFormatter

public DefaultAnnotatedTypeFormatter(AnnotationFormatter formatter,
 boolean printVerboseGenerics,
 boolean defaultPrintInvisibleAnnos)

Parameters:

formatter - an object that converts annotation mirrors to strings

printVerboseGenerics - for type parameters, their uses, and wildcards, print more information

defaultPrintInvisibleAnnos - whether or not this AnnotatedTypeFormatter should print invisible annotations

DefaultAnnotatedTypeFormatter

protected DefaultAnnotatedTypeFormatter(DefaultAnnotatedTypeFormatter.FormattingVisitor visitor)

Used by subclasses and other constructors to specify the underlying implementation of this DefaultAnnotatedTypeFormatter.

Method Details

format

public String format(AnnotatedTypeMirror type)

Description copied from interface: AnnotatedTypeFormatter

Formats type into a String. Uses an implementation specific default for printing "invisible annotations"

Specified by:

format in interface AnnotatedTypeFormatter

Parameters:

type - the type to be converted

Returns:

a string representation of type

See Also:

• InvisibleQualifier

format

public String format(AnnotatedTypeMirror type,
 boolean printVerbose)

Description copied from interface: AnnotatedTypeFormatter

Formats type into a String.

Specified by:

format in interface AnnotatedTypeFormatter

Parameters:

type - the type to be converted

printVerbose - whether or not to print verbosely

Returns:

a string representation of type

See Also:

• InvisibleQualifier