org.eclipse.modisco.infra.discovery.core.annotations
Annotation Type Parameter


@Documented
@Retention(value=RUNTIME)
@Target(value={METHOD,FIELD})
public @interface Parameter

The Parameter annotation describes some informations needed to characterize inputs and outputs for discoverers (IDiscoverer) The developer is free to annotate directly a Java field or a getter/setter method, or both field and getter/setter with a same id. An input data is supposed to be valued before a discovery is launched : At least a setter method (preferred) or a public field (discouraged) must be proposed. An output data is supposed to be accessed after a discovery treatment : At least a setter method (preferred) or a public field (discouraged) must be proposed. A data both input and output of the discovery must respond to both previous conditions. Using the annotation will throw compilation errors in the following cases :


Required Element Summary
 java.lang.String name
           
 
Optional Element Summary
 java.lang.String description
           
 boolean requiresInputValue
           
 

Element Detail

name

public abstract java.lang.String name
Returns:
the identifier of the discoverer parameter

description

public abstract java.lang.String description
Returns:
the optional description of the discoverer parameter
Default:
""

requiresInputValue

public abstract boolean requiresInputValue
Returns:
true if a value for this discoverer parameter is mandatory to launch the discovery.
Default:
false