xyz.lamergameryt.allen4j

Enum APIEndpoint

java.lang.Object

java.lang.Enum<APIEndpoint>

xyz.lamergameryt.allen4j.APIEndpoint

All Implemented Interfaces:

Serializable, Comparable<APIEndpoint>

public enum APIEndpoint
extends Enum<APIEndpoint>

The APIEndpoint enum contains all the endpoints that the Allen API has.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SEARCH
SELF_PROFILE
STUDENT_PROFILE

Method Summary

Modifier and Type	Method and Description
String	toString() Returns the enum, converted to api endpoint url.
static APIEndpoint	valueOf(String name) Returns the enum constant of this type with the specified name.
static APIEndpoint[]	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

STUDENT_PROFILE

public static final APIEndpoint STUDENT_PROFILE

SELF_PROFILE

public static final APIEndpoint SELF_PROFILE

SEARCH

public static final APIEndpoint SEARCH

Method Detail

values

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

Returns:

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

valueOf

public static APIEndpoint 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()

Returns the enum, converted to api endpoint url.

Overrides:

toString in class Enum<APIEndpoint>

Returns:

The respective api endpoint.