com.goldencode.p2j.util

Class TailScopedDictionary<K,V>

java.lang.Object

com.goldencode.p2j.util.ScopedDictionary<K,V>

com.goldencode.p2j.util.TailScopedDictionary<K,V>

Type Parameters:

K - Dictionary key type

V - Dictionary value type

public class TailScopedDictionary<K,V>
extends ScopedDictionary<K,V>

A ScopedDictionary that contains TailMap collections. Supported scope: context local.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TailScopedDictionary.EmptyTailMap<K,V> An immutable empty static subclass of TailHashMap.

Nested classes/interfaces inherited from class com.goldencode.p2j.util.ScopedDictionary

ScopedDictionary.Node<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private static TailMap	EMPTY_TAILMAP EMPTY_TAILMAP is a singleton used for getDictionaryAtScope(int, boolean) when there is no dictionary at that level.

Constructor Summary

Constructors

Constructor and Description
TailScopedDictionary() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<K>	factoryHashSetFromMap() Factory method for a Set as returned by ScopedDictionary.keySet()
protected java.util.Map<K,java.lang.Boolean>	factoryIdentityHashMap() Factory method for an IdentityHashMap
protected java.util.Map<K,V>	factoryNodeHashMap(int size) Factory method for a HashMap at the scope items (the ScopedDictionary.Node inner class)
protected java.util.Map<K,V>	factoryNodeIdentityHashMap(int size) Factory method for an IdentityHashMap at the scope items (the ScopedDictionary.Node inner class)
TailMap<K,V>	getDictionaryAtScope(int scope, boolean create) Returns the dictionary from the scope specified, or null if the specified scope does not exist.

Methods inherited from class com.goldencode.p2j.util.ScopedDictionary

addEntry, addEntryAt, addScope, apply, clear, copyAll, deleteEntry, deleteScope, deleteScope, dump, dump, dumpCurrentScope, dumpCurrentScope, entrySet, entrySet, getIdentityKeys, getNodeAt, getScope, getScopeAt, getValueAtScope, keySet, keySet, locate, locate, lookup, lookup, lookup, removeEntryAtScope, removeEntryThroughScope, reverseLookup, reverseLookup, setIdentityKeys, setScope, setScopeAt, setValueAtScope, size, values, values

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_TAILMAP

private static final TailMap EMPTY_TAILMAP

EMPTY_TAILMAP is a singleton used for getDictionaryAtScope(int, boolean) when there is no dictionary at that level.

Constructor Detail

TailScopedDictionary

public TailScopedDictionary()

Default constructor.

Method Detail

getDictionaryAtScope

public TailMap<K,V> getDictionaryAtScope(int scope,
                                         boolean create)

Returns the dictionary from the scope specified, or null if the specified scope does not exist.

Overrides:

getDictionaryAtScope in class ScopedDictionary<K,V>

Parameters:

scope - The depth (in number of scopes from the top of the stack) at which the value must be set. Use -1 for the global scope.

create - true to create a dictionary for this scope if one does not already exist; false to have an empty (immutable) dictionary returned if one does not already exist.

Returns:

The dictionary, if any, associated with the specified scope. Note that this may be an immutable, empty map if no dictionary exists at this scope, and create is set to false. If the scope itself does not exist, then null is returned.

factoryIdentityHashMap

protected java.util.Map<K,java.lang.Boolean> factoryIdentityHashMap()

Factory method for an IdentityHashMap

Overrides:

factoryIdentityHashMap in class ScopedDictionary<K,V>

Returns:

a new TailIdentityHashMap

factoryHashSetFromMap

protected java.util.Set<K> factoryHashSetFromMap()

Factory method for a Set as returned by ScopedDictionary.keySet()

Currently, the caller can't yet access TailMap.flagIterating(), since a Set is returned. For now, we assume that it's not a realistic scenario in FWD. Redesign when needed (symptom would be a concurrency exception while iterating keySet).

Overrides:

factoryHashSetFromMap in class ScopedDictionary<K,V>

Returns:

The Set returned by Collections.newSetFromMap of a new TailHashMap

factoryNodeIdentityHashMap

protected java.util.Map<K,V> factoryNodeIdentityHashMap(int size)

Factory method for an IdentityHashMap at the scope items (the ScopedDictionary.Node inner class)

Overrides:

factoryNodeIdentityHashMap in class ScopedDictionary<K,V>

Parameters:

size - The maximum expected size of the Map

Returns:

a new TailIdentityHashMap

factoryNodeHashMap

protected java.util.Map<K,V> factoryNodeHashMap(int size)

Factory method for a HashMap at the scope items (the ScopedDictionary.Node inner class)

Overrides:

factoryNodeHashMap in class ScopedDictionary<K,V>

Parameters:

size - The maximum expected size of the Map

Returns:

a new TailHashMap