org.kohsuke.github.GHFork 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
/**
 * The enum for Fork search mode.
 */
public enum GHFork {

    /**
     * Search in the parent repository and in forks with more stars than the parent repository.
     *
     * Forks with the same or fewer stars than the parent repository are still ignored.
     */
    PARENT_AND_FORKS("true"),

    /**
     * Search only in forks with more stars than the parent repository.
     *
     * The parent repository is ignored. If no forks have more stars than the parent, no results will be returned.
     */
    FORKS_ONLY("only"),

    /**
     * (Default) Search only the parent repository.
     *
     * Forks are ignored.
     */
    PARENT_ONLY("");

    private String filterMode;

    /**
     * Instantiates a new GH fork.
     *
     * @param mode
     *            the mode
     */
    GHFork(final String mode) {
        this.filterMode = mode;
    }

    /**
     * To string.
     *
     * @return the string
     */
    @Override
    public String toString() {
        return filterMode;
    }
}