org.sourcelab.github.client.request.RequestParametersBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of github-rest-api Show documentation
A for Github's rest API
The newest version!
package org.sourcelab.github.client.request;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

/**
 * Utility for constructing {@link RequestParameters}.
 */
public class RequestParametersBuilder {
    final Map> values = new HashMap<>();

    /**
     * Adds/Appends Request Parameter value.
     * @param name Name of the parameter to add/append value to.
     * @param values Values to add/append.
     * @return RequestParametersBuilder for method chaining.
     */
    public RequestParametersBuilder withParameter(final String name, final Collection values) {
        Objects.requireNonNull(name);
        Objects.requireNonNull(values);

        values.forEach((value) -> withParameter(name, value));
        return this;
    }

    /**
     * Adds/Appends Request Parameter value.
     * @param name Name of the parameter to add/append value to.
     * @param value Value to add/append.
     * @return RequestParametersBuilder for method chaining.
     */
    public RequestParametersBuilder withParameter(final String name, final Object value) {
        Objects.requireNonNull(name);
        Objects.requireNonNull(value);

        if (!values.containsKey(name)) {
            values.put(name, new HashSet<>());
        }
        values.get(name).add(value.toString());
        return this;
    }

    /**
     * Adds/Appends Request Parameter value.
     * @param name Name of the parameter to add/append value to.
     * @param values Values to append.
     * @return RequestParametersBuilder for method chaining.
     */
    public RequestParametersBuilder withParameter(final String name, final Object ... values) {
        Arrays.asList(values).forEach((value) -> withParameter(name, value));
        return this;
    }

    /**
     * Add common page options parameters.
     * @param pageOptions Page options to add.
     * @return RequestParametersBuilder for method chaining.
     */
    public RequestParametersBuilder withPageOptions(final PageOptions pageOptions) {
        if (pageOptions != null) {
            withParameter("page", pageOptions.getPage());
            withParameter("per_page", pageOptions.getPerPage());
        }
        return this;
    }

    /**
     * New {@link RequestParameters} instance from configured values.
     * @return New {@link RequestParameters} instance from configured values.
     */
    public RequestParameters build() {
        final List params = new ArrayList<>();
        for (Map.Entry> param: values.entrySet()) {
            params.add(new RequestParameter(param.getKey(), param.getValue()));
        }
        return new RequestParameters(params);
    }

}