org.checkerframework.qualframework.poly.format

Class PrettyQualParamsFormatter<Q>

java.lang.Object

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

All Implemented Interfaces:

QualFormatter<QualParams<Q>>, QualParamsFormatter<Q>

public class PrettyQualParamsFormatter<Q>
extends Object
implements QualParamsFormatter<Q>

Formats a QualParams into the double chevron 《Q》 output format.

Constructor Summary

Constructors

Constructor and Description
PrettyQualParamsFormatter(Set<?> invisibleQualifiers)

Method Summary

Modifier and Type	Method and Description
String	format(PolyQual<Q> polyQual, boolean printInvisible) Format a PolyQual into a string.
String	format(QualParams<Q> params) Format a qualifier into a String.
String	format(QualParams<Q> params, boolean printInvisible) Format a qualifier into a String.
String	format(QualParams<Q> params, boolean printPrimary, boolean printInvisible) Format a QualParams into a string, but optionally skip the primary qualifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrettyQualParamsFormatter

public PrettyQualParamsFormatter(Set<?> invisibleQualifiers)

Method Detail

format

public String format(QualParams<Q> params)

Description copied from interface: QualFormatter

Format a qualifier into a String. Prints invisible qualifiers.

Specified by:

format in interface QualFormatter<QualParams<Q>>

Parameters:

params - the qualifier

Returns:

the String representation of q

format

public String format(QualParams<Q> params,
                     boolean printInvisible)

Description copied from interface: QualFormatter

Format a qualifier into a String.

Specified by:

format in interface QualFormatter<QualParams<Q>>

Parameters:

params - the qualifier

printInvisible - if true, invisible qualifiers will be printed

Returns:

the String representation of q, or null if q was invisible and print invisible was false

format

public String format(QualParams<Q> params,
                     boolean printPrimary,
                     boolean printInvisible)

Description copied from interface: QualParamsFormatter

Format a QualParams into a string, but optionally skip the primary qualifier.

Specified by:

format in interface QualParamsFormatter<Q>

Parameters:

params - the PolyQual

printPrimary - if true, include the primary qualifier in the output

printInvisible - if true, invisible qualifiers will be printed

Returns:

the String representation of q, or null if q was invisible and print invisible was false

format

public String format(PolyQual<Q> polyQual,
                     boolean printInvisible)

Description copied from interface: QualParamsFormatter

Format a PolyQual into a string.

Specified by:

format in interface QualParamsFormatter<Q>

Parameters:

polyQual - the PolyQual

printInvisible - if true, invisible qualifiers will be printed

Returns:

the String representation of q, or null if q was invisible and print invisible was false