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:

java.util.Map<K,V>

@Internal
public class EnrichableMap<K,V>
extends java.util.AbstractMap<K,V>

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

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

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

java.util.Map.Entry<K,V>

Method Summary

java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
java.util.Set<K>	getCollapsedEntries()

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

entrySet

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

Specified by:

entrySet in interface java.util.Map<K,V>

Specified by:

entrySet in class java.util.AbstractMap<K,V>

getCollapsedEntries

public java.util.Set<K> getCollapsedEntries()