package brooklyn.entity.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

//FIXME Move to brooklyn.entity.effector?

/**
 * Gives meta-data about a parameter of the effector.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface EffectorParam {
    String name();
    String description() default MAGIC_STRING_MEANING_NULL;
    String defaultValue() default MAGIC_STRING_MEANING_NULL;
    boolean nullable() default true;
    
    // Cannot use null as a default (e.g. for defaultValue); therefore define a magic string to mean that
    // so can tell when no-one has set it.
    public static final String MAGIC_STRING_MEANING_NULL = "null default value; do not missuse! 3U=Hhfkr8wuov]WO";
}

@@ -585,17 +585,18 @@
   %0A    /
-/
+**
  Cannot 
@@ -692,17 +692,17 @@
 at%0A    /
-/
+*
  so can 
@@ -729,16 +729,19 @@
  set it.
+ */
 %0A    pub
@@ -823,17 +823,17 @@
  not mis
-s
+-
 use! 3U=

correct spelling, add javadoc, for EffectorParam