org.esa.beam.framework.gpf.annotations
Annotation Type OperatorMetadata

@Documented
@Inherited
@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface OperatorMetadata

Provides metadata for an operator. This annotation is valid for extensions of the Operator class.

Required Element Summary

String

alias

Optional Element Summary

String	authors
String	copyright
String	description
boolean	internal
String	version

Element Detail

alias

public abstract String alias

Returns:

An alias name for the operator.

version

public abstract String version

Returns:

The version of the operator. Defaults to the empty string (= not set).

Default:

""

authors

public abstract String authors

Returns:

The author(s) of the operator. Defaults to the empty string (= not set).

Default:

""

copyright

public abstract String copyright

Returns:

The copyright notice for the operator code. Defaults to the empty string (= not set).

Default:

""

description

public abstract String description

Returns:

A brief description of the operator's purpose. Defaults to the empty string (= not set).

Default:

""

internal

public abstract boolean internal

Returns:

If true, this operator is considered for internal use only and thus may not be exposed in user interfaces.

Default:

false