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 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

ModelMapBuilder<K,V>	addCollapsedEntries(Set<K> collapsedEntries)
ModelMapBuilder<K,V>	addCollapsedEntry(K key)
Map<K,V>	build() Build the map.
protected com.google.common.collect.ImmutableMap	buildDelegate()
ModelMapBuilder<K,V>	copy(Map<K,V> map) Store CollapsedMap/NavMap but store values of other maps, including Enrichables.
ModelMapBuilder<K,V>	navigable(Navigation.Builder navBuilder)
static <K,V> ModelMapBuilder<K,V>	newExpandedInstance()
static <K,V> ModelMapBuilder<K,V>	newInstance()
static <K,V> ModelMapBuilder<K,V>	newInstance(Map<K,V> map)
ModelMapBuilder<K,V>	put(K key, V value)
ModelMapBuilder<K,V>	putAll(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()

newInstance

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

newExpandedInstance

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

put

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

putAll

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

addCollapsedEntry

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

addCollapsedEntries

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

copy

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

Store CollapsedMap/NavMap but store values of other maps, including Enrichables. Replaces any existing contents in this builder with the contents of the map

navigable

public ModelMapBuilder<K,V> navigable(Navigation.Builder navBuilder)

build

public 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.

buildDelegate

protected com.google.common.collect.ImmutableMap buildDelegate()