Define that FormParam values must be read from Form entity

jakartaee · Nov 4, 2018 · 9acd5dc · 9acd5dc
1 parent 16518e8
commit 9acd5dc
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/jaxrs-api/src/main/java/javax/ws/rs/FormParam.java b/jaxrs-api/src/main/java/javax/ws/rs/FormParam.java
@@ -46,6 +46,13 @@
  * </p>
  *
  * <p>
+ * If this annotation is used to bind form parameters, a JAX-RS implementation MUST use the entity provider API
+ * to create a {@link javax.ws.rs.core.Form} and derive the values from this instance. This implies,
+ * that {@link javax.ws.rs.core.Form} is the only allowed entity parameter type if there is at least one
+ * {@link FormParam} annotation for a request.
+ * </p>
+ *
+ * <p>
  * Note that, whilst the annotation target permits use on fields and methods, this annotation is only required to be
  * supported on resource method parameters.
  * </p>