Module neberus.core
Package net.oneandone.neberus.annotation

Annotation Type ApiAllowedValue

  • @Target({PARAMETER,FIELD,METHOD})
@Retention(SOURCE)
@Repeatable(ApiAllowedValues.class)
public @interface ApiAllowedValue
    Define the allowed values for a parameter. This will be used to replace placeholders in the example curl.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class<? extends java.lang.Enum> enumValues
      Allow all values of the specified enum.
      java.lang.String value
      The exact allowed values for this parameter.
      java.lang.String valueHint
      Hint about the allowed values.

    • Element Detail

      • value

        java.lang.String value
        The exact allowed values for this parameter.
        Returns:
        the value
        Default:
        ""

      • valueHint

        java.lang.String valueHint
        Hint about the allowed values.
        Returns:
        the valueHint
        Default:
        ""

      • enumValues

        java.lang.Class<? extends java.lang.Enum> enumValues
        Allow all values of the specified enum.
        Returns:
        the enumClass
        Default:
        java.lang.Enum.class