jmri.util

Class PropertyChangeEventQueue

Show UML class diagram

java.lang.Object

jmri.util.PropertyChangeEventQueue

@ThreadSafe
public class PropertyChangeEventQueue
extends Object

Gathers PropertyChangeEvents that might occur in overlapping threads and at overlapping times, presenting them as requested.

Listeners are installed when the object is constructed. dispose() detaches those listeners, after which the object should not be used. It is not an error to call dispose() multiple times.

Although this could be more generic than NamedBean, there's no single interface that specifies "can call addPropertyChangeListener(..)".

Constructor Summary

Constructors

Constructor and Description
PropertyChangeEventQueue(Collection<NamedBean> collection)
PropertyChangeEventQueue(NamedBean[] array)

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose by dropping the listeners to all the specified NamedBeans.
PropertyChangeEvent	poll(long timeout, TimeUnit unit)
PropertyChangeEvent	take()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyChangeEventQueue

public PropertyChangeEventQueue(@Nonnull
                                Collection<NamedBean> collection)

Parameters:

collection - Set of NamedBeans whose events should be handled. Keeps a copy of the contents, so future changes irrelevant.

PropertyChangeEventQueue

public PropertyChangeEventQueue(@Nonnull
                                NamedBean[] array)

Parameters:

array - Set of NamedBeans whose events should be handled Keeps a copy of the contents, so future changes irrelevant.

Method Detail

dispose

public void dispose()

Dispose by dropping the listeners to all the specified NamedBeans. The object should not be used again after calling this. It is not an error to call this multiple times.

take

public PropertyChangeEvent take()
                         throws InterruptedException

Throws:

InterruptedException

poll

public PropertyChangeEvent poll(long timeout,
                                TimeUnit unit)
                         throws InterruptedException

Throws:

InterruptedException

toString

public String toString()

Overrides:

toString in class Object