org.rendersnake.internal

Class StackedMap

java.lang.Object

org.rendersnake.internal.StackedMap

All Implemented Interfaces:

Map<String,Object>

public class StackedMap
extends Object
implements Map<String,Object>

A nested hash-based Map implementation. If an entry is not found in the map at nesting level N then retry in map N-1, if N >= 0; return null otherwise.

Author:

ernestmicklei

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static int	INITIAL_MAP_CAPACITY

Constructor Summary

Constructors

Constructor and Description
StackedMap() Constructs an empty StackedMap.
StackedMap(Map<? extends String,? extends Object> m) Constructs a new StackedMap with the same mappings as the specified Map.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,Object>>	entrySet()
boolean	equals(Object otherMap)
Object	get(Object key)
int	getDepth() Returns the depth of the stack.
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()
void	pop() Decreases the depth of the stack of maps, effectively removing all mappings at the current level.
void	push() Increases the depth of the stack of maps.
Object	put(String key, Object value)
void	putAll(Map<? extends String,? extends Object> m)
Object	remove(Object key)
int	size()
String	toString() for debugging
Collection<Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Field Detail

INITIAL_MAP_CAPACITY

public static int INITIAL_MAP_CAPACITY

Constructor Detail

StackedMap

public StackedMap()

Constructs an empty StackedMap.

StackedMap

public StackedMap(Map<? extends String,? extends Object> m)

Constructs a new StackedMap with the same mappings as the specified Map. The mappings will be created at depth 0.

Parameters:

m - the Map whose mappings are to be placed in this Map, cannot be null.

Throws:

IllegalArgumentException - if m == null.

Method Detail

push

public void push()

Increases the depth of the stack of maps. From now on all put(String,Object) operations will store the mappings at the higher depth.

Note that pop() will make all mappings at the current depth unavailable.

pop

public void pop()

Decreases the depth of the stack of maps, effectively removing all mappings at the current level. From now on all put(String,Object) operations will store the mappings at the lower depth.

Note that push() will create a higher depth.

Throws:

IllegalStateException - if getDepth() == 0.

getDepth

public int getDepth()

Returns the depth of the stack.

Returns:

the depth of the stack, always >= 0.

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

entrySet

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

Specified by:

entrySet in interface Map<String,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

putAll

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

Specified by:

putAll in interface Map<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

size

public int size()

Specified by:

size in interface Map<String,Object>

values

public Collection<Object> values()

Specified by:

values in interface Map<String,Object>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class Object

Returns:

the hash of the receiver

equals

public boolean equals(Object otherMap)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class Object

Returns:

whether the contents of otherMap equals to that of the receiver

toString

public String toString()

for debugging

Overrides:

toString in class Object