org.openjdk.jmc.common.unit

Class MutableConstrainedMap<K>

java.lang.Object

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

Type Parameters:

K - the type of the keys in the map

All Implemented Interfaces:

IConstrainedMap<K>, IMutableConstrainedMap<K>

Direct Known Subclasses:

SimpleConstrainedMap

public abstract class MutableConstrainedMap<K>
extends java.lang.Object
implements IMutableConstrainedMap<K>

A mutable extension to IConstrainedMap. Note that it is the values that can be mutated. Existing constraints cannot be modified. However, some implementations may allow adding constraints for keys that currently doesn't have a constraint, and thus no current value.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<K,java.lang.Object>	values

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MutableConstrainedMap()
protected	MutableConstrainedMap(java.util.HashMap<K,java.lang.Object> values)

Method Summary

Modifier and Type	Method and Description
protected void	addConstraint(K key, IConstraint<?> constraint)
java.lang.Object	get(K key) Get the mapped value for key, or null if no value is currently mapped.
abstract IConstraint<?>	getConstraint(K key) Get a constraint for mapped values of key, if a constraint has been imposed for key.
private <T> java.lang.String	getPersistableString(IConstraint<T> constraint, java.lang.Object value)
java.lang.String	getPersistableString(K key) Get the persistable string of the mapped value for key, or null if no value is currently mapped.
protected IConstraint<?>	getSuggestedConstraint(K key) This method will only be called for keys for which getConstraint(Object) currently returns null for.
java.util.Set<K>	keySet()
<T> void	put(K key, IConstraint<T> constraint, T value) Map key to value, if allowed according to constraint and additional restrictions on this map such as a conflicting constraint being in effect for this key.
void	put(K key, java.lang.Object value) Map key to value, if allowed according to either an existing constraint or an implicit default constraint, if available.
<T> void	putPersistedString(K key, IConstraint<T> constraint, java.lang.String persisted) Map key to the value obtained by parsing persisted, if allowed according to constraint and additional restrictions on this map such as a conflicting constraint being in effect for this key.
void	putPersistedString(K key, java.lang.String persisted) Map key to the value obtained by parsing persisted, if allowed according to either an existing constraint or an implicit default constraint, if available.
private <T> void	validate(IConstraint<T> constraint, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openjdk.jmc.common.unit.IConstrainedMap

emptyWithSameConstraints, mutableCopy

Field Detail

values

protected final java.util.Map<K,java.lang.Object> values

Constructor Detail

MutableConstrainedMap

protected MutableConstrainedMap()

MutableConstrainedMap

protected MutableConstrainedMap(java.util.HashMap<K,java.lang.Object> values)

Method Detail

keySet

public java.util.Set<K> keySet()

Specified by:

keySet in interface IConstrainedMap<K>

Returns:

A set of keys which are known to be valid. That is, those that currently are known to have a constraint. This includes all keys which currently have a value, but additional keys may be included. In other words, IConstrainedMap.get(Object) may return null for some keys included in this set.

get

public java.lang.Object get(K key)

Description copied from interface: IConstrainedMap

Get the mapped value for key, or null if no value is currently mapped. If this method ever returns a non-null value, IConstrainedMap.getConstraint(Object) for the same key will from that point forward return the same matching non-null constraint.

Specified by:

get in interface IConstrainedMap<K>

Returns:

the mapped value or null

getConstraint

public abstract 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>

Returns:

a constraint or null

getSuggestedConstraint

protected IConstraint<?> getSuggestedConstraint(K key)

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

getPersistableString

public java.lang.String getPersistableString(K key)

Description copied from interface: IConstrainedMap

Get the persistable string of the mapped value for key, or null if no value is currently mapped. If this method ever returns a non-null value, IConstrainedMap.getConstraint(Object) for the same key will from that point forward return the same matching non-null constraint.

Specified by:

getPersistableString in interface IConstrainedMap<K>

Returns:

a persistable string or null

getPersistableString

private <T> java.lang.String getPersistableString(IConstraint<T> constraint,
                                                  java.lang.Object value)
                                           throws QuantityConversionException

Throws:

QuantityConversionException

validate

private <T> void validate(IConstraint<T> constraint,
                          java.lang.Object value)
                   throws QuantityConversionException

Throws:

QuantityConversionException

put

public void put(K key,
                java.lang.Object value)
         throws QuantityConversionException

Description copied from interface: IMutableConstrainedMap

Map key to value, if allowed according to either an existing constraint or an implicit default constraint, if available.

Specified by:

put in interface IMutableConstrainedMap<K>

Throws:

QuantityConversionException - if value is rejected by the constraint in some other way

putPersistedString

public void putPersistedString(K key,
                               java.lang.String persisted)
                        throws QuantityConversionException

Description copied from interface: IMutableConstrainedMap

Map key to the value obtained by parsing persisted, if allowed according to either an existing constraint or an implicit default constraint, if available.

Specified by:

putPersistedString in interface IMutableConstrainedMap<K>

Throws:

QuantityConversionException - if persisted is rejected by the constraint in some way

put

public <T> void put(K key,
                    IConstraint<T> constraint,
                    T value)
             throws QuantityConversionException

Description copied from interface: IMutableConstrainedMap

Map key to value, if allowed according to constraint and additional restrictions on this map such as a conflicting constraint being in effect for this key.

Specified by:

put in interface IMutableConstrainedMap<K>

Throws:

QuantityConversionException - if value is rejected by the constraint in some other way

addConstraint

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

putPersistedString

public <T> void putPersistedString(K key,
                                   IConstraint<T> constraint,
                                   java.lang.String persisted)
                            throws QuantityConversionException

Description copied from interface: IMutableConstrainedMap

Map key to the value obtained by parsing persisted, if allowed according to constraint and additional restrictions on this map such as a conflicting constraint being in effect for this key.

Specified by:

putPersistedString in interface IMutableConstrainedMap<K>

Throws:

QuantityConversionException - if persisted is rejected by the constraint in some other way