Package com.emc.documentum.rest.http.annotation

Annotation Interface QueryParam

@Target(FIELD) @Retention(RUNTIME) public @interface QueryParam
Annotation used for the simple query parameter on the controller method or within a parameter group. An example is as below to define a parameter group for pagination.
    
    public class PagingParam {
        @QueryParam(name = "page")
        private int page = 1;

        @QueryParam(name = "items-per-page")
        private int itemsPerPage = 100;
    }

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends org.springframework.core.convert.converter.Converter<String,?>>
    converter
     
    boolean
    isArray
     

  • Element Details

    • name

      String name
      Returns:
      the parameter name

    • isArray

      boolean isArray
      Returns:
      whether the parameter is an array
      Default:
      false

    • converter

      Class<? extends org.springframework.core.convert.converter.Converter<String,?>> converter
      Returns:
      the customized converter
      Default:
      com.emc.documentum.rest.http.converter.DummyConverter.class