org.checkerframework.framework.util.defaults.Default Maven / Gradle / Ivy

Go to download

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-eisop4

Show newest version

package org.checkerframework.framework.util.defaults;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.framework.qual.TypeUseLocation;
import org.checkerframework.javacutil.AnnotationUtils;

import java.util.Objects;

import javax.lang.model.element.AnnotationMirror;

/**
 * Represents a mapping from an Annotation to a TypeUseLocation it should be applied to during
 * defaulting. The Comparable ordering of this class first tests location then tests annotation
 * ordering (via {@link org.checkerframework.javacutil.AnnotationUtils}).
 *
 * It also has a handy toString method that is useful for debugging.
 */
public class Default implements Comparable {
    // please remember to add any fields to the hashcode calculation
    /** The default annotation mirror. */
    public final AnnotationMirror anno;

    /** The type use location. */
    public final TypeUseLocation location;

    /** Whether the default should be inherited by subpackages. */
    public final boolean applyToSubpackages;

    /**
     * Construct a Default object.
     *
     * @param anno the default annotation mirror
     * @param location the type use location
     * @param applyToSubpackages whether the default should be inherited by subpackages
     */
    public Default(AnnotationMirror anno, TypeUseLocation location, boolean applyToSubpackages) {
        this.anno = anno;
        this.location = location;
        this.applyToSubpackages = applyToSubpackages;
    }

    @Override
    public int compareTo(Default other) {
        int locationOrder = location.compareTo(other.location);
        if (locationOrder == 0) {
            int annoOrder = AnnotationUtils.compareAnnotationMirrors(anno, other.anno);
            if (annoOrder == 0) {
                if (applyToSubpackages == other.applyToSubpackages) {
                    return 0;
                } else {
                    return applyToSubpackages ? 1 : -1;
                }
            } else {
                return annoOrder;
            }
        } else {
            return locationOrder;
        }
    }

    @Override
    public boolean equals(@Nullable Object thatObj) {
        if (thatObj == this) {
            return true;
        }

        if (thatObj == null || thatObj.getClass() != Default.class) {
            return false;
        }

        return compareTo((Default) thatObj) == 0;
    }

    @Override
    public int hashCode() {
        return Objects.hash(anno, location, applyToSubpackages);
    }

    @Override
    public String toString() {
        return "( "
                + location.name()
                + " => "
                + anno
                + (applyToSubpackages ? " applies to subpackages" : "")
                + " )";
    }
}