framework.src.org.checkerframework.framework.util.AnnotationFormatter 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.framework.util;

import org.checkerframework.dataflow.qual.SideEffectFree;

import javax.lang.model.element.AnnotationMirror;
import java.util.Collection;

/**
 * Converts AnnotationMirrors to Strings
 * For converting AnnotatedTypeMirrors:
 * @see org.checkerframework.framework.type.AnnotatedTypeFormatter
 */
public interface AnnotationFormatter {

    /**
     * Converts a collection of annotation mirrors into a String
     * @param annos a collection of annotations to print
     * @param printInvisible whether or not to print "invisible" annotation mirrors
     * @see org.checkerframework.framework.qual.InvisibleQualifier
     * @return a string representation of annos
     */
    @SideEffectFree
    public String formatAnnotationString(Collection annos, boolean printInvisible);

    /**
     * Converts an individual annotation mirror into a String
     * @param anno the annotation mirror to convert
     * @return a String representation of anno
     */
    @SideEffectFree
    public String formatAnnotationMirror(AnnotationMirror anno);
}