Class AbstractQueryBuilder<T,​R>

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractQueryBuilder​(VkApiClient client, java.lang.String method, java.lang.reflect.Type type)
      Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
      AbstractQueryBuilder​(VkApiClient client, java.lang.String endpoint, java.lang.String method, java.lang.reflect.Type type)
      Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
    • Constructor Detail

      • AbstractQueryBuilder

        public AbstractQueryBuilder​(VkApiClient client,
                                    java.lang.String method,
                                    java.lang.reflect.Type type)
        Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
        Parameters:
        client - VK API client
        method - method name
        type - type of method response
      • AbstractQueryBuilder

        public AbstractQueryBuilder​(VkApiClient client,
                                    java.lang.String endpoint,
                                    java.lang.String method,
                                    java.lang.reflect.Type type)
        Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
        Parameters:
        client - VK API client
        endpoint - API endpoint
        method - method name
        type - type of method response
    • Method Detail

      • accessToken

        protected T accessToken​(java.lang.String value)
        Set access token
        Parameters:
        value - access token
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • clientSecret

        protected T clientSecret​(java.lang.String value)
        Set client secret
        Parameters:
        value - client secret
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • lang

        public T lang​(Lang value)
        Set lang
        Parameters:
        value - lang
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • version

        protected T version​(java.lang.String value)
        Set version
        Parameters:
        value - version
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • captchaSid

        public T captchaSid​(java.lang.String value)
        Set captcha sid
        Parameters:
        value - captcha sid
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • captchaKey

        public T captchaKey​(java.lang.String value)
        Set captcha key
        Parameters:
        value - captcha key
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • confirm

        public T confirm​(java.lang.Boolean value)
        Set confirmation
        Parameters:
        value - confirm
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             java.lang.String value)
        Set parameter
        Parameters:
        key - name of parameter
        value - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             int value)
        Set parameter
        Parameters:
        key - name of parameter
        value - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             boolean value)
        Set parameter
        Parameters:
        key - name of parameter
        value - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             java.util.Collection<?> value)
        Set parameter
        Parameters:
        key - name of parameter
        value - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public <U> T unsafeParam​(java.lang.String key,
                                 U... value)
        Set parameter
        Parameters:
        key - name of parameter
        value - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             int[] value)
        Set parameter
        Parameters:
        key - name of parameter
        value - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             double value)
        Set parameter
        Parameters:
        key - name of parameter
        value - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             float value)
        Set parameter
        Parameters:
        key - name of parameter
        value - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             EnumParam value)
        Set parameter
        Parameters:
        key - name of parameter
        value - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             EnumParam... fields)
        Set parameter
        Parameters:
        key - name of parameter
        fields - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • unsafeParam

        public T unsafeParam​(java.lang.String key,
                             java.util.List<? extends EnumParam> fields)
        Set parameter
        Parameters:
        key - name of parameter
        fields - value of parameter
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • getBody

        protected java.lang.String getBody()
        Specified by:
        getBody in class ApiRequest<R>
      • getThis

        protected abstract T getThis()
        Get reference to this object
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.
      • essentialKeys

        protected abstract java.util.Collection<java.lang.String> essentialKeys()
        Get list of required parameter names
        Returns:
        list of names
      • build

        public java.util.Map<java.lang.String,​java.lang.String> build()
        Get map of parameter values
        Returns:
        map of values
      • getMethod

        public java.lang.String getMethod()
        Get method name
        Returns:
        method name
      • getParams

        public java.util.Map<java.lang.String,​java.lang.String> getParams()
        Get params
        Returns:
        parameters of method
      • toString

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