xyz.cofe.collection.map

Class BasicEventMap<Key,Value>

java.lang.Object

xyz.cofe.collection.map.MapWrapper<Key,Value>

xyz.cofe.collection.map.BasicEventMap<Key,Value>

Type Parameters:

Key - Тип ключа

Value - Тип значения

All Implemented Interfaces:

Map<Key,Value>, EventMap<Key,Value>, EventMapSender<Key,Value>, GetListenersHelper

Direct Known Subclasses:

LockEventMap, SyncEventMap

public class BasicEventMap<Key,Value>
extends MapWrapper<Key,Value>
implements EventMap<Key,Value>, GetListenersHelper

Базовая карта с поддержкой событий измений данных карты

Author:

gocha

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected static LockMethod	clearMethod
protected static LockMethod	containsKeyMethod
protected static LockMethod	containsValueMethod
protected static LockMethod	entrySetMethod
protected Queue<KeyValueMapEvent<Key,Value>>	eventQueue Очередь сообщений
protected static LockMethod	getMethod
protected static LockMethod	getWrappedMapMethod
protected static LockMethod	isEmptyMethod
protected static LockMethod	keySetMethod
protected ListenersHelper<EventMapListener,MapEvent>	listeners
protected static LockMethod	putMethod
protected static LockMethod	setWrappedMapMethod
protected static LockMethod	sizeMethod
protected static LockMethod	valuesMethod

Constructor Summary

Constructors

Constructor and Description
BasicEventMap() Конструктор по умолчанию
BasicEventMap(Map<Key,Value> wrappedMap) Конструктор

Method Summary

Modifier and Type	Method and Description
Closeable	addEventMapListener(EventMapListener<Key,Value> listener) Добавляет подписчика измений
Closeable	addEventMapListener(EventMapListener<Key,Value> listener, boolean weakRef) Добавляет подписчика измений
protected void	addEventToQueue(KeyValueMapEvent<Key,Value> event) Добавляет уведомления в очередь с учетом блокировки
void	clear()
boolean	containsEventMapListener(EventMapListener<Key,Value> listener) Проверяет что указанный подписчик прослушивает изменения
boolean	containsKey(Object key)
boolean	containsValue(Object value)
protected DeletedMapEvent<Key,Value>	createDeleted(Key k, Value v) Создает уведомление о удалении
protected InsertedMapEvent<Key,Value>	createInserted(Key k, Value v) Создает уведомление о добавлении
protected UpdatedMapEvent<Key,Value>	createUpdated(Key k, Value v, Value old) Создает уведомление о обновление
Set<Map.Entry<Key,Value>>	entrySet()
protected void	fireDeleted(Key k, Value v) Сообщает о удалении ключа
protected void	fireEvent(MapEvent event) Увеомляет подписчиков о сообщении
protected void	fireInserted(Key k, Value v) Сообщает при добавлении ключа
protected void	fireQueueEvents() Выполняет уведомления из очереди с учетем блокировки
protected void	fireUpdated(Key k, Value v, Value old) Сообщает о измении ключа
Value	get(Object key)
ListenersHelper	getListenersHelper()
Lock	getListenersLock() Возвращает блокировку на listeners методы
Map<Key,Value>	getWrappedMap() Возвращает исходную карту
boolean	isEmpty()
Set<Key>	keySet()
protected boolean	listenObjectChanged()
protected Object	lockRun(Func0 run) Выполнение кода в блокировке
protected Object	lockRun(Func0 run, LockMethod method) Выполнение кода в блокировке
Closeable	onChanged(Func3<Object,? super Key,? super Value,? super Value> fn) Добавляет подписчика на изменения
Closeable	onChanged(Func3<Object,? super Key,? super Value,? super Value> fn, boolean weak) Добавляет подписчика на изменения
Closeable	onDeleted(Func3<Object,? super Key,? super Value,? super Value> fn) Добавляет подписчика только на удаление из карты
Closeable	onDeleted(Func3<Object,? super Key,? super Value,? super Value> fn, boolean weak) Добавляет подписчика только на удаление из карты
Closeable	onInserted(Func3<Object,? super Key,? super Value,? super Value> fn) Добавляет подписчика только на добавление в карту
Closeable	onInserted(Func3<Object,? super Key,? super Value,? super Value> fn, boolean weak) Добавляет подписчика только на добавление в карту
Closeable	onUpdated(Func3<Object,? super Key,? super Value,? super Value> fn) Добавляет подписчика только на изменение значения в карте, не добавление, ни удаление
Closeable	onUpdated(Func3<Object,? super Key,? super Value,? super Value> fn, boolean weak) Добавляет подписчика только на изменение значения в карте, не добавление, ни удаление
Value	put(Key key, Value value)
void	putAll(Map<? extends Key,? extends Value> m)
Value	remove(Object key)
void	removeEventMapListener(EventMapListener<Key,Value> listener) Удаляет подписчика измений
protected boolean	sendNewListOnNewWrapperMap() Генерировать события Insert/Delete при вызове setWrappedMap
void	setWrappedMap(Map<Key,Value> wrappedMap) Устанавливает новую карту
int	size()
Collection<Value>	values()

Methods inherited from class xyz.cofe.collection.map.MapWrapper

equals

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

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

Field Detail

eventQueue

protected final Queue<KeyValueMapEvent<Key,Value>> eventQueue

Очередь сообщений

listeners

protected final ListenersHelper<EventMapListener,MapEvent> listeners

clearMethod

protected static final LockMethod clearMethod

putMethod

protected static final LockMethod putMethod

setWrappedMapMethod

protected static final LockMethod setWrappedMapMethod

isEmptyMethod

protected static final LockMethod isEmptyMethod

containsKeyMethod

protected static final LockMethod containsKeyMethod

containsValueMethod

protected static final LockMethod containsValueMethod

entrySetMethod

protected static final LockMethod entrySetMethod

getMethod

protected static final LockMethod getMethod

keySetMethod

protected static final LockMethod keySetMethod

sizeMethod

protected static final LockMethod sizeMethod

valuesMethod

protected static final LockMethod valuesMethod

getWrappedMapMethod

protected static final LockMethod getWrappedMapMethod

Constructor Detail

BasicEventMap

public BasicEventMap()

Конструктор по умолчанию

BasicEventMap

public BasicEventMap(Map<Key,Value> wrappedMap)

Конструктор

Parameters:

wrappedMap - Исходная карта

Method Detail

getListenersLock

public Lock getListenersLock()

Возвращает блокировку на listeners методы

Returns:

блокировка на методы listeners или null

listenObjectChanged

protected boolean listenObjectChanged()

addEventToQueue

protected void addEventToQueue(KeyValueMapEvent<Key,Value> event)

Добавляет уведомления в очередь с учетом блокировки

Parameters:

event - уведомления

fireQueueEvents

protected void fireQueueEvents()

Выполняет уведомления из очереди с учетем блокировки

getListenersHelper

public ListenersHelper getListenersHelper()

Specified by:

getListenersHelper in interface GetListenersHelper

addEventMapListener

public Closeable addEventMapListener(EventMapListener<Key,Value> listener)

Description copied from interface: EventMapSender

Добавляет подписчика измений

Specified by:

addEventMapListener in interface EventMapSender<Key,Value>

Parameters:

listener - Подписчик

Returns:

Обработчик закрытия/отписки от уведомлений

addEventMapListener

public Closeable addEventMapListener(EventMapListener<Key,Value> listener,
                                     boolean weakRef)

Description copied from interface: EventMapSender

Добавляет подписчика измений

Specified by:

addEventMapListener in interface EventMapSender<Key,Value>

Parameters:

listener - Подписчик

weakRef - Добавить подписчика как weak ссылку

Returns:

Обработчик закрытия/отписки от уведомлений

removeEventMapListener

public void removeEventMapListener(EventMapListener<Key,Value> listener)

Description copied from interface: EventMapSender

Удаляет подписчика измений

Specified by:

removeEventMapListener in interface EventMapSender<Key,Value>

Parameters:

listener - Подписчик

containsEventMapListener

public boolean containsEventMapListener(EventMapListener<Key,Value> listener)

Description copied from interface: EventMapSender

Проверяет что указанный подписчик прослушивает изменения

Specified by:

containsEventMapListener in interface EventMapSender<Key,Value>

Parameters:

listener - Подписчик

Returns:

true - подписчик подписан на события

onChanged

public Closeable onChanged(Func3<Object,? super Key,? super Value,? super Value> fn)

Description copied from interface: EventMapSender

Добавляет подписчика на изменения

Specified by:

onChanged in interface EventMapSender<Key,Value>

Parameters:

fn - Функция(Key ключ, Value староеЗначение, Value новоеЗначение):Object

Если новоеЗначение != null и староеЗначение != null - значение в карте обновленно.

Если новоеЗначение != null и староеЗначение == null - добавлено значение в карту.

Если новоеЗначение == null и староеЗначение != null - удалено значение из карты.

Returns:

Обработчик закрытия/отписки от уведомлений

onChanged

public Closeable onChanged(Func3<Object,? super Key,? super Value,? super Value> fn,
                           boolean weak)

Description copied from interface: EventMapSender

Добавляет подписчика на изменения

Specified by:

onChanged in interface EventMapSender<Key,Value>

Parameters:

fn - Функция(Key ключ, Value староеЗначение, Value новоеЗначение):Object

Если новоеЗначение != null и староеЗначение != null - значение в карте обновленно.

Если новоеЗначение != null и староеЗначение == null - добавлено значение в карту.

Если новоеЗначение == null и староеЗначение != null - удалено значение из карты.

weak - Добавить подписчика как weak ссылку

Returns:

Обработчик закрытия/отписки от уведомлений

onUpdated

public Closeable onUpdated(Func3<Object,? super Key,? super Value,? super Value> fn)

Description copied from interface: EventMapSender

Добавляет подписчика только на изменение значения в карте, не добавление, ни удаление

Specified by:

onUpdated in interface EventMapSender<Key,Value>

Parameters:

fn - Функция(Key ключ, Value староеЗначение, Value новоеЗначение):Object

новоеЗначение != null и староеЗначение != null - значение в карте обновленно.

Returns:

Обработчик закрытия/отписки от уведомлений

onUpdated

public Closeable onUpdated(Func3<Object,? super Key,? super Value,? super Value> fn,
                           boolean weak)

Description copied from interface: EventMapSender

Добавляет подписчика только на изменение значения в карте, не добавление, ни удаление

Specified by:

onUpdated in interface EventMapSender<Key,Value>

Parameters:

fn - Функция(Key ключ, Value староеЗначение, Value новоеЗначение):Object

новоеЗначение != null и староеЗначение != null - значение в карте обновленно.

weak - Добавить подписчика как weak ссылку

Returns:

Обработчик закрытия/отписки от уведомлений

onInserted

public Closeable onInserted(Func3<Object,? super Key,? super Value,? super Value> fn)

Description copied from interface: EventMapSender

Добавляет подписчика только на добавление в карту

Specified by:

onInserted in interface EventMapSender<Key,Value>

Parameters:

fn - Функция(Key ключ, Value староеЗначение, Value новоеЗначение):Object

Если новоеЗначение != null и староеЗначение == null - добавлено значение в карту.

Returns:

Обработчик закрытия/отписки от уведомлений

onInserted

public Closeable onInserted(Func3<Object,? super Key,? super Value,? super Value> fn,
                            boolean weak)

Description copied from interface: EventMapSender

Добавляет подписчика только на добавление в карту

Specified by:

onInserted in interface EventMapSender<Key,Value>

Parameters:

fn - Функция(Key ключ, Value староеЗначение, Value новоеЗначение):Object

Если новоеЗначение != null и староеЗначение == null - добавлено значение в карту.

weak - Добавить подписчика как weak ссылку

Returns:

Обработчик закрытия/отписки от уведомлений

onDeleted

public Closeable onDeleted(Func3<Object,? super Key,? super Value,? super Value> fn)

Description copied from interface: EventMapSender

Добавляет подписчика только на удаление из карты

Specified by:

onDeleted in interface EventMapSender<Key,Value>

Parameters:

fn - Функция(Key ключ, Value староеЗначение, Value новоеЗначение):Object

Если новоеЗначение == null и староеЗначение != null - удалено значение из карты.

Returns:

Обработчик закрытия/отписки от уведомлений

onDeleted

public Closeable onDeleted(Func3<Object,? super Key,? super Value,? super Value> fn,
                           boolean weak)

Description copied from interface: EventMapSender

Добавляет подписчика только на удаление из карты

Specified by:

onDeleted in interface EventMapSender<Key,Value>

Parameters:

fn - Функция(Key ключ, Value староеЗначение, Value новоеЗначение):Object

Если новоеЗначение == null и староеЗначение != null - удалено значение из карты.

weak - Добавить подписчика как weak ссылку

Returns:

Обработчик закрытия/отписки от уведомлений

fireEvent

protected void fireEvent(MapEvent event)

Увеомляет подписчиков о сообщении

Parameters:

event - Событие

fireDeleted

protected void fireDeleted(Key k,
                           Value v)

Сообщает о удалении ключа

Parameters:

k - Ключ

v - Значение

createDeleted

protected DeletedMapEvent<Key,Value> createDeleted(Key k,
                                                   Value v)

Создает уведомление о удалении

Parameters:

k - ключ

v - значение

Returns:

уведомление

fireInserted

protected void fireInserted(Key k,
                            Value v)

Сообщает при добавлении ключа

Parameters:

k - Ключ

v - Значение

createInserted

protected InsertedMapEvent<Key,Value> createInserted(Key k,
                                                     Value v)

Создает уведомление о добавлении

Parameters:

k - ключ

v - значение

Returns:

уведомление

fireUpdated

protected void fireUpdated(Key k,
                           Value v,
                           Value old)

Сообщает о измении ключа

Parameters:

k - Ключ

v - Новое значение

old - Старое значение

createUpdated

protected UpdatedMapEvent<Key,Value> createUpdated(Key k,
                                                   Value v,
                                                   Value old)

Создает уведомление о обновление

Parameters:

k - ключ

v - новое значение

old - старое значение

Returns:

уведомление

lockRun

protected Object lockRun(Func0 run)

Выполнение кода в блокировке

Parameters:

run - код-функция

Returns:

Результат функции

lockRun

protected Object lockRun(Func0 run,
                         LockMethod method)

Выполнение кода в блокировке

Parameters:

run - код

method - метод map для которого вызывается блокировка

Returns:

Результат функции

clear

public void clear()

Specified by:

clear in interface Map<Key,Value>

Overrides:

clear in class MapWrapper<Key,Value>

put

public Value put(Key key,
                 Value value)

Specified by:

put in interface Map<Key,Value>

Overrides:

put in class MapWrapper<Key,Value>

putAll

public void putAll(Map<? extends Key,? extends Value> m)

Specified by:

putAll in interface Map<Key,Value>

Overrides:

putAll in class MapWrapper<Key,Value>

remove

public Value remove(Object key)

Specified by:

remove in interface Map<Key,Value>

Overrides:

remove in class MapWrapper<Key,Value>

sendNewListOnNewWrapperMap

protected boolean sendNewListOnNewWrapperMap()

Генерировать события Insert/Delete при вызове setWrappedMap

Returns:

true (по умолч) - генерация событий.

setWrappedMap

public void setWrappedMap(Map<Key,Value> wrappedMap)

Устанавливает новую карту

Overrides:

setWrappedMap in class MapWrapper<Key,Value>

Parameters:

wrappedMap - карта

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Key,Value>

Overrides:

isEmpty in class MapWrapper<Key,Value>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<Key,Value>

Overrides:

containsKey in class MapWrapper<Key,Value>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<Key,Value>

Overrides:

containsValue in class MapWrapper<Key,Value>

entrySet

public Set<Map.Entry<Key,Value>> entrySet()

Specified by:

entrySet in interface Map<Key,Value>

Overrides:

entrySet in class MapWrapper<Key,Value>

get

public Value get(Object key)

Specified by:

get in interface Map<Key,Value>

Overrides:

get in class MapWrapper<Key,Value>

keySet

public Set<Key> keySet()

Specified by:

keySet in interface Map<Key,Value>

Overrides:

keySet in class MapWrapper<Key,Value>

size

public int size()

Specified by:

size in interface Map<Key,Value>

Overrides:

size in class MapWrapper<Key,Value>

values

public Collection<Value> values()

Specified by:

values in interface Map<Key,Value>

Overrides:

values in class MapWrapper<Key,Value>

getWrappedMap

public Map<Key,Value> getWrappedMap()

Description copied from class: MapWrapper

Возвращает исходную карту

Overrides:

getWrappedMap in class MapWrapper<Key,Value>

Returns:

Исходная карта