framework.src.org.checkerframework.qualframework.poly.format.QualParamsFormatter 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.poly.format;

import org.checkerframework.qualframework.base.format.QualFormatter;
import org.checkerframework.qualframework.poly.PolyQual;
import org.checkerframework.qualframework.poly.QualParams;

/**
 * A QualFormatter with extra methods to format QualParams.
 */
public interface QualParamsFormatter extends QualFormatter> {

    /**
     * Format a PolyQual into a string.
     *
     * @param polyQual the PolyQual
     * @param printInvisible if true, invisible qualifiers will be printed
     * @return the String representation of q, or null if q was invisible
     *      and print invisible was false
     */
    String format(PolyQual polyQual, boolean printInvisible);

    /**
     * Format a QualParams into a string, but optionally skip the primary
     * qualifier.
     *
     * @param polyQual the PolyQual
     * @param printPrimary if true, include the primary qualifier in the output
     * @param printInvisible if true, invisible qualifiers will be printed
     * @return the String representation of q, or null if q was invisible
     *      and print invisible was false
     */
    String format(QualParams polyQual, boolean printPrimary, boolean printInvisible);

}