org.checkerframework.framework.util.defaults

Class Default

java.lang.Object

org.checkerframework.framework.util.defaults.Default

All Implemented Interfaces:

Comparable<Default>

public class Default
extends Object
implements Comparable<Default>

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 AnnotationUtils).

It also has a handy toString method that is useful for debugging.

Field Summary

Fields

Modifier and Type	Field and Description
AnnotationMirror	anno The default annotation mirror.
boolean	applyToSubpackages Whether the default should be inherited by subpackages.
TypeUseLocation	location The type use location.

Constructor Summary

Constructors

Constructor and Description
Default(AnnotationMirror anno, TypeUseLocation location, boolean applyToSubpackages) Construct a Default object.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Default other)
boolean	equals(@Nullable Object thatObj)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

anno

public final AnnotationMirror anno

The default annotation mirror.

location

public final TypeUseLocation location

The type use location.

applyToSubpackages

public final boolean applyToSubpackages

Whether the default should be inherited by subpackages.

Constructor Detail

Default

public Default(AnnotationMirror anno,
               TypeUseLocation location,
               boolean applyToSubpackages)

Construct a Default object.

Parameters:

anno - the default annotation mirror

location - the type use location

applyToSubpackages - whether the default should be inherited by subpackages

Method Detail

compareTo

public int compareTo(Default other)

Specified by:

compareTo in interface Comparable<Default>

equals

public boolean equals(@Nullable Object thatObj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object