SMILA 1.0 API documentation

org.eclipse.smila.processing
Interface PipeletTracker

All Known Implementing Classes:
PipeletTrackerImpl

public interface PipeletTracker

service interface for tracker of Pipelets.

Author:
jschumacher

Field Summary
static java.lang.String KEY_CLASS
          key for pipelet class.
static java.lang.String KEY_ERRORS
          key for errors.
static java.lang.String KEY_PARAMETERS
          key for parameters.
 
Method Summary
 void addListener(PipeletTrackerListener listener)
          add a listener that will be notified about new or deactivated pipelet classes on bundle changes.
 java.util.Map<java.lang.String,AnyMap> getRegisteredPipeletDescriptions()
          get the description of all currently registered pipelets.
 java.util.Map<java.lang.String,java.lang.Class<? extends Pipelet>> getRegisteredPipelets()
          get all currently registered pipelets.
 void removeListener(PipeletTrackerListener listener)
          remove a listener that will be notified about new or deactivated pipelet classes on bundle changes.
 

Field Detail

KEY_CLASS

static final java.lang.String KEY_CLASS
key for pipelet class.

See Also:
Constant Field Values

KEY_ERRORS

static final java.lang.String KEY_ERRORS
key for errors.

See Also:
Constant Field Values

KEY_PARAMETERS

static final java.lang.String KEY_PARAMETERS
key for parameters.

See Also:
Constant Field Values
Method Detail

getRegisteredPipelets

java.util.Map<java.lang.String,java.lang.Class<? extends Pipelet>> getRegisteredPipelets()
get all currently registered pipelets.

Returns:
map of class names to pipelet classes.

getRegisteredPipeletDescriptions

java.util.Map<java.lang.String,AnyMap> getRegisteredPipeletDescriptions()
get the description of all currently registered pipelets.

Returns:
map of class names to pipelet descriptions.

addListener

void addListener(PipeletTrackerListener listener)
add a listener that will be notified about new or deactivated pipelet classes on bundle changes. This is also set as a service reference bind method in component descriptor, so the suggested way to use this is to register PipeletListener service instead of calling the method directly.

Parameters:
listener - a new listener for PipeletTracker events.

removeListener

void removeListener(PipeletTrackerListener listener)
remove a listener that will be notified about new or deactivated pipelet classes on bundle changes. This is also set as a service reference unbind method in component descriptor, so the suggested way to use this is to register PipeletListener service instead of calling the method directly.

Parameters:
listener - an obsolete listener for PipeletTracker events.

SMILA 1.0 API documentation