org.esa.snap.core.gpf

Interface OperatorSpiRegistry

public interface OperatorSpiRegistry

A registry for operator SPI instances.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
boolean	addOperatorSpi(OperatorSpi operatorSpi) Adds the given operatorSpi to this registry.
boolean	addOperatorSpi(String operatorName, OperatorSpi operatorSpi) Adds the given operatorSpi to this registry.
Set	getAliases() Gets a set of all aliases
OperatorSpi	getOperatorSpi(String operatorName) Gets a registered operator SPI.
Set<OperatorSpi>	getOperatorSpis()
ServiceRegistry<OperatorSpi>	getServiceRegistry() Gets the ServiceRegistry
void	loadOperatorSpis() Loads the SPIs defined in META-INF/services.
boolean	removeOperatorSpi(OperatorSpi operatorSpi) Removes the given operatorSpi this registry.
void	setAlias(String aliasName, String spiClassName) Deprecated. since BEAM 5, used internally only

Method Detail

loadOperatorSpis

void loadOperatorSpis()

Loads the SPIs defined in META-INF/services.

getOperatorSpis

Set<OperatorSpi> getOperatorSpis()

Returns:

The set of all registered operator SPIs.

Since:

BEAM 5

getServiceRegistry

ServiceRegistry<OperatorSpi> getServiceRegistry()

Gets the ServiceRegistry

Returns:

the service registry

getOperatorSpi

OperatorSpi getOperatorSpi(String operatorName)

Gets a registered operator SPI. The given operatorName can be either the fully qualified class name of the OperatorSpi or an alias name.

Parameters:

operatorName - a name identifying the operator SPI.

Returns:

the operator SPI, or null

addOperatorSpi

boolean addOperatorSpi(OperatorSpi operatorSpi)

Adds the given operatorSpi to this registry.

Parameters:

operatorSpi - the SPI to add

Returns:

true, if the OperatorSpi could be successfully added, otherwise false

addOperatorSpi

boolean addOperatorSpi(String operatorName,
                       OperatorSpi operatorSpi)

Adds the given operatorSpi to this registry.

Parameters:

operatorName - an (alias) name used as key for the registration.

operatorSpi - the SPI to add

Returns:

true, if the OperatorSpi could be successfully added, otherwise false

Since:

BEAM 5

removeOperatorSpi

boolean removeOperatorSpi(OperatorSpi operatorSpi)

Removes the given operatorSpi this registry.

Parameters:

operatorSpi - the SPI to remove

Returns:

true, if the SPI could be removed, otherwise false

setAlias

@Deprecated
void setAlias(String aliasName,
                           String spiClassName)

Deprecated. since BEAM 5, used internally only

Sets an alias for the given SPI class name.

Parameters:

aliasName - the alias

spiClassName - the name of the SPI class

getAliases

Set getAliases()

Gets a set of all aliases

Returns:

the Set<string> of alias keys