com.atlassian.confluence.api.model.reference

Class EnrichableMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

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

All Implemented Interfaces:

NavigationAware, Map<K,V>

@Internal
public class EnrichableMap<K,V>
extends AbstractMap<K,V>
implements NavigationAware

A map with the RestEnrichable annotation, indicating that this map should be converted to a RestEntity and enriched by the REST stack.

This map can contains Collapsed entries - that is, it is aware of entry keys for which the value would be a collapsed reference. Collapsed entries cannot be retrieved with get() (which will throw an error), but the set of collapsed entries can be retrieved to identify which entries to add to the expandables map.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
Set<Map.Entry<K,V>>	entrySet()
Set<K>	getCollapsedEntries()
Navigation.Builder	resolveNavigation(NavigationService navigationService)

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Method Detail

resolveNavigation

public Navigation.Builder resolveNavigation(NavigationService navigationService)

Specified by:

resolveNavigation in interface NavigationAware

entrySet

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

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in class AbstractMap<K,V>

getCollapsedEntries

public Set<K> getCollapsedEntries()