Package jakarta.ws.rs

Annotation Type DefaultValue

@Target({PARAMETER,METHOD,FIELD})
@Retention(RUNTIME)
@Documented
public @interface DefaultValue
Defines the default value of request meta-data that is bound using one of the following annotations: PathParam, QueryParam, MatrixParam, CookieParam, FormParam, or HeaderParam. The default value is used if the corresponding meta-data is not present in the request.

If the type of the annotated parameter is List, Set or SortedSet then the resulting collection will have a single entry mapped from the supplied default value.

If this annotation is not used and the corresponding meta-data is not present in the request, the value will be an empty collection for List, Set or SortedSet, null for other object types, and the Java-defined default for primitive types.

Since:
1.0
Author:
Paul Sandoz, Marc Hadley
See Also:
PathParam, QueryParam, FormParam, HeaderParam, MatrixParam, CookieParam

  • Required Element Summary

    Required Elements 
    Modifier and Type Required Element Description
    String value
    The specified default value.

  • Element Details

    • value

      String value
      The specified default value.
      Returns:
      default value.