Package eu.cloudnetservice.driver.network.http.annotation

Annotation Interface RequestQueryParam

@Documented @Target(PARAMETER) @Retention(RUNTIME) public @interface RequestQueryParam
Get all values of the associated query key. The value passed to the associated parameter is List<String>. This annotation can be combined with @Optional to mark the parameter as optional, an empty list is passed to the parameter in that case.
Since:
4.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    @NonNull String
    value
    Get the key of the query parameters to retrieve.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    nullWhenAbsent
    Sets whether null should be injected for the method parameter instead of an empty collection if no query parameter with the specified key is present and the parameter marked as optional.

  • Element Details

    • value

      @NonNull @NonNull String value
      Get the key of the query parameters to retrieve.
      Returns:
      the key of the query parameters to retrieve.

    • nullWhenAbsent

      boolean nullWhenAbsent
      Sets whether null should be injected for the method parameter instead of an empty collection if no query parameter with the specified key is present and the parameter marked as optional.
      Returns:
      if null should be injected instead of an empty collection if no query parameters with the key are present.
      Default:
      false