org.checkerframework.qualframework.poly

Class QualParams<Q>

java.lang.Object

org.checkerframework.qualframework.poly.QualParams<Q>

All Implemented Interfaces:

Map<String,Wildcard<Q>>

public class QualParams<Q>
extends Object
implements Map<String,Wildcard<Q>>

A map of qualifier parameters. A QualParams object maps qualifier parameter names to Wildcard objects.

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
QualParams() Construct an empty qualifier parameter map.
QualParams(Map<String,Wildcard<Q>> map, PolyQual<Q> primary)
QualParams(PolyQual<Q> primary)
QualParams(String name, Q qual, PolyQual<Q> primary) Construct a map containing a single entry whose value is a qualifier from the underlying hierarchy.
QualParams(String name, Wildcard<Q> qual, PolyQual<Q> primary) Construct a map containing a single entry.

Method Summary

Modifier and Type	Method and Description
void	clear()
QualParams<Q>	clone()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,Wildcard<Q>>>	entrySet()
boolean	equals(Object o)
Wildcard<Q>	get(Object key)
PolyQual<Q>	getPrimary()
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()
Wildcard<Q>	put(String key, Wildcard<Q> value)
void	putAll(Map<? extends String,? extends Wildcard<Q>> m)
Wildcard<Q>	remove(Object key)
void	setPrimary(PolyQual<Q> primary)
int	size()
QualParams<Q>	substituteAll(Map<String,Wildcard<Q>> substs) Apply a set of substitutions to each value in this map.
String	toString()
Collection<Wildcard<Q>>	values()

Methods inherited from class java.lang.Object

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

Constructor Detail

QualParams

public QualParams()

Construct an empty qualifier parameter map.

QualParams

public QualParams(String name,
                  Q qual,
                  PolyQual<Q> primary)

Construct a map containing a single entry whose value is a qualifier from the underlying hierarchy.

QualParams

public QualParams(String name,
                  Wildcard<Q> qual,
                  PolyQual<Q> primary)

Construct a map containing a single entry.

QualParams

public QualParams(PolyQual<Q> primary)

QualParams

public QualParams(Map<String,Wildcard<Q>> map,
                  PolyQual<Q> primary)

Method Detail

substituteAll

public QualParams<Q> substituteAll(Map<String,Wildcard<Q>> substs)

Apply a set of substitutions to each value in this map. Substitutions are performed on the underlying wildcards. For each key/value in substs, if the target wildcard has a QualVar with a name that matches "key", the value of the bounds of the QualVar are replaced by the bounds of the value wildcard. This substitution must also be performed on the primary qualifier, as the primary might be a QualVar.

clear

public void clear()

Specified by:

clear in interface Map<String,Wildcard<Q>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Wildcard<Q>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Wildcard<Q>>

entrySet

public Set<Map.Entry<String,Wildcard<Q>>> entrySet()

Specified by:

entrySet in interface Map<String,Wildcard<Q>>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,Wildcard<Q>>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Wildcard<Q>>

Overrides:

hashCode in class Object

get

public Wildcard<Q> get(Object key)

Specified by:

get in interface Map<String,Wildcard<Q>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Wildcard<Q>>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Wildcard<Q>>

put

public Wildcard<Q> put(String key,
                       Wildcard<Q> value)

Specified by:

put in interface Map<String,Wildcard<Q>>

putAll

public void putAll(Map<? extends String,? extends Wildcard<Q>> m)

Specified by:

putAll in interface Map<String,Wildcard<Q>>

remove

public Wildcard<Q> remove(Object key)

Specified by:

remove in interface Map<String,Wildcard<Q>>

size

public int size()

Specified by:

size in interface Map<String,Wildcard<Q>>

clone

public QualParams<Q> clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

values

public Collection<Wildcard<Q>> values()

Specified by:

values in interface Map<String,Wildcard<Q>>

getPrimary

public PolyQual<Q> getPrimary()

setPrimary

public void setPrimary(PolyQual<Q> primary)