Annotation Interface TypedParam
Annotation used for the typed parameter on the controller method or within a parameter group.
An example is as below.
@ResponseBody
public ResponseEntity<GroupObject> getGroups(
@PathVariable("repositoryName") final String repositoryName,
@TypedParam final CollectionParam collectionParam,
@RequestUri final UriInfo uriInfo) {
}
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionIf the parameter annotated by @TypedParam is managed by Spring, specify the beanId here, and the parameter instance will be obtained via Spring, otherwise, a new class instance will be created via Java reflection keep in mind a new parameter instance should be created for each request and the bean should not be a singleton scope bean.A list of default values that will be used if client doesn't provide a value for some parameter.
-
Element Details
-
beanId
String beanIdIf the parameter annotated by @TypedParam is managed by Spring, specify the beanId here, and the parameter instance will be obtained via Spring, otherwise, a new class instance will be created via Java reflection keep in mind a new parameter instance should be created for each request and the bean should not be a singleton scope bean.- Returns:
- the bean ID.
- Default:
- ""
-
value
DefaultValue[] valueA list of default values that will be used if client doesn't provide a value for some parameter.- Returns:
- the list of default values.
- Default:
- {}
-