Annotation Type ActionParameterDescription


  • @Retention(RUNTIME)
    @Target(PARAMETER)
    public @interface ActionParameterDescription
    Describes the Parameter of an Method that is annotated with ActionDescription. Some information are introspected by the Discovery that registeres the Action at the PolicyManagementPoint. But for example the parameter cannot be introspected in any situation. Up to Java 1.7 argument names are dropped during compilation and in java 1.8 option preserve argument names is not activated per default. Thus each instance of this ActionParameterDescription should contain at least the name. For example
       @ActionDescription(description = "anagram the parameter")
        public String anagram(@ActionParameterDescription(name = "percentage",description = "The percentage you need to anagram") Integer percentage) {
          return "xxxx";
        }
     
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String name
      Name of the Parameter.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String description
      Description of the Parameter.
      boolean mandatory
      Mandatory parameter?.
      Class<?> type
      Deprecated. 
    • Element Detail

      • name

        String name
        Name of the Parameter.
        Returns:
        The parameter name.
      • description

        String description
        Description of the Parameter.
        Returns:
        Description
        Default:
        ""
      • mandatory

        boolean mandatory
        Mandatory parameter?.
        Returns:
        True if the policy have to specify the value for this parameter.
        Default:
        false
      • type

        @Deprecated
        Class<?> type
        Deprecated.
        Type of the parameter. Per default introspected with method.getReturnType()
        Returns:
        Parametertype
        Default:
        java.lang.Void.class