org.eclipse.keyple.core.plugin

Class AbstractObservablePlugin

java.lang.Object

org.eclipse.keyple.core.plugin.AbstractPlugin

org.eclipse.keyple.core.plugin.AbstractObservablePlugin

All Implemented Interfaces:

ObservablePluginNotifier, ObservablePlugin, Plugin

Direct Known Subclasses:

AbstractThreadedObservablePlugin

public abstract class AbstractObservablePlugin
extends AbstractPlugin
implements ObservablePluginNotifier

Provides the means to manage the observation of a plugin.

It allows:

• the management of the observers (add/remove/count) (see the ObservablePlugin.PluginObserver interface)
• the notification of PluginEvent to all the observers

Since:

0.9

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.keyple.core.service.event.ObservablePlugin

ObservablePlugin.PluginObserver

Field Summary

Fields inherited from class org.eclipse.keyple.core.plugin.AbstractPlugin

readers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractObservablePlugin(java.lang.String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addObserver(ObservablePlugin.PluginObserver observer) Register a new plugin observer to be notified when a plugin event occurs.
void	clearObservers() Unregister all observers at once.
int	countObservers() Provides the current number of registered observers.
void	notifyObservers(PluginEvent event) Push a PluginEvent of the ObservablePluginNotifier to its registered observers.
void	removeObserver(ObservablePlugin.PluginObserver observer) Unregister a plugin observer.
void	unregister() (internal usage only) Change the plugin status to unregistered

Methods inherited from class org.eclipse.keyple.core.plugin.AbstractPlugin

getName, getReader, getReaderNames, getReaders, initNativeReaders, register

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.keyple.core.service.Plugin

getName, getReader, getReaderNames, getReaders

Constructor Detail

AbstractObservablePlugin

protected AbstractObservablePlugin(java.lang.String name)

Constructor.

Parameters:

name - A not empty String containing the name of the plugin

Throws:

KeypleReaderException - when an issue is raised with reader

Since:

0.9

Method Detail

addObserver

public void addObserver(ObservablePlugin.PluginObserver observer)

Register a new plugin observer to be notified when a plugin event occurs.

The provided observer will receive all the events produced by this plugin (reader connection, disconnection).

It is possible to add as many observers as necessary. They will be notified of events sequentially in the order in which they are added.

Specified by:

addObserver in interface ObservablePlugin

Parameters:

observer - An observer object implementing the required interface (should be not null).

Since:

0.9

removeObserver

public void removeObserver(ObservablePlugin.PluginObserver observer)

Unregister a plugin observer.

The observer will no longer receive any of the events produced by this plugin.

Specified by:

removeObserver in interface ObservablePlugin

Parameters:

observer - The observer object to be unregistered (should be not null).

Since:

0.9

clearObservers

public void clearObservers()

Unregister all observers at once.

Specified by:

clearObservers in interface ObservablePlugin

Since:

0.9

countObservers

public final int countObservers()

Provides the current number of registered observers.

Specified by:

countObservers in interface ObservablePlugin

Returns:

an int

Since:

0.9

notifyObservers

public final void notifyObservers(PluginEvent event)

Push a PluginEvent of the ObservablePluginNotifier to its registered observers.

Specified by:

notifyObservers in interface ObservablePluginNotifier

Parameters:

event - the event (see PluginEvent)

Since:

0.9

unregister

public void unregister()

Description copied from class: AbstractPlugin

(internal usage only)
Change the plugin status to unregistered

Overrides:

unregister in class AbstractPlugin