Annotation Type Parameter


  • @Retention(RUNTIME)
    @Target({ANNOTATION_TYPE,FIELD})
    @Documented
    @API(status=MAINTAINED,
         since="5.13.3")
    public @interface Parameter
    @Parameter is used to signal that a field in a @ParameterizedClass constitutes a parameter and marks it for field injection.

    @Parameter may also be used as a meta-annotation in order to create a custom composed annotation that inherits the semantics of @Parameter.

    Since:
    5.13
    See Also:
    ParameterizedClass, ArgumentsAccessor, AggregateWith, ArgumentConverter, ConvertWith
    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static int UNSET_INDEX
      Constant that indicates that the index of the parameter is unset.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      int value
      {@return the index of the parameter in the list of parameters}
    • Field Detail

      • UNSET_INDEX

        static final int UNSET_INDEX
        Constant that indicates that the index of the parameter is unset.
    • Element Detail

      • value

        int value
        {@return the index of the parameter in the list of parameters}

        Must be -1 (the default) for aggregators, that is any field of type ArgumentsAccessor or any field annotated with @AggregateWith.

        May be omitted if there's a single indexed parameter. Otherwise, must be unique among all indexed parameters of the parameterized class and its superclasses.

        Default:
        -1