org.checkerframework.framework.util

Class AnnotationMirrorMap<V>

java.lang.Object

org.checkerframework.framework.util.AnnotationMirrorMap<V>

All Implemented Interfaces:

Map<AnnotationMirror,V>

public class AnnotationMirrorMap<V>
extends Object
implements Map<AnnotationMirror,V>

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

For example, the specification for the containsKey(Object key) method says: "returns true if and only if this map contains a mapping for a key k such that (key == null ? k == null : key.equals(k))." The specification for containsKey(java.lang.Object) is "returns true if and only if this map contains a mapping for a key k such that (key == null ? k == null : AnnotationUtils.areSame(key, k))."

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

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AnnotationMirrorMap() Default constructor.
AnnotationMirrorMap(Map<AnnotationMirror,? extends V> copy) Creates an annotation mirror map and adds all the mappings in copy.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<AnnotationMirror,V>>	entrySet()
V	get(Object key)
boolean	isEmpty()
Set<AnnotationMirror>	keySet()
V	put(AnnotationMirror key, V value)
void	putAll(Map<? extends AnnotationMirror,? extends V> m)
V	remove(Object key)
int	size()
Collection<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AnnotationMirrorMap

public AnnotationMirrorMap()

Default constructor.

AnnotationMirrorMap

public AnnotationMirrorMap(Map<AnnotationMirror,? extends V> copy)

Creates an annotation mirror map and adds all the mappings in copy.

Parameters:

copy - a map whose contents should be copied to the newly created map

Method Detail

size

public int size()

Specified by:

size in interface Map<AnnotationMirror,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<AnnotationMirror,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<AnnotationMirror,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<AnnotationMirror,V>

get

public V get(Object key)

Specified by:

get in interface Map<AnnotationMirror,V>

put

public V put(AnnotationMirror key,
             V value)

Specified by:

put in interface Map<AnnotationMirror,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<AnnotationMirror,V>

putAll

public void putAll(Map<? extends AnnotationMirror,? extends V> m)

Specified by:

putAll in interface Map<AnnotationMirror,V>

clear

public void clear()

Specified by:

clear in interface Map<AnnotationMirror,V>

keySet

public Set<AnnotationMirror> keySet()

Specified by:

keySet in interface Map<AnnotationMirror,V>

values

public Collection<V> values()

Specified by:

values in interface Map<AnnotationMirror,V>

entrySet

public Set<Map.Entry<AnnotationMirror,V>> entrySet()

Specified by:

entrySet in interface Map<AnnotationMirror,V>