com.canto.cumulus.server.esp

Class AbstractESP

java.lang.Object

com.canto.cumulus.server.esp.AbstractESP

All Implemented Interfaces:

ESP

public abstract class AbstractESP
extends java.lang.Object
implements ESP

Abstract base class for an ESP. You can use this class as a base class when implementing the ESP interface. The following methods are abstract because each ESP needs to provide its own implementation: - getName()

Since:

ESP 7.0.0

Constructor Summary

Constructors

Constructor and Description
AbstractESP()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Default implementation of the close() interface method.
GUID	getID() Return a unique ID for this ESP instance.
abstract java.lang.String	getName(int language) Return a user readable name for this plugin.
void	initialize(ESPContext context) Default implementation of the initialize() interface method.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractESP

public AbstractESP()

Method Detail

initialize

public void initialize(ESPContext context)

Default implementation of the initialize() interface method. It stores the context in a member variabble "context".

Specified by:

initialize in interface ESP

Parameters:

context - the ESP context for this ESP instance.

close

public void close()

Default implementation of the close() interface method. This does nothing.

Specified by:

close in interface ESP

getID

public GUID getID()

Return a unique ID for this ESP instance. This ID is generated at runtime so it is unknown and can not be referenced from other ESPs.

Specified by:

getID in interface ESP

Returns:

A unique ID.

getName

public abstract java.lang.String getName(int language)

Description copied from interface: ESP

Return a user readable name for this plugin.

Specified by:

getName in interface ESP

Returns:

A user readable name for this plugin