org.kohsuke.github.SearchResult 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 edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

// TODO: Auto-generated Javadoc
/**
 * Represents the result of a search.
 *
 * @author Kohsuke Kawaguchi
 * @param 
 *            the generic type
 */
abstract class SearchResult {

    /** The total count. */
    @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
    int total_count;

    /** The incomplete results. */
    @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "Field comes from JSON deserialization")
    boolean incomplete_results;

    /**
     * Wraps up the retrieved object and return them. Only called once.
     *
     * @param root
     *            the root
     * @return the items
     */
    abstract T[] getItems(GitHub root);
}