org.jvoicexml.interpreter.scope

Class ScopedMap<K,V>

java.lang.Object

org.jvoicexml.interpreter.scope.ScopedMap<K,V>

Type Parameters:

K - Key class of the map.

V - Value class of the map.

All Implemented Interfaces:

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

public final class ScopedMap<K,V>
extends java.lang.Object
implements ScopeSubscriber, java.util.Map<K,V>

A simple Map which is scope aware.

This enables the user to store in a map and retrieve these values without taking care about scope changes. The values are always scope aware.

All keys are associated with a stack. The topmost element of the stack is the current value.

Since:

0.3

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
ScopedMap(ScopeObserver scopeObserver) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all mappings from this map (optional operation).
void	close() Unsubscribe this scoped container from the ScopePublisher.
boolean	containsKey(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(java.lang.Object value) Returns true if this map maps one or more keys to the specified value.
void	enterScope(Scope previous, Scope next) The application has entered the next scope and the previous scope is no more the current scope.
java.util.Set<java.util.Map.Entry<K,V>>	entrySet() Returns a set view of the mappings contained in this map.
boolean	equals(java.lang.Object o) Compares the specified object with this map for equality.
void	exitScope(Scope previous, Scope next) The application has left the previous scope and the next scope is valid.
V	get(java.lang.Object key) Returns the value to which this map maps the specified key.
int	hashCode() Returns the hash code value for this map.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
java.util.Set<K>	keySet() Returns a set view of the keys contained in this map.
V	put(K key, V value) Associates the specified value with the specified key in this map (optional operation).
void	putAll(java.util.Map<? extends K,? extends V> t) Copies all of the mappings from the specified map to this map (optional operation).
V	remove(java.lang.Object key) Removes the mapping for this key from this map if it is present (optional operation).
int	size() Returns the number of key-value mappings in this map.
java.util.Collection<V>	values() Returns a collection view of the values contained in this map.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Constructor Detail

ScopedMap

public ScopedMap(ScopeObserver scopeObserver)

Constructs a new object.

Parameters:

scopeObserver - The current scope observer.

Method Detail

close

public void close()

Unsubscribe this scoped container from the ScopePublisher.

enterScope

public void enterScope(Scope previous,
                       Scope next)

The application has entered the next scope and the previous scope is no more the current scope.

Specified by:

enterScope in interface ScopeSubscriber

Parameters:

previous - the old scope.

next - The new scope.

exitScope

public void exitScope(Scope previous,
                      Scope next)

The application has left the previous scope and the next scope is valid.

Specified by:

exitScope in interface ScopeSubscriber

Parameters:

previous - the old scope.

next - the new scope.

size

public int size()

Returns the number of key-value mappings in this map.

Specified by:

size in interface java.util.Map<K,V>

Returns:

the number of key-value mappings in this map.

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface java.util.Map<K,V>

Returns:

true if this map contains no key-value mappings.

containsKey

public boolean containsKey(java.lang.Object key)

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface java.util.Map<K,V>

Parameters:

key - key whose presence in this map is to be tested.

Returns:

true if this map contains a mapping for the specified key.

containsValue

public boolean containsValue(java.lang.Object value)

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface java.util.Map<K,V>

Parameters:

value - value whose presence in this map is to be tested.

Returns:

true if this map maps one or more keys to the specified value.

get

public V get(java.lang.Object key)

Returns the value to which this map maps the specified key.

Specified by:

get in interface java.util.Map<K,V>

Parameters:

key - key whose associated value is to be returned.

Returns:

the value to which this map maps the specified key, or null if the map contains no mapping for this key.

put

public V put(K key,
             V value)

Associates the specified value with the specified key in this map (optional operation).

Specified by:

put in interface java.util.Map<K,V>

Parameters:

key - key with which the specified value is to be associated.

value - value to be associated with the specified key.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.

remove

public V remove(java.lang.Object key)

Removes the mapping for this key from this map if it is present (optional operation).

Specified by:

remove in interface java.util.Map<K,V>

Parameters:

key - key whose mapping is to be removed from the map.

Returns:

previous value associated with specified key, or null if there was no mapping for key.

putAll

public void putAll(java.util.Map<? extends K,? extends V> t)

Copies all of the mappings from the specified map to this map (optional operation).

Specified by:

putAll in interface java.util.Map<K,V>

Parameters:

t - Mappings to be stored in this map.

clear

public void clear()

Removes all mappings from this map (optional operation).

Specified by:

clear in interface java.util.Map<K,V>

keySet

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

Returns a set view of the keys contained in this map.

Specified by:

keySet in interface java.util.Map<K,V>

Returns:

a set view of the keys contained in this map.

values

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

Returns a collection view of the values contained in this map.

Specified by:

values in interface java.util.Map<K,V>

Returns:

a collection view of the values contained in this map.

entrySet

public java.util.Set<java.util.Map.Entry<K,V>> entrySet()

Returns a set view of the mappings contained in this map.

Specified by:

entrySet in interface java.util.Map<K,V>

Returns:

a set view of the mappings contained in this map.

equals

public boolean equals(java.lang.Object o)

Compares the specified object with this map for equality.

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

Parameters:

o - object to be compared for equality with this map.

Returns:

true if the specified object is equal to this map.

hashCode

public int hashCode()

Returns the hash code value for this map.

Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this map.