com.simplifiedlogic.nitro.jshell.json.help

Class OrderedMap<K,V>

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.help.OrderedMap<K,V>

Type Parameters:

K - The data type for keys in the map

V - The data type for entries in the map

All Implemented Interfaces:

java.util.Map<K,V>

public class OrderedMap<K,V>
extends java.lang.Object
implements java.util.Map<K,V>

This is an implementation of java.util.Map. Its primary function is that when you iterate through the keys or values in the Map, they are accessed in the same order that the objects were originally added to the Map. If an existing key value is updated, then it is moved to the bottom of the ordering.

This is accomplished by storing the key values separately from the internal Map, in an ordered List object.

Since you normally don't care what order that entries are stored in within a Map, this is intended primarily for creating JSON help documentation, where keeping a consistent order of fields makes it easier for the reader to understand.

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
OrderedMap() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
V	get(java.lang.Object key)
boolean	isEmpty()
java.util.Set<K>	keySet()
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> m)
V	remove(java.lang.Object key)
int	size()
java.util.Collection<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

OrderedMap

public OrderedMap()

Default constructor

Method Detail

clear

public void clear()

Specified by:

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

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

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

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

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

entrySet

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

Specified by:

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

get

public V get(java.lang.Object key)

Specified by:

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

isEmpty

public boolean isEmpty()

Specified by:

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

keySet

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

Specified by:

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

put

public V put(K key,
    V value)

Specified by:

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

putAll

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

Specified by:

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

remove

public V remove(java.lang.Object key)

Specified by:

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

size

public int size()

Specified by:

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

values

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

Specified by:

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