com.atlassian.confluence.api.model.reference

Class ModelMapBuilder<K,V>

java.lang.Object

com.atlassian.confluence.api.model.reference.ModelMapBuilder<K,V>

public class ModelMapBuilder<K,V>
extends java.lang.Object

A Map builder for CollapsedMap and EnrichableMap instances.

The map built will be Collapsed unless put or addCollapsed methods are called. This class should be suitable for all Map usage in model Factories and Builders.

Method Summary

Methods

Modifier and Type	Method and Description
ModelMapBuilder<K,V>	addCollapsedEntries(java.util.Set<K> collapsedEntries)
ModelMapBuilder<K,V>	addCollapsedEntry(K key)
java.util.Map<K,V>	build() Build the map.
ModelMapBuilder<K,V>	copy(java.util.Map<K,V> map) Store CollapsedMap/NavMap but store values of other maps, including Enrichables.
static <K,V> ModelMapBuilder<K,V>	newInstance()
ModelMapBuilder<K,V>	put(K key, V value)
ModelMapBuilder<K,V>	putAll(java.util.Map<K,? extends V> map)

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static <K,V> ModelMapBuilder<K,V> newInstance()

put

public ModelMapBuilder<K,V> put(K key,
                       V value)

putAll

public ModelMapBuilder<K,V> putAll(java.util.Map<K,? extends V> map)

addCollapsedEntry

public ModelMapBuilder<K,V> addCollapsedEntry(K key)

addCollapsedEntries

public ModelMapBuilder<K,V> addCollapsedEntries(java.util.Set<K> collapsedEntries)

copy

public ModelMapBuilder<K,V> copy(@Nonnull
                        java.util.Map<K,V> map)

Store CollapsedMap/NavMap but store values of other maps, including Enrichables.

build

public java.util.Map<K,V> build()

Build the map. If an expanded map method has been called last on the builder, an EnrichableMap will be returned. If not, a CollapsedMap will be built.