org.checkerframework.checker.interning.qual.CompareToMethod Maven / Gradle / Ivy

Go to download

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

checker-qual-android contains annotations (type qualifiers) that a programmer writes to specify Java code for type-checking by the Checker Framework. The checker-qual-android artifact is identical to the checker-qual artifact, except that in checker-qual-android annotations have classfile retention. The default Android Gradle plugin retains types annotated with runtime annotations in the main dex, but strips out class-retention annotations.

There is a newer version: 3.42.0-eisop5

Show newest version

package org.checkerframework.checker.interning.qual;

import org.checkerframework.framework.qual.InheritedAnnotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Method declaration annotation that indicates a method has a specification like {@code
 * compareTo()} or {@code compare()}. The Interning Checker permits use of {@code if (this == arg) {
 * return 0; }} or {@code if (arg1 == arg2) { return 0; }} within the body.
 *
 * @checker_framework.manual #interning-checker Interning Checker
 */
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
@InheritedAnnotation
public @interface CompareToMethod {}