org.kohsuke.github.GHQueryBuilder 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;

// TODO: Auto-generated Javadoc
/**
 * Used to specify filters, sort order, etc for listing items in a collection.
 *
 * @author Kohsuke Kawaguchi
 * @param 
 *            the type parameter
 */
public abstract class GHQueryBuilder extends GitHubInteractiveObject {

    /** The req. */
    protected final Requester req;

    /**
     * Instantiates a new GH query builder.
     *
     * @param root
     *            the root
     */
    GHQueryBuilder(GitHub root) {
        super(root);
        this.req = root.createRequest();
    }

    /**
     * Start listing items by using the settings built up on this object.
     *
     * @return the paged iterable
     */
    public abstract PagedIterable list();
}