Package org.checkerframework.javacutil

Class AnnotationMirrorSet

java.lang.Object

org.checkerframework.javacutil.AnnotationMirrorSet

All Implemented Interfaces:

Iterable<AnnotationMirror>, Collection<AnnotationMirror>, NavigableSet<@KeyFor("this") AnnotationMirror>, Set<AnnotationMirror>, SortedSet<AnnotationMirror>

public class AnnotationMirrorSet
extends Object
implements NavigableSet<@KeyFor("this") AnnotationMirror>

The Set interface defines many methods with respect to the equals method. This implementation of Set violates those specifications, but fulfills the same property using AnnotationUtils.areSame(javax.lang.model.element.AnnotationMirror, javax.lang.model.element.AnnotationMirror) rather than equals.

For example, the specification for the contains(Object o) method says: "returns true if and only if this collection contains at least one element e such that (o == null ? e == null : o.equals(e))." The specification for contains(java.lang.Object) is "returns true if and only if this collection contains at least one element e such that (o == null ? e == null : AnnotationUtils.areSame(o, e))".

AnnotationMirror is an interface and not all implementing classes provide a correct equals method; therefore, the existing implementations of Set cannot be used.

Constructor Summary

Constructors

Constructor	Description
AnnotationMirrorSet()	Default constructor.
AnnotationMirrorSet(Collection<? extends AnnotationMirror> annos)	Returns a new AnnotationMirrorSet that contains the given annotation mirrors.
AnnotationMirrorSet(AnnotationMirror value)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	add(AnnotationMirror annotationMirror)
boolean	addAll(Collection<? extends AnnotationMirror> c)
@Nullable @KeyFor("this") AnnotationMirror	ceiling(AnnotationMirror e)
void	clear()
Comparator<? super AnnotationMirror>	comparator()
boolean	contains(@Nullable Object o)
boolean	containsAll(Collection<?> c)
Iterator<@KeyFor("this") AnnotationMirror>	descendingIterator()
AnnotationMirrorSet	descendingSet()
static AnnotationMirrorSet	emptySet()	Returns an empty set.
boolean	equals(@Nullable Object o)
@KeyFor("this") AnnotationMirror	first()
@Nullable @KeyFor("this") AnnotationMirror	floor(AnnotationMirror e)
int	hashCode()
AnnotationMirrorSet	headSet(AnnotationMirror toElement)
AnnotationMirrorSet	headSet(AnnotationMirror toElement, boolean inclusive)
@Nullable @KeyFor("this") AnnotationMirror	higher(AnnotationMirror e)
boolean	isEmpty()
Iterator<@KeyFor("this") AnnotationMirror>	iterator()
@KeyFor("this") AnnotationMirror	last()
@Nullable @KeyFor("this") AnnotationMirror	lower(AnnotationMirror e)
AnnotationMirrorSet	makeUnmodifiable()	Make this set unmodifiable.
@Nullable @KeyFor("this") AnnotationMirror	pollFirst()
@Nullable @KeyFor("this") AnnotationMirror	pollLast()
boolean	remove(@Nullable Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
static AnnotationMirrorSet	singleton(AnnotationMirror value)	Returns a new unmodifiable AnnotationMirrorSet that contains value.
int	size()
AnnotationMirrorSet	subSet(AnnotationMirror fromElement, boolean fromInclusive, AnnotationMirror toElement, boolean toInclusive)
AnnotationMirrorSet	subSet(AnnotationMirror fromElement, AnnotationMirror toElement)
AnnotationMirrorSet	tailSet(AnnotationMirror fromElement)
AnnotationMirrorSet	tailSet(AnnotationMirror fromElement, boolean inclusive)
Object[]	toArray()
<T> @Nullable T[]	toArray(@PolyNull T[] a)
String	toString()
static AnnotationMirrorSet	unmodifiableSet(Collection<? extends AnnotationMirror> annos)	Returns an unmodifiable AnnotationMirrorSet with the given elements.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.SortedSet

spliterator

Constructor Details

AnnotationMirrorSet

public AnnotationMirrorSet()

Default constructor.

AnnotationMirrorSet

@Deprecated
public AnnotationMirrorSet(AnnotationMirror value)

Deprecated.

Creates a new AnnotationMirrorSet that contains value.

Parameters:

value - the AnnotationMirror to put in the set

AnnotationMirrorSet

public AnnotationMirrorSet(Collection<? extends AnnotationMirror> annos)

Returns a new AnnotationMirrorSet that contains the given annotation mirrors.

Parameters:

annos - the AnnotationMirrors to put in the set

Method Details

makeUnmodifiable

public AnnotationMirrorSet makeUnmodifiable()

Make this set unmodifiable.

Returns:

this set

singleton

public static AnnotationMirrorSet singleton(AnnotationMirror value)

Returns a new unmodifiable AnnotationMirrorSet that contains value.

Parameters:

value - the AnnotationMirror to put in the set

Returns:

a new unmodifiable AnnotationMirrorSet that contains only value

unmodifiableSet

public static AnnotationMirrorSet unmodifiableSet(Collection<? extends AnnotationMirror> annos)

Returns an unmodifiable AnnotationMirrorSet with the given elements.

Parameters:

annos - the annotation mirrors that will constitute the new unmodifable set

Returns:

an unmodifiable AnnotationMirrorSet with the given elements

emptySet

public static AnnotationMirrorSet emptySet()

Returns an empty set.

Returns:

an empty set

size

public int size()

Specified by:

size in interface Collection<AnnotationMirror>

Specified by:

size in interface Set<AnnotationMirror>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<AnnotationMirror>

Specified by:

isEmpty in interface Set<AnnotationMirror>

contains

public boolean contains(@UnknownInitialization(AnnotationMirrorSet.class) AnnotationMirrorSet this,
 @Nullable Object o)

Specified by:

contains in interface Collection<AnnotationMirror>

Specified by:

contains in interface Set<AnnotationMirror>

iterator

public Iterator<@KeyFor("this") AnnotationMirror> iterator()

Specified by:

iterator in interface Collection<AnnotationMirror>

Specified by:

iterator in interface Iterable<AnnotationMirror>

Specified by:

iterator in interface NavigableSet<@KeyFor("this") AnnotationMirror>

Specified by:

iterator in interface Set<AnnotationMirror>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<AnnotationMirror>

Specified by:

toArray in interface Set<AnnotationMirror>

toArray

public <T> @Nullable T[] toArray(@PolyNull T[] a)

Specified by:

toArray in interface Collection<AnnotationMirror>

Specified by:

toArray in interface Set<AnnotationMirror>

add

public boolean add(@UnknownInitialization(AnnotationMirrorSet.class) AnnotationMirrorSet this,
 AnnotationMirror annotationMirror)

Specified by:

add in interface Collection<AnnotationMirror>

Specified by:

add in interface Set<AnnotationMirror>

remove

public boolean remove(@Nullable Object o)

Specified by:

remove in interface Collection<AnnotationMirror>

Specified by:

remove in interface Set<AnnotationMirror>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<AnnotationMirror>

Specified by:

containsAll in interface Set<AnnotationMirror>

addAll

public boolean addAll(@UnknownInitialization(AnnotationMirrorSet.class) AnnotationMirrorSet this,
 Collection<? extends AnnotationMirror> c)

Specified by:

addAll in interface Collection<AnnotationMirror>

Specified by:

addAll in interface Set<AnnotationMirror>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<AnnotationMirror>

Specified by:

retainAll in interface Set<AnnotationMirror>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<AnnotationMirror>

Specified by:

removeAll in interface Set<AnnotationMirror>

clear

public void clear()

Specified by:

clear in interface Collection<AnnotationMirror>

Specified by:

clear in interface Set<AnnotationMirror>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object o)

Specified by:

equals in interface Collection<AnnotationMirror>

Specified by:

equals in interface Set<AnnotationMirror>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<AnnotationMirror>

Specified by:

hashCode in interface Set<AnnotationMirror>

Overrides:

hashCode in class Object

comparator

public Comparator<? super AnnotationMirror> comparator()

Specified by:

comparator in interface SortedSet<AnnotationMirror>

first

public @KeyFor("this") AnnotationMirror first()

Specified by:

first in interface SortedSet<AnnotationMirror>

last

public @KeyFor("this") AnnotationMirror last()

Specified by:

last in interface SortedSet<AnnotationMirror>

lower

public @Nullable @KeyFor("this") AnnotationMirror lower(AnnotationMirror e)

Specified by:

lower in interface NavigableSet<@KeyFor("this") AnnotationMirror>

floor

public @Nullable @KeyFor("this") AnnotationMirror floor(AnnotationMirror e)

Specified by:

floor in interface NavigableSet<@KeyFor("this") AnnotationMirror>

ceiling

public @Nullable @KeyFor("this") AnnotationMirror ceiling(AnnotationMirror e)

Specified by:

ceiling in interface NavigableSet<@KeyFor("this") AnnotationMirror>

higher

public @Nullable @KeyFor("this") AnnotationMirror higher(AnnotationMirror e)

Specified by:

higher in interface NavigableSet<@KeyFor("this") AnnotationMirror>

pollFirst

public @Nullable @KeyFor("this") AnnotationMirror pollFirst()

Specified by:

pollFirst in interface NavigableSet<@KeyFor("this") AnnotationMirror>

pollLast

public @Nullable @KeyFor("this") AnnotationMirror pollLast()

Specified by:

pollLast in interface NavigableSet<@KeyFor("this") AnnotationMirror>

descendingSet

public AnnotationMirrorSet descendingSet()

Specified by:

descendingSet in interface NavigableSet<@KeyFor("this") AnnotationMirror>

descendingIterator

public Iterator<@KeyFor("this") AnnotationMirror> descendingIterator()

Specified by:

descendingIterator in interface NavigableSet<@KeyFor("this") AnnotationMirror>

subSet

public AnnotationMirrorSet subSet(AnnotationMirror fromElement,
 boolean fromInclusive,
 AnnotationMirror toElement,
 boolean toInclusive)

Specified by:

subSet in interface NavigableSet<@KeyFor("this") AnnotationMirror>

headSet

public AnnotationMirrorSet headSet(AnnotationMirror toElement,
 boolean inclusive)

Specified by:

headSet in interface NavigableSet<@KeyFor("this") AnnotationMirror>

tailSet

public AnnotationMirrorSet tailSet(AnnotationMirror fromElement,
 boolean inclusive)

Specified by:

tailSet in interface NavigableSet<@KeyFor("this") AnnotationMirror>

subSet

public AnnotationMirrorSet subSet(AnnotationMirror fromElement,
 AnnotationMirror toElement)

Specified by:

subSet in interface NavigableSet<@KeyFor("this") AnnotationMirror>

Specified by:

subSet in interface SortedSet<AnnotationMirror>

headSet

public AnnotationMirrorSet headSet(AnnotationMirror toElement)

Specified by:

headSet in interface NavigableSet<@KeyFor("this") AnnotationMirror>

Specified by:

headSet in interface SortedSet<AnnotationMirror>

tailSet

public AnnotationMirrorSet tailSet(AnnotationMirror fromElement)

Specified by:

tailSet in interface NavigableSet<@KeyFor("this") AnnotationMirror>

Specified by:

tailSet in interface SortedSet<AnnotationMirror>