org.checkerframework.framework.type.AnnotatedTypeFormatter 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.43.0

Show newest version

package org.checkerframework.framework.type;

import org.checkerframework.dataflow.qual.SideEffectFree;

/**
 * Converts an AnnotatedTypeMirror mirror into a formatted string. For converting AnnotationMirrors:
 *
 * @see org.checkerframework.framework.util.AnnotationFormatter
 */
public interface AnnotatedTypeFormatter {
  /**
   * Formats type into a String. Uses an implementation specific default for printing "invisible
   * annotations"
   *
   * @see org.checkerframework.framework.qual.InvisibleQualifier
   * @param type the type to be converted
   * @return a string representation of type
   */
  @SideEffectFree
  public String format(AnnotatedTypeMirror type);

  /**
   * Formats type into a String.
   *
   * @param type the type to be converted
   * @param printVerbose whether or not to print verbosely
   * @see org.checkerframework.framework.qual.InvisibleQualifier
   * @return a string representation of type
   */
  @SideEffectFree
  public String format(AnnotatedTypeMirror type, boolean printVerbose);
}