Package io.github.coho04.githubapi.enums

Enum Class GHRole

java.lang.Object

java.lang.Enum<GHRole>

io.github.coho04.githubapi.enums.GHRole

All Implemented Interfaces:

Serializable, Comparable<GHRole>, Constable

public enum GHRole
extends Enum<GHRole>

Enum representing the different roles a GitHub user can have. The roles include ADMIN, DIRECT_MEMBER, BILLING_MANAGER, and REINSTATE.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMIN	Represents an admin role.
BILLING_MANAGER	Represents a billing manager role.
DIRECT_MEMBER	Represents a direct member role.
REINSTATE	Represents a reinstate role.

Method Summary

Modifier and Type	Method	Description
String	toString()	Converts the enum value to a lowercase string.
static GHRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GHRole[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ADMIN

public static final GHRole ADMIN

Represents an admin role.

DIRECT_MEMBER

public static final GHRole DIRECT_MEMBER

Represents a direct member role.

BILLING_MANAGER

public static final GHRole BILLING_MANAGER

Represents a billing manager role.

REINSTATE

public static final GHRole REINSTATE

Represents a reinstate role.

Method Details

values

public static GHRole[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static GHRole valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Converts the enum value to a lowercase string.

Overrides:

toString in class Enum<GHRole>

Returns:

The lowercase string representation of the enum value.