org.gitlab4j.api

Enum Constants.SearchScope

java.lang.Object

java.lang.Enum<Constants.SearchScope>

org.gitlab4j.api.Constants.SearchScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Constants.SearchScope>

Enclosing interface:

Constants

public static enum Constants.SearchScope
extends java.lang.Enum<Constants.SearchScope>

Enum for the search scope when doing a globalSearch() with the SearchApi.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOBS
COMMITS
ISSUES
MERGE_REQUESTS
MILESTONES
PROJECTS
SNIPPET_BLOBS
SNIPPET_TITLES
USERS
WIKI_BLOBS

Method Summary

Modifier and Type	Method and Description
static Constants.SearchScope	forValue(java.lang.String value)
java.lang.String	toString()
java.lang.String	toValue()
static Constants.SearchScope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Constants.SearchScope[]	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

PROJECTS

public static final Constants.SearchScope PROJECTS

ISSUES

public static final Constants.SearchScope ISSUES

MERGE_REQUESTS

public static final Constants.SearchScope MERGE_REQUESTS

MILESTONES

public static final Constants.SearchScope MILESTONES

SNIPPET_TITLES

public static final Constants.SearchScope SNIPPET_TITLES

SNIPPET_BLOBS

public static final Constants.SearchScope SNIPPET_BLOBS

USERS

public static final Constants.SearchScope USERS

BLOBS

public static final Constants.SearchScope BLOBS

COMMITS

public static final Constants.SearchScope COMMITS

WIKI_BLOBS

public static final Constants.SearchScope WIKI_BLOBS

Method Detail

values

public static Constants.SearchScope[] 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 (Constants.SearchScope c : Constants.SearchScope.values())
    System.out.println(c);

Returns:

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

valueOf

public static Constants.SearchScope valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

forValue

public static Constants.SearchScope forValue(java.lang.String value)

toValue

public java.lang.String toValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Constants.SearchScope>