org.eclipse.keyple.core.service

Interface Plugin

All Known Subinterfaces:

ObservablePlugin, ObservablePluginNotifier, PoolPlugin

All Known Implementing Classes:

AbstractObservablePlugin, AbstractPlugin, AbstractThreadedObservablePlugin

public interface Plugin

Defines the high level plugin API.

Provides methods to get the plugin name and to retrieve the readers.

Since:

0.9

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Gets the name of the plugin
Reader	getReader(java.lang.String name) Gets the reader whose name is provided as an argument
java.util.Set<java.lang.String>	getReaderNames() Gets the list of names of all readers
java.util.Map<java.lang.String,Reader>	getReaders() Gets the readers.

Method Detail

getName

java.lang.String getName()

Gets the name of the plugin

Returns:

A not empty string.

Since:

0.9

getReaderNames

java.util.Set<java.lang.String> getReaderNames()

Gets the list of names of all readers

Returns:

a list of String

Throws:

java.lang.IllegalStateException - is called when plugin is no longer registered

Since:

0.9

getReaders

java.util.Map<java.lang.String,Reader> getReaders()

Gets the readers.

Returns:

the map of this plugin's connected reader's name and instance, can be an empty list, can not be null;

Throws:

java.lang.IllegalStateException - is called when plugin is no longer registered

Since:

0.9

getReader

Reader getReader(java.lang.String name)

Gets the reader whose name is provided as an argument

Parameters:

name - of the reader

Returns:

the Reader object.

Throws:

KeypleReaderNotFoundException - if the wanted reader is not found

java.lang.IllegalStateException - is called when plugin is no longer registered

Since:

0.9