com.avaje.ebean.common

Class BeanMap<K,E>

java.lang.Object

com.avaje.ebean.common.AbstractBeanCollection<E>

com.avaje.ebean.common.BeanMap<K,E>

All Implemented Interfaces:

BeanCollection<E>, Serializable, Map<K,E>

public final class BeanMap<K,E>
extends AbstractBeanCollection<E>
implements Map<K,E>

Map capable of lazy loading.

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Nested classes/interfaces inherited from interface com.avaje.ebean.bean.BeanCollection

BeanCollection.ModifyListenMode

Field Summary

Fields inherited from class com.avaje.ebean.common.AbstractBeanCollection

beanCollectionTouched, ebeanServerName, filterMany, loader, modifyAddListening, modifyHolder, modifyListening, modifyListenMode, modifyRemoveListening, ownerBean, propertyName, readOnly, registeredWithLoadContext, touched

Constructor Summary

Constructors

Constructor and Description
BeanMap() Create using a underlying LinkedHashMap.
BeanMap(BeanCollectionLoader ebeanServer, EntityBean ownerBean, String propertyName)
BeanMap(Map<K,E> map) Create with a given Map.

Method Summary

Modifier and Type	Method and Description
boolean	checkEmptyLazyLoad() Check after the lazy load that the underlying collection is not null (handle case where join to many not outer).
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,E>>	entrySet()
boolean	equals(Object obj) Equal if obj is a Map and equal in a Map sense.
E	get(Object key)
Collection<E>	getActualDetails() Returns the collection of beans (map values).
Collection<?>	getActualEntries() Returns the map entrySet.
Map<K,E>	getActualMap() Return the actual underlying map.
int	hashCode()
void	internalAdd(Object bean) Add the bean to the collection.
void	internalPut(Object key, Object bean)
void	internalPutNull()
boolean	isEmpty() Return true if the List Set or Map is empty.
boolean	isEmptyAndUntouched() Return true if the collection is empty and untouched.
boolean	isPopulated() Return true if the underlying map has been populated.
boolean	isReference() Return true if this is a reference (lazy loading) bean collection.
Set<K>	keySet()
E	put(K key, E value)
void	putAll(Map<? extends K,? extends E> puts)
E	remove(Object key)
void	reset(EntityBean ownerBean, String propertyName) Reset the collection back to an empty state ready for reloading.
void	setActualMap(Map<?,?> map) Set the actual underlying map.
int	size() Return the number of elements in the List Set or Map.
String	toString()
Collection<E>	values()

Methods inherited from class com.avaje.ebean.common.AbstractBeanCollection

checkReadOnly, getFilterMany, getModifyAdditions, getModifyHolder, getModifyListenMode, getModifyRemovals, getOwnerBean, getPropertyName, isReadOnly, isRegisteredWithLoadContext, lazyLoadCollection, modifyAddition, modifyRemoval, modifyReset, setBeanCollectionTouched, setFilterMany, setLoader, setModifyListening, setReadOnly, touched

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

BeanMap

public BeanMap(Map<K,E> map)

Create with a given Map.

BeanMap

public BeanMap()

Create using a underlying LinkedHashMap.

BeanMap

public BeanMap(BeanCollectionLoader ebeanServer,
               EntityBean ownerBean,
               String propertyName)

Method Detail

reset

public void reset(EntityBean ownerBean,
                  String propertyName)

Description copied from interface: BeanCollection

Reset the collection back to an empty state ready for reloading.

This is done as part of bean refresh.

Specified by:

reset in interface BeanCollection<E>

isEmptyAndUntouched

public boolean isEmptyAndUntouched()

Description copied from interface: BeanCollection

Return true if the collection is empty and untouched. Used to detect if a collection was 'cleared' deliberately or just un-initialised.

Specified by:

isEmptyAndUntouched in interface BeanCollection<E>

internalPutNull

public void internalPutNull()

internalPut

public void internalPut(Object key,
                        Object bean)

internalAdd

public void internalAdd(Object bean)

Description copied from interface: BeanCollection

Add the bean to the collection.

This is disallowed for BeanMap.

Specified by:

internalAdd in interface BeanCollection<E>

isPopulated

public boolean isPopulated()

Return true if the underlying map has been populated. Returns false if it has a deferred fetch pending.

Specified by:

isPopulated in interface BeanCollection<E>

isReference

public boolean isReference()

Return true if this is a reference (lazy loading) bean collection. This is the same as !isPopulated();

Specified by:

isReference in interface BeanCollection<E>

checkEmptyLazyLoad

public boolean checkEmptyLazyLoad()

Description copied from interface: BeanCollection

Check after the lazy load that the underlying collection is not null (handle case where join to many not outer).

That is, if the collection was not loaded due to filterMany predicates etc then make sure the collection is set to empty.

Specified by:

checkEmptyLazyLoad in interface BeanCollection<E>

setActualMap

public void setActualMap(Map<?,?> map)

Set the actual underlying map. Used for performing lazy fetch.

getActualMap

public Map<K,E> getActualMap()

Return the actual underlying map.

getActualDetails

public Collection<E> getActualDetails()

Returns the collection of beans (map values).

Specified by:

getActualDetails in interface BeanCollection<E>

getActualEntries

public Collection<?> getActualEntries()

Returns the map entrySet.

This is because the key values may need to be set against the details (so they don't need to be set twice).

Specified by:

getActualEntries in interface BeanCollection<E>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Equal if obj is a Map and equal in a Map sense.

Specified by:

equals in interface Map<K,E>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,E>

Overrides:

hashCode in class Object

clear

public void clear()

Specified by:

clear in interface Map<K,E>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,E>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,E>

entrySet

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

Specified by:

entrySet in interface Map<K,E>

get

public E get(Object key)

Specified by:

get in interface Map<K,E>

isEmpty

public boolean isEmpty()

Description copied from interface: BeanCollection

Return true if the List Set or Map is empty.

Specified by:

isEmpty in interface BeanCollection<E>

Specified by:

isEmpty in interface Map<K,E>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,E>

put

public E put(K key,
             E value)

Specified by:

put in interface Map<K,E>

putAll

public void putAll(Map<? extends K,? extends E> puts)

Specified by:

putAll in interface Map<K,E>

remove

public E remove(Object key)

Specified by:

remove in interface Map<K,E>

size

public int size()

Description copied from interface: BeanCollection

Return the number of elements in the List Set or Map.

Specified by:

size in interface BeanCollection<E>

Specified by:

size in interface Map<K,E>

values

public Collection<E> values()

Specified by:

values in interface Map<K,E>