Package org.kohsuke.github

Enum GHFork

java.lang.Object

java.lang.Enum<GHFork>

org.kohsuke.github.GHFork

All Implemented Interfaces:

Serializable, Comparable<GHFork>

public enum GHFork
extends Enum<GHFork>

The enum for Fork search mode.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORKS_ONLY	Search only in forks with more stars than the parent repository.
PARENT_AND_FORKS	Search in the parent repository and in forks with more stars than the parent repository.
PARENT_ONLY	(Default) Search only the parent repository.

Method Summary

Modifier and Type	Method	Description
String	toString()	To string.
static GHFork	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GHFork[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PARENT_AND_FORKS

public static final GHFork PARENT_AND_FORKS

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.

FORKS_ONLY

public static final GHFork FORKS_ONLY

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.

PARENT_ONLY

public static final GHFork PARENT_ONLY

(Default) Search only the parent repository. Forks are ignored.

Method Detail

values

public static GHFork[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GHFork c : GHFork.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GHFork valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

To string.

Overrides:

toString in class Enum<GHFork>

Returns:

the string