Package org.esa.snap.core.gpf.operators.tooladapter

Enum ToolAdapterRegistry

java.lang.Object

java.lang.Enum<ToolAdapterRegistry>

org.esa.snap.core.gpf.operators.tooladapter.ToolAdapterRegistry

All Implemented Interfaces:

Serializable, Comparable<ToolAdapterRegistry>

public enum ToolAdapterRegistry
extends Enum<ToolAdapterRegistry>

Registry (map) class for mapping ToolAdapterOpSpi-s to adapter names.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	The singleton instance of the class

Method Summary

Modifier and Type	Method	Description
void	addListener(ToolAdapterListener listener)
ToolAdapterOperatorDescriptor	findByAlias(String alias)
Map<String,ToolAdapterOpSpi>	getOperatorMap()	Gets the registered ToolAdapterOpSpi-s
void	registerOperator(ToolAdapterOpSpi operatorSpi)	Adds an operator to this registry and registers it in the global OperatorSpiRegistry.
void	removeListener(ToolAdapterListener listener)
void	removeOperator(ToolAdapterOperatorDescriptor operatorDescriptor)	De-registers a ToolAdapterOpSpi given the adapter descriptor.
static ToolAdapterRegistry	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ToolAdapterRegistry[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final ToolAdapterRegistry INSTANCE

The singleton instance of the class

Method Detail

values

public static ToolAdapterRegistry[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ToolAdapterRegistry c : ToolAdapterRegistry.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ToolAdapterRegistry valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOperatorMap

public Map<String,ToolAdapterOpSpi> getOperatorMap()

Gets the registered ToolAdapterOpSpi-s

Returns:

the map of the registered ToolAdapterOpSpi-s

registerOperator

public void registerOperator(ToolAdapterOpSpi operatorSpi)

Adds an operator to this registry and registers it in the global OperatorSpiRegistry.

Parameters:

operatorSpi - The SPI to be registered

removeOperator

public void removeOperator(ToolAdapterOperatorDescriptor operatorDescriptor)

De-registers a ToolAdapterOpSpi given the adapter descriptor.

Parameters:

operatorDescriptor - The descriptor of the operator to be removed

findByAlias

public ToolAdapterOperatorDescriptor findByAlias(String alias)

addListener

public void addListener(ToolAdapterListener listener)

removeListener

public void removeListener(ToolAdapterListener listener)