org.checkerframework.framework.util

Class AnnotationMirrorMap<V>

java.lang.Object

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

All Implemented Interfaces:

java.util.Map<javax.lang.model.element.AnnotationMirror,V>

public class AnnotationMirrorMap<V>
extends java.lang.Object
implements java.util.Map<javax.lang.model.element.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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AnnotationMirrorMap()
AnnotationMirrorMap(java.util.Map<javax.lang.model.element.AnnotationMirror,? extends V> primaries)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<javax.lang.model.element.AnnotationMirror,V>>	entrySet()
V	get(java.lang.Object key)
boolean	isEmpty()
java.util.Set<javax.lang.model.element.AnnotationMirror>	keySet()
V	put(javax.lang.model.element.AnnotationMirror key, V value)
void	putAll(java.util.Map<? extends javax.lang.model.element.AnnotationMirror,? extends V> m)
V	remove(java.lang.Object key)
int	size()
java.util.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()

AnnotationMirrorMap

public AnnotationMirrorMap(java.util.Map<javax.lang.model.element.AnnotationMirror,? extends V> primaries)

Method Detail

size

public int size()

Specified by:

size in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

get

public V get(java.lang.Object key)

Specified by:

get in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

put

public V put(javax.lang.model.element.AnnotationMirror key,
             V value)

Specified by:

put in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

putAll

public void putAll(java.util.Map<? extends javax.lang.model.element.AnnotationMirror,? extends V> m)

Specified by:

putAll in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

clear

public void clear()

Specified by:

clear in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

keySet

public java.util.Set<javax.lang.model.element.AnnotationMirror> keySet()

Specified by:

keySet in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

values

public java.util.Collection<V> values()

Specified by:

values in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>

entrySet

public java.util.Set<java.util.Map.Entry<javax.lang.model.element.AnnotationMirror,V>> entrySet()

Specified by:

entrySet in interface java.util.Map<javax.lang.model.element.AnnotationMirror,V>