Class ResourceParameter


  • public class ResourceParameter
    extends java.lang.Object
    ResourceParameters are used on ResourceOperations The KIND is one of : QUERY_STRING - A query string parameter as part of the URL HTTP_BODY_OBJECT - A JSON object specified in a HTTP_BODY used by either a POST or PUT URL_PATH - Included as part of the actual url, e.g. entity id. (Does not support multiple values) HTTP_HEADER - Included in the request's HTTP Header
    Author:
    Gethin James
    • Method Detail

      • valueOf

        protected static ResourceParameter valueOf​(java.lang.String name,
                                                   java.lang.String title,
                                                   java.lang.String description,
                                                   boolean required,
                                                   ResourceParameter.KIND kind,
                                                   boolean allowMultiple,
                                                   java.lang.Class<?> dataType)
        Creates a new ResourceParameter.
        Parameters:
        name - - name used in the request
        title - - a short description
        description - - a long description
        required - - is it mandatory?
        kind - - The kind of parameter it is
        allowMultiple - - Can allow multiple values?
        dataType - - The expected data type of the parameter
        Returns:
        ResourceParameter
      • getName

        public java.lang.String getName()
      • isRequired

        public boolean isRequired()
      • getTitle

        public java.lang.String getTitle()
      • getDescription

        public java.lang.String getDescription()
      • getDataType

        public java.lang.Class<?> getDataType()
      • isAllowMultiple

        public boolean isAllowMultiple()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object