org.checkerframework.qualframework.base.format

Class DefaultQualifiedTypeFormatter<Q,QUAL_FORMATTER extends QualFormatter<Q>>

java.lang.Object

org.checkerframework.qualframework.base.format.DefaultQualifiedTypeFormatter<Q,QUAL_FORMATTER>

All Implemented Interfaces:

QualifiedTypeFormatter<Q>

Direct Known Subclasses:

PrettyQualifiedTypeFormatter

public class DefaultQualifiedTypeFormatter<Q,QUAL_FORMATTER extends QualFormatter<Q>>
extends Object
implements QualifiedTypeFormatter<Q>

DefaultQualifiedTypeFormatter formats QualifiedTypeMirrors into Strings. This implementation used a component AnnotatedTypeFormatter to drive the formatting and an AnnotationFormatter that converts @QualifierKey annotations to the qualifier, which is then formatted by a QualFormatter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DefaultQualifiedTypeFormatter.AnnoToQualFormatter Formats an @QualifierKey annotation by looking up the corresponding QualParams and formatting it using a PrettyQualParamsFormatter.

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotatedTypeFormatter	adapter
protected AnnotationFormatter	annoAdapter
protected TypeMirrorConverter<Q>	converter
protected boolean	defaultPrintInvisibleQualifiers
protected boolean	defaultPrintVerboseGenerics
protected QUAL_FORMATTER	qualFormatter

Constructor Summary

Constructors

Constructor and Description
DefaultQualifiedTypeFormatter(QUAL_FORMATTER qualFormatter, TypeMirrorConverter<Q> converter, boolean defaultPrintVerboseGenerics, boolean defaultPrintInvisibleQualifiers)

Method Summary

Modifier and Type	Method and Description
protected AnnotatedTypeFormatter	createAnnotatedTypeFormatter(AnnotationFormatter annotationFormatter) Create the AnnotatedTypeFormatter to be used as the underling formatter.
protected AnnotationFormatter	createAnnotationFormatter()
String	format(QualifiedTypeMirror<Q> qtm) Format a QualifiedTypeMirror into a String.
String	format(QualifiedTypeMirror<Q> qtm, boolean printInvisibles) Format a QualifiedTypeMirror into a String.
QUAL_FORMATTER	getQualFormatter() Return the QualFormatter used by this formatter.

Methods inherited from class java.lang.Object

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

Field Detail

converter

protected final TypeMirrorConverter<Q> converter

qualFormatter

protected final QUAL_FORMATTER extends QualFormatter<Q> qualFormatter

defaultPrintInvisibleQualifiers

protected final boolean defaultPrintInvisibleQualifiers

adapter

protected final AnnotatedTypeFormatter adapter

annoAdapter

protected final AnnotationFormatter annoAdapter

defaultPrintVerboseGenerics

protected final boolean defaultPrintVerboseGenerics

Constructor Detail

DefaultQualifiedTypeFormatter

public DefaultQualifiedTypeFormatter(QUAL_FORMATTER qualFormatter,
                                     TypeMirrorConverter<Q> converter,
                                     boolean defaultPrintVerboseGenerics,
                                     boolean defaultPrintInvisibleQualifiers)

Method Detail

createAnnotatedTypeFormatter

protected AnnotatedTypeFormatter createAnnotatedTypeFormatter(AnnotationFormatter annotationFormatter)

Create the AnnotatedTypeFormatter to be used as the underling formatter. This formatter should use formatter as its AnnotationFormatter.

Parameters:

annotationFormatter - an AnnotationFormatter that is configured to printout qualifiers using qualFormatter

Returns:

the AnnotatedTypeFormatter

format

public String format(QualifiedTypeMirror<Q> qtm)

Description copied from interface: QualifiedTypeFormatter

Format a QualifiedTypeMirror into a String. Prints invisible qualifiers.

Specified by:

format in interface QualifiedTypeFormatter<Q>

Parameters:

qtm - the QualifiedTypeMirror

Returns:

the String representation of qtm

format

public String format(QualifiedTypeMirror<Q> qtm,
                     boolean printInvisibles)

Description copied from interface: QualifiedTypeFormatter

Format a QualifiedTypeMirror into a String. Prints invisible qualifiers.

Specified by:

format in interface QualifiedTypeFormatter<Q>

Parameters:

qtm - the QualifiedTypeMirror

printInvisibles - if true, invisible qualifiers will be printed

Returns:

the String representation of qtm

getQualFormatter

public QUAL_FORMATTER getQualFormatter()

Description copied from interface: QualifiedTypeFormatter

Return the QualFormatter used by this formatter.

Specified by:

getQualFormatter in interface QualifiedTypeFormatter<Q>

Returns:

the QualFormatter

createAnnotationFormatter

protected AnnotationFormatter createAnnotationFormatter()