Merge pull request #695 from chkal/master-form-param-entity

Define how @FormParam values are obtained
jakartaee · Nov 29, 2018 · da1b0c0 · da1b0c0
2 parents 523a6f0 + 2c13e5a
commit da1b0c0
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. If there is at least one
+ * {@link FormParam} for a resource method, JAX-RS implementations MUST support a {@link javax.ws.rs.core.Form}
+ * entity parameter for the same method. Support for other entity parameter types is OPTIONAL.
+ * </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>