org.kohsuke.github.GHSearchBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of github-api Show documentation
GitHub API for Java
There is a newer version: 2.0.0-alpha-2
package org.kohsuke.github;

import org.apache.commons.lang3.StringUtils;

import java.util.ArrayList;
import java.util.List;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

// TODO: Auto-generated Javadoc
/**
 * Base class for various search builders.
 *
 * @author Kohsuke Kawaguchi
 * @param 
 *            the type parameter
 */
public abstract class GHSearchBuilder extends GHQueryBuilder {

    /** The terms. */
    protected final List terms = new ArrayList();

    /**
     * Data transfer object that receives the result of search.
     */
    private final Class> receiverType;

    /**
     * Instantiates a new GH search builder.
     *
     * @param root
     *            the root
     * @param receiverType
     *            the receiver type
     */
    GHSearchBuilder(GitHub root, Class> receiverType) {
        super(root);
        this.receiverType = receiverType;
        req.withUrlPath(getApiUrl());
        req.rateLimit(RateLimitTarget.SEARCH);
    }

    /**
     * Search terms.
     *
     * @param term
     *            the term
     * @return the gh query builder
     */
    public GHQueryBuilder q(String term) {
        terms.add(term);
        return this;
    }

    /**
     * Add a search term with qualifier.
     *
     * If {@code value} is empty or {@code null}, all terms with the current qualifier will be removed.
     *
     * @param qualifier
     *            the qualifier for this term
     * @param value
     *            the value for this term. If empty or null, all terms with the current qualifier will be removed.
     * @return the gh query builder
     */
    GHQueryBuilder q(@Nonnull final String qualifier, @CheckForNull final String value) {
        if (StringUtils.isEmpty(qualifier)) {
            throw new IllegalArgumentException("qualifier cannot be null or empty");
        }
        if (StringUtils.isEmpty(value)) {
            final String removeQualifier = qualifier + ":";
            terms.removeIf(term -> term.startsWith(removeQualifier));
        } else {
            terms.add(qualifier + ":" + value);
        }
        return this;
    }

    /**
     * Performs the search.
     *
     * @return the paged search iterable
     */
    @Override
    public PagedSearchIterable list() {

        req.set("q", StringUtils.join(terms, " "));
        return new PagedSearchIterable<>(root(), req.build(), receiverType);
    }

    /**
     * Gets api url.
     *
     * @return the api url
     */
    protected abstract String getApiUrl();
}