org.checkerframework.framework.util

Class AnnotationMirrorSet

java.lang.Object

org.checkerframework.framework.util.AnnotationMirrorSet

All Implemented Interfaces:

Iterable<AnnotationMirror>, Collection<AnnotationMirror>, Set<AnnotationMirror>

public class AnnotationMirrorSet
extends Object
implements Set<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 and Description
AnnotationMirrorSet() Default constructor.
AnnotationMirrorSet(Collection<? extends AnnotationMirror> values)

Method Summary

Modifier and Type	Method and Description
boolean	add(AnnotationMirror annotationMirror)
boolean	addAll(Collection<? extends AnnotationMirror> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	isEmpty()
Iterator<AnnotationMirror>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
static AnnotationMirrorSet	singleElementSet(AnnotationMirror value) Returns a new AnnotationMirrorSet that contains value.
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AnnotationMirrorSet

public AnnotationMirrorSet()

Default constructor.

AnnotationMirrorSet

public AnnotationMirrorSet(Collection<? extends AnnotationMirror> values)

Method Detail

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(Object o)

Specified by:

contains in interface Collection<AnnotationMirror>

Specified by:

contains in interface Set<AnnotationMirror>

iterator

public Iterator<AnnotationMirror> iterator()

Specified by:

iterator in interface Iterable<AnnotationMirror>

Specified by:

iterator in interface Collection<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> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<AnnotationMirror>

Specified by:

toArray in interface Set<AnnotationMirror>

add

public boolean add(AnnotationMirror annotationMirror)

Specified by:

add in interface Collection<AnnotationMirror>

Specified by:

add in interface Set<AnnotationMirror>

remove

public boolean remove(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(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>

singleElementSet

public static AnnotationMirrorSet singleElementSet(AnnotationMirror value)

Returns a new AnnotationMirrorSet that contains value.

Parameters:

value - AnnotationMirror to put in the set

Returns:

a new AnnotationMirrorSet that contains value.