Class EnrichableMap<K,V>

  extended by java.util.AbstractMap<K,V>
      extended by com.atlassian.confluence.api.model.reference.EnrichableMap<K,V>
All Implemented Interfaces:
NavigationAware, Map<K,V>

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


public Navigation.Builder resolveNavigation(NavigationService navigationService)
Specified by:
resolveNavigation in interface NavigationAware


public Set<Map.Entry<K,V>> entrySet()
Specified by:
entrySet in interface Map<K,V>
Specified by:
entrySet in class AbstractMap<K,V>


public Set<K> getCollapsedEntries()

Copyright © 2003–2015 Atlassian. All rights reserved.