xyz.cofe.common

Class ListenersHelper<ListenerType,EventType>

java.lang.Object

xyz.cofe.common.ListenersHelper<ListenerType,EventType>

Type Parameters:

ListenerType - Тип издателья

EventType - Тип подписчика

public class ListenersHelper<ListenerType,EventType>
extends Object

Помошник в реализации Listener.
Обеспечивает синхронность при вызове методов:

• getListeners
• addListener
• removeListener
• fireEvent

Умеет хранить как hard так и soft ссылки на listener-ы

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected Func2<Object,ListenerType,EventType>	callListener Функция вызывающая listener.method( event );
protected HashSet<ListenerType>	listeners Hard ссылки на подписчиков
protected Lock	lock Объект по которому происходи синхронизация
protected WeakHashMap<ListenerType,Object>	weakListeners Soft/Weak ссылки на подписчиков

Constructor Summary

Constructors

Constructor and Description
ListenersHelper(Func2<Object,ListenerType,EventType> callListFunc) Конструктор.
ListenersHelper(Func2<Object,ListenerType,EventType> callListFunc, Lock sync) Конструктор.

Method Summary

Modifier and Type	Method and Description
void	addEvent(EventType ev) Добавляет событие в очередь
Closeable	addListener(ListenerType listener) Добавление подписчика.
Closeable	addListener(ListenerType listener, boolean weakLink) Добавление подписчика.
protected Lock	createLock() Создает блокировку ReentrantLock
void	fireEvent(EventType event) Рассылка уведомления подписчикам
void	fireEvents() Отправляет события из очереди подписчикам
ConcurrentLinkedQueue<EventType>	getEventQueue() Очередь событий
Set<ListenerType>	getListeners() Получение списка подписчиков
Lock	getLock()
boolean	hasListener(ListenerType listener) Проверка наличия подписчика в списке обработки
void	removeAllListeners()
void	removeListener(ListenerType listener) Удаление подписчика из списка обработки

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected Lock lock

Объект по которому происходи синхронизация

callListener

protected Func2<Object,ListenerType,EventType> callListener

Функция вызывающая listener.method( event );

listeners

protected HashSet<ListenerType> listeners

Hard ссылки на подписчиков

weakListeners

protected WeakHashMap<ListenerType,Object> weakListeners

Soft/Weak ссылки на подписчиков

Constructor Detail

ListenersHelper

public ListenersHelper(Func2<Object,ListenerType,EventType> callListFunc)

Конструктор. По умолчанию синхронизация включена, объект по которому происходит синх - this.

Parameters:

callListFunc - Функция вызывающая listener.method( event );

ListenersHelper

public ListenersHelper(Func2<Object,ListenerType,EventType> callListFunc,
                       Lock sync)

Конструктор.

Parameters:

callListFunc - Функция вызывающая listener.method( event );

sync - Синхронно производить вызовы

Method Detail

getLock

public Lock getLock()

createLock

protected Lock createLock()

Создает блокировку ReentrantLock

Returns:

блокировка

hasListener

public boolean hasListener(ListenerType listener)

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

Parameters:

listener - подписчик

Returns:

true - есть в списке обработки

getListeners

public Set<ListenerType> getListeners()

Получение списка подписчиков

Returns:

подписчики

addListener

public Closeable addListener(ListenerType listener)

Добавление подписчика.

Parameters:

listener - Подписчик.

Returns:

Интерфес для отсоединения подписчика

addListener

public Closeable addListener(ListenerType listener,
                             boolean weakLink)

Добавление подписчика.

Parameters:

listener - Подписчик.

weakLink - true - добавить как weak ссылку / false - как hard ссылку

Returns:

Интерфес для отсоединения подписчика

removeListener

public void removeListener(ListenerType listener)

Удаление подписчика из списка обработки

Parameters:

listener - подписчик

removeAllListeners

public void removeAllListeners()

fireEvent

public void fireEvent(EventType event)

Рассылка уведомления подписчикам

Parameters:

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

getEventQueue

public ConcurrentLinkedQueue<EventType> getEventQueue()

Очередь событий

Returns:

Очередь событий

addEvent

public void addEvent(EventType ev)

Добавляет событие в очередь

Parameters:

ev - событие

fireEvents

public void fireEvents()

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