Package com.jcabi.github

Enum Search.Qualifier

java.lang.Object

java.lang.Enum<Search.Qualifier>

com.jcabi.github.Search.Qualifier

All Implemented Interfaces:

StringEnum, Serializable, Comparable<Search.Qualifier>

Enclosing interface:

Search

public static enum Search.Qualifier
extends Enum<Search.Qualifier>
implements StringEnum

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSIGNEE	Finds issues that are assigned to a certain user.
AUTHOR	Finds issues created by a certain user.
CLOSED	Filters issues based on the date when they were closed.
COMMENTER	Finds issues that a certain user commented on.
COMMENTS	Filters issues based on the quantity of comments.
CREATED	Filters issues based on date of creation.
IN	Qualifies which fields are searched.
INVOLVES	Finds issues that were either created by a certain user.
IS	Searches for items within repositories that match a certain state.
LABEL	Filters issues based on their labels.
LANGUAGE	Searches for issues within repositories matching a certain language.
MENTIONS	Finds issues that mention a certain user.
MERGED	Filters pull requests based on the date when they were merged.
NO	Filters items missing certain metadata.
REPO	Limits searches to a specific repository.
STATE	Filter issues based on whether they’re open or closed.
TEAM	Finds issues or pull requests which mention a particular team within an organization which the user is a member of.
TYPE	The search by issues or pull request only.
UPDATED	Filters issues based on date last updated.
USER	Limits searches to a specific user.

Method Summary

Modifier and Type	Method	Description
String	identifier()	Get search qualifier.
static Search.Qualifier	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Search.Qualifier[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TYPE

public static final Search.Qualifier TYPE

The search by issues or pull request only.

IN

public static final Search.Qualifier IN

Qualifies which fields are searched.

With this qualifier you can restrict the search to just the title, body, comments, or any combination of these.

AUTHOR

public static final Search.Qualifier AUTHOR

Finds issues created by a certain user.

ASSIGNEE

public static final Search.Qualifier ASSIGNEE

Finds issues that are assigned to a certain user.

MENTIONS

public static final Search.Qualifier MENTIONS

Finds issues that mention a certain user.

COMMENTER

public static final Search.Qualifier COMMENTER

Finds issues that a certain user commented on.

INVOLVES

public static final Search.Qualifier INVOLVES

Finds issues that were either created by a certain user.

Or assigned to that user, mention that user, or were commented on by that user.

TEAM

public static final Search.Qualifier TEAM

Finds issues or pull requests which mention a particular team within an organization which the user is a member of.

STATE

public static final Search.Qualifier STATE

Filter issues based on whether they’re open or closed.

LABEL

public static final Search.Qualifier LABEL

Filters issues based on their labels.

NO

public static final Search.Qualifier NO

Filters items missing certain metadata.

LANGUAGE

public static final Search.Qualifier LANGUAGE

Searches for issues within repositories matching a certain language.

IS

public static final Search.Qualifier IS

Searches for items within repositories that match a certain state.

CREATED

public static final Search.Qualifier CREATED

Filters issues based on date of creation.

UPDATED

public static final Search.Qualifier UPDATED

Filters issues based on date last updated.

MERGED

public static final Search.Qualifier MERGED

Filters pull requests based on the date when they were merged.

CLOSED

public static final Search.Qualifier CLOSED

Filters issues based on the date when they were closed.

COMMENTS

public static final Search.Qualifier COMMENTS

Filters issues based on the quantity of comments.

USER

public static final Search.Qualifier USER

Limits searches to a specific user.

REPO

public static final Search.Qualifier REPO

Limits searches to a specific repository.

Method Detail

values

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

Returns:

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

valueOf

public static Search.Qualifier 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

identifier

public String identifier()

Get search qualifier.

Specified by:

identifier in interface StringEnum

Returns:

String