uk.ac.ebi.microarray.zooma.annotations
Annotation Type ZoomaMappingOperation

@Documented
@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface ZoomaMappingOperation

An annotation that can be applied to methods to indicate that this method performs a Zooma mapping operation. This annotation should be used with a "operation" argument, binding the operation to a operation (for providing e.g. command line feedback).

Consumers of this annotation should reflect the method to check for a boolean return type, and if so they should attempt to report back whether the operation was successful or not.

Whilst you can apply this annotation to any method, only boolean return types will be considered - if the method you apply this annotation to returns something else, it will be disregarded by the command line client.

Author:

Tony Burdett

Required Element Summary

java.lang.String

operation

Optional Element Summary

java.lang.String	description
java.lang.String	shortName

Element Detail

operation

public abstract java.lang.String operation

shortName

public abstract java.lang.String shortName

Default:

"#"

description

public abstract java.lang.String description

Default:

"no.description.provided"