org.checkerframework.qualframework.poly.format

Class SurfaceSyntaxFormatterConfiguration<Q>

java.lang.Object

org.checkerframework.qualframework.poly.format.SurfaceSyntaxFormatterConfiguration<Q>

public abstract class SurfaceSyntaxFormatterConfiguration<Q>
extends Object

SurfaceSyntaxFormatterConfiguration provides values and methods required by the SurfaceSyntaxQualParamsFormatter to format a QualParams into an annotation.

Constructor Summary

Constructors

Constructor and Description
SurfaceSyntaxFormatterConfiguration(Q top, Q bottom, QualParams<Q> qualTop, QualParams<Q> qualBottom)

Method Summary

Modifier and Type	Method and Description
Q	getBottom()
QualParams<Q>	getQualBottom()
QualParams<Q>	getQualTop()
protected abstract SurfaceSyntaxQualParamsFormatter.AnnotationParts	getTargetTypeSystemAnnotation(Q qual) Return an AnnotationParts object that represents the equivalent annotation of q.
Q	getTop()
protected abstract boolean	shouldPrintAnnotation(SurfaceSyntaxQualParamsFormatter.AnnotationParts anno, boolean printInvisibleQualifiers) Determine if the annotation should be printed

Methods inherited from class java.lang.Object

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

Constructor Detail

SurfaceSyntaxFormatterConfiguration

public SurfaceSyntaxFormatterConfiguration(Q top,
                                           Q bottom,
                                           QualParams<Q> qualTop,
                                           QualParams<Q> qualBottom)

Method Detail

shouldPrintAnnotation

protected abstract boolean shouldPrintAnnotation(SurfaceSyntaxQualParamsFormatter.AnnotationParts anno,
                                                 boolean printInvisibleQualifiers)

Determine if the annotation should be printed

Parameters:

anno - the AnnotationParts representation of the annotatino

printInvisibleQualifiers - if printingInvisibleQualifiers is enabled

Returns:

true if the annotation should be printed

getTargetTypeSystemAnnotation

protected abstract SurfaceSyntaxQualParamsFormatter.AnnotationParts getTargetTypeSystemAnnotation(Q qual)

Return an AnnotationParts object that represents the equivalent annotation of q.

Parameters:

qual - the qualifier

Returns:

the AnnotationParts

getBottom

public Q getBottom()

getTop

public Q getTop()

getQualBottom

public QualParams<Q> getQualBottom()

getQualTop

public QualParams<Q> getQualTop()