org.openjdk.jmc.common.unit

Class SimpleConstrainedMap<K>

java.lang.Object

org.openjdk.jmc.common.unit.MutableConstrainedMap<K>

org.openjdk.jmc.common.unit.SimpleConstrainedMap<K>

Type Parameters:

K - the type of the keys in the map

All Implemented Interfaces:

IConstrainedMap<K>, IMutableConstrainedMap<K>

public class SimpleConstrainedMap<K>
extends MutableConstrainedMap<K>

Simple constrained map that allows constraints to be added, and an optional fallback constraint.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<K,IConstraint<?>>	constraints
protected IConstraint<?>	fallback

Fields inherited from class org.openjdk.jmc.common.unit.MutableConstrainedMap

values

Constructor Summary

Constructors

Modifier	Constructor and Description
	SimpleConstrainedMap()
	SimpleConstrainedMap(IConstraint<?> fallback)
	SimpleConstrainedMap(Map<K,IConstraint<?>> constraints, IConstraint<?> fallback)
protected	SimpleConstrainedMap(Map<K,IConstraint<?>> constraints, IConstraint<?> fallback, Map<K,Object> values)

Method Summary

Modifier and Type	Method and Description
protected void	addConstraint(K key, IConstraint<?> constraint)
IMutableConstrainedMap<K>	emptyWithSameConstraints() Create an empty mutable map, with the same initial constraints as this map.
IConstraint<?>	getConstraint(K key) Get a constraint for mapped values of key, if a constraint has been imposed for key.
protected IConstraint<?>	getSuggestedConstraint(K key) This method will only be called for keys for which MutableConstrainedMap.getConstraint(Object) currently returns null for.
IMutableConstrainedMap<K>	mutableCopy() Create a mutable copy of this map, containing the same initial values as this map.

Methods inherited from class org.openjdk.jmc.common.unit.MutableConstrainedMap

get, getPersistableString, keySet, put, put, putPersistedString, putPersistedString

Methods inherited from class java.lang.Object

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

Field Detail

constraints

protected final Map<K,IConstraint<?>> constraints

fallback

protected final IConstraint<?> fallback

Constructor Detail

SimpleConstrainedMap

public SimpleConstrainedMap()

SimpleConstrainedMap

public SimpleConstrainedMap(IConstraint<?> fallback)

SimpleConstrainedMap

public SimpleConstrainedMap(Map<K,IConstraint<?>> constraints,
                            IConstraint<?> fallback)

SimpleConstrainedMap

protected SimpleConstrainedMap(Map<K,IConstraint<?>> constraints,
                               IConstraint<?> fallback,
                               Map<K,Object> values)

Method Detail

getConstraint

public IConstraint<?> getConstraint(K key)

Description copied from interface: IConstrainedMap

Get a constraint for mapped values of key, if a constraint has been imposed for key.

Specified by:

getConstraint in interface IConstrainedMap<K>

Specified by:

getConstraint in class MutableConstrainedMap<K>

Returns:

a constraint or null

getSuggestedConstraint

protected IConstraint<?> getSuggestedConstraint(K key)

Description copied from class: MutableConstrainedMap

This method will only be called for keys for which MutableConstrainedMap.getConstraint(Object) currently returns null for. Thus, it doesn't matter, and is unspecified, what it would return for keys which MutableConstrainedMap.getConstraint(Object) return non-null for, which typically simplifies the implementations.

Overrides:

getSuggestedConstraint in class MutableConstrainedMap<K>

addConstraint

protected void addConstraint(K key,
                             IConstraint<?> constraint)

Overrides:

addConstraint in class MutableConstrainedMap<K>

emptyWithSameConstraints

public IMutableConstrainedMap<K> emptyWithSameConstraints()

Description copied from interface: IConstrainedMap

Create an empty mutable map, with the same initial constraints as this map. It might be possible to add constraints to the created map, depending on the restrictions built into this map.

mutableCopy

public IMutableConstrainedMap<K> mutableCopy()

Description copied from interface: IConstrainedMap

Create a mutable copy of this map, containing the same initial values as this map. It might be possible to add constraints to the copy, depending on the restrictions built into this map.