framework.src.org.checkerframework.qualframework.base.format.QualifiedTypeFormatter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation

The Checker Framework enhances Java’s type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.42.0

Show newest version

package org.checkerframework.qualframework.base.format;

import org.checkerframework.qualframework.base.QualifiedTypeMirror;
import org.checkerframework.qualframework.base.format.QualFormatter;

/**
 * Interface to format a QualifiedTypeMirrors or an individual qualifier.
 */
public interface QualifiedTypeFormatter {

    /**
     * Format a QualifiedTypeMirror into a String. Prints invisible qualifiers.
     *
     * @param qtm the QualifiedTypeMirror
     * @return the String representation of qtm
     */
    String format(QualifiedTypeMirror qtm);

    /**
     * Format a QualifiedTypeMirror into a String. Prints invisible qualifiers.
     *
     * @param qtm the QualifiedTypeMirror
     * @param printInvisibles if true, invisible qualifiers will be printed
     * @return the String representation of qtm
     */
    String format(QualifiedTypeMirror qtm, boolean printInvisibles);

    /**
     * Return the QualFormatter used by this formatter.
     *
     * @return the QualFormatter
     */
    QualFormatter getQualFormatter();
}