Package org.apache.pivot.util

Class ListenerList<T>

java.lang.Object

org.apache.pivot.util.ListenerList<T>

Type Parameters:

T - The listener type contained in this list.

All Implemented Interfaces:

java.lang.Iterable<T>

Direct Known Subclasses:

AccordionAttributeListener.Listeners, AccordionListener.Listeners, AccordionSelectionListener.Listeners, ActionClassListener.Listeners, ActionListener.Listeners, ActivityIndicatorListener.Listeners, AlertListener.Listeners, BlockListener.Listeners, BorderListener.Listeners, BoxPaneListener.Listeners, BulletedListListener.Listeners, ButtonBindingListener.Listeners, ButtonGroupListener.Listeners, ButtonListener.Listeners, ButtonPressListener.Listeners, ButtonStateListener.Listeners, CalendarBindingListener.Listeners, CalendarButtonBindingListener.Listeners, CalendarButtonListener.Listeners, CalendarButtonSelectionListener.Listeners, CalendarListener.Listeners, CalendarSelectionListener.Listeners, CardPaneListener.Listeners, ChartViewCategoryListener.Listeners, ChartViewListener.Listeners, ChartViewSeriesListener.Listeners, ColorChooserBindingListener.Listeners, ColorChooserButtonBindingListener.Listeners, ColorChooserButtonSelectionListener.Listeners, ColorChooserSelectionListener.Listeners, ComponentClassListener.Listeners, ComponentDataListener.Listeners, ComponentDecoratorListener.Listeners, ComponentKeyListener.Listeners, ComponentListener.Listeners, ComponentMouseButtonListener.Listeners, ComponentMouseListener.Listeners, ComponentMouseWheelListener.Listeners, ComponentNodeListener.Listeners, ComponentStateListener.Listeners, ComponentStyleListener.Listeners, ComponentTooltipListener.Listeners, ContainerListener.Listeners, ContainerMouseListener.Listeners, CSVSerializerListener.Listeners, DialogListener.Listeners, DialogStateListener.Listeners, ElementListener.Listeners, ElementListener.Listeners, ExpanderListener.Listeners, FileBrowserListener.Listeners, FileBrowserSheetListener.Listeners, FillPaneListener.Listeners, FormAttributeListener.Listeners, FormListener.Listeners, FrameListener.Listeners, GaugeListener.Listeners, GridPaneListener.Listeners, ImageListener.Listeners, ImageNodeListener.Listeners, ImageViewBindingListener.Listeners, ImageViewListener.Listeners, JSONSerializerListener.Listeners, LabelBindingListener.Listeners, LabelListener.Listeners, List.ListListenerList, ListButtonBindingListener.Listeners, ListButtonItemListener.Listeners, ListButtonListener.Listeners, ListButtonSelectionListener.Listeners, ListViewBindingListener.Listeners, ListViewItemListener.Listeners, ListViewItemStateListener.Listeners, ListViewListener.Listeners, ListViewSelectionListener.Listeners, MapListener.Listeners, Menu.ItemListener.Listeners, Menu.SectionListener.Listeners, MenuBar.ItemListener.Listeners, MenuBarListener.Listeners, MenuButtonListener.Listeners, MenuItemSelectionListener.Listeners, MenuListener.Listeners, MenuPopupListener.Listeners, MenuPopupStateListener.Listeners, MeterListener.Listeners, MovieListener.Listeners, MovieViewListener.Listeners, NodeListener.Listeners, NodeListener.Listeners, NumberedListListener.Listeners, NumberRulerListener.Listeners, PromptListener.Listeners, QueryListener.Listeners, QueueListener.Listeners, RollupListener.Listeners, RollupStateListener.Listeners, RulerListener.Listeners, ScrollBarListener.Listeners, ScrollBarValueListener.Listeners, ScrollPaneListener.Listeners, SeparatorListener.Listeners, SetListener.Listeners, SheetStateListener.Listeners, SliderListener.Listeners, SliderValueListener.Listeners, SpinnerBindingListener.Listeners, SpinnerItemListener.Listeners, SpinnerListener.Listeners, SpinnerSelectionListener.Listeners, SplitPaneListener.Listeners, StackListener.Listeners, SuggestionPopupItemListener.Listeners, SuggestionPopupListener.Listeners, SuggestionPopupSelectionListener.Listeners, SuggestionPopupStateListener.Listeners, TablePaneAttributeListener.Listeners, TablePaneListener.Listeners, TableViewBindingListener.Listeners, TableViewColumnListener.Listeners, TableViewHeaderListener.Listeners, TableViewHeaderPressListener.Listeners, TableViewListener.Listeners, TableViewRowListener.Listeners, TableViewSelectionListener.Listeners, TableViewSortListener.Listeners, TabPaneAttributeListener.Listeners, TabPaneListener.Listeners, TabPaneSelectionListener.Listeners, TextArea.ParagraphListener.Listeners, TextAreaBindingListener.Listeners, TextAreaContentListener.Listeners, TextAreaListener.Listeners, TextAreaSelectionListener.Listeners, TextInputBindingListener.Listeners, TextInputContentListener.Listeners, TextInputListener.Listeners, TextInputSelectionListener.Listeners, TextNodeListener.Listeners, TextPaneCharacterListener.Listeners, TextPaneListener.Listeners, TextPaneSelectionListener.Listeners, TreeViewBranchListener.Listeners, TreeViewListener.Listeners, TreeViewNodeListener.Listeners, TreeViewNodeStateListener.Listeners, TreeViewSelectionListener.Listeners, VFSBrowserListener.Listeners, VFSBrowserSheetListener.Listeners, ViewportListener.Listeners, WindowActionMappingListener.Listeners, WindowClassListener.Listeners, WindowListener.Listeners, WindowStateListener.Listeners, WTKListenerList, XMLSerializerListener.Listeners

public abstract class ListenerList<T>
extends java.lang.Object
implements java.lang.Iterable<T>

Abstract base class for listener lists.

NOTE This class is not inherently thread safe. Subclasses that require thread-safe access should synchronize method access appropriately. Callers must manually synchronize on the listener list instance to ensure thread safety during iteration.

Constructor Summary

Constructors

Constructor	Description
ListenerList()

Method Summary

Modifier and Type	Method	Description
void	add(int index, T listener)	Inserts a new listener to the specified position in the list.
void	add(T listener)	Adds a listener to the list, if it has not previously been added.
boolean	contains(T listener)	Tests the existence of a listener in the list.
T	get(int index)	Get the indexed element in the list.
int	getLength()	Get the number of elements in the list.
boolean	isEmpty()	Tests the emptiness of the list.
java.util.Iterator<T>	iterator()
void	remove(T listener)	Removes a listener from the list, if it has previously been added.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ListenerList

public ListenerList()

Method Detail

add

public void add(T listener)

Adds a listener to the list, if it has not previously been added.

Parameters:

listener - New listener to add to the list.

add

public void add(int index,
                T listener)

Inserts a new listener to the specified position in the list.

Parameters:

index - The 0-based position in the list where to add the new listener.

listener - New listener to add there.

remove

public void remove(T listener)

Removes a listener from the list, if it has previously been added.

Parameters:

listener - The listener to remove from the list.

contains

public boolean contains(T listener)

Tests the existence of a listener in the list.

Parameters:

listener - The listener to test.

Returns:

true if the listener exists in the list; false, otherwise.

isEmpty

public boolean isEmpty()

Tests the emptiness of the list.

Returns:

true if the list contains no listeners; false, otherwise.

getLength

public int getLength()

Get the number of elements in the list.

Returns:

the number of elements.

get

public T get(int index)

Get the indexed element in the list.

Parameters:

index - Position of the element to retrieve.

Returns:

The element at position index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range.

iterator

public final java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object