com.flowpowered.nbt

Class CompoundMap

java.lang.Object

com.flowpowered.nbt.CompoundMap

All Implemented Interfaces:

Iterable<Tag<?>>, Map<String,Tag<?>>

public class CompoundMap
extends Object
implements Map<String,Tag<?>>, Iterable<Tag<?>>

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CompoundMap() Creates an empty CompoundMap backed by a HashMap.
CompoundMap(boolean sort, boolean reverse) Creates an empty CompoundMap.
CompoundMap(CompoundMap initial) Creates a CompoundMap using the same element ordering rules as in the given CompoundMap. The map is initialised using the values given in the CompoundMap.
CompoundMap(HashMap<String,Tag<?>> initial) Deprecated.
CompoundMap(Iterable<Tag<?>> initial, boolean sort, boolean reverse) Creates an empty CompoundMap which is initialised using the given values
CompoundMap(List<Tag<?>> initial) Creates a CompoundMap back by a LinkedHashMap, so insertion order is preserved. The map is initialised using the values given in the List.
CompoundMap(Map<String,Tag<?>> initial) Creates a CompoundMap back by a LinkedHashMap, so insertion order is preserved. The map is initialised using the values given in the Map.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,Tag<?>>>	entrySet()
boolean	equals(Object o)
Tag<?>	get(Object key)
boolean	isEmpty()
Iterator<Tag<?>>	iterator()
Set<String>	keySet()
Tag<?>	put(String key, Tag<?> value)
Tag<?>	put(Tag<?> tag) Puts a tag in this map, getting the string from the tag
void	putAll(Map<? extends String,? extends Tag<?>> values)
Tag	remove(Object key)
int	size()
Collection<Tag<?>>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CompoundMap

public CompoundMap()

Creates an empty CompoundMap backed by a HashMap.

CompoundMap

public CompoundMap(List<Tag<?>> initial)

Creates a CompoundMap back by a LinkedHashMap, so insertion order is preserved.

The map is initialised using the values given in the List.

Parameters:

initial - the initial values for the CompoundMap

CompoundMap

public CompoundMap(Map<String,Tag<?>> initial)

Creates a CompoundMap back by a LinkedHashMap, so insertion order is preserved.

The map is initialised using the values given in the Map.

Parameters:

initial - the initial values for the CompoundMap

CompoundMap

@Deprecated
public CompoundMap(HashMap<String,Tag<?>> initial)

Deprecated.

Creates a CompoundMap back by a LinkedHashMap, so insertion order is preserved.

The map is initialised using the values given in the HashMap. The constructor is included for backward compatibility, it is recommended to use the one that takes Map instead.

Parameters:

initial - the initial values for the CompoundMap

CompoundMap

public CompoundMap(CompoundMap initial)

Creates a CompoundMap using the same element ordering rules as in the given CompoundMap.

The map is initialised using the values given in the CompoundMap.

Parameters:

initial - the initial values for the CompoundMap

CompoundMap

public CompoundMap(boolean sort,
                   boolean reverse)

Creates an empty CompoundMap.

Parameters:

sort - elements are ordered in alphabetical ordering

reverse - elements are ordered in reverse alphabetical ordering, when sort is true

CompoundMap

public CompoundMap(Iterable<Tag<?>> initial,
                   boolean sort,
                   boolean reverse)

Creates an empty CompoundMap which is initialised using the given values

Parameters:

initial - the initial values

sort - elements are ordered in alphabetical ordering

reverse - elements are ordered in reverse alphabetical ordering, when sort is true

Method Detail

put

public Tag<?> put(Tag<?> tag)

Puts a tag in this map, getting the string from the tag

Parameters:

tag - to add

Returns:

the previous value

clear

public void clear()

Specified by:

clear in interface Map<String,Tag<?>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Tag<?>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Tag<?>>

entrySet

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

Specified by:

entrySet in interface Map<String,Tag<?>>

get

public Tag<?> get(Object key)

Specified by:

get in interface Map<String,Tag<?>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Tag<?>>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Tag<?>>

put

public Tag<?> put(String key,
                  Tag<?> value)

Specified by:

put in interface Map<String,Tag<?>>

putAll

public void putAll(Map<? extends String,? extends Tag<?>> values)

Specified by:

putAll in interface Map<String,Tag<?>>

remove

public Tag remove(Object key)

Specified by:

remove in interface Map<String,Tag<?>>

size

public int size()

Specified by:

size in interface Map<String,Tag<?>>

values

public Collection<Tag<?>> values()

Specified by:

values in interface Map<String,Tag<?>>

iterator

public Iterator<Tag<?>> iterator()

Specified by:

iterator in interface Iterable<Tag<?>>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,Tag<?>>

Overrides:

equals in class Object