Package dev.le_app.mcss_api_java

Enum Class ServerFilter

java.lang.Object

java.lang.Enum<ServerFilter>

dev.le_app.mcss_api_java.ServerFilter

All Implemented Interfaces:

Serializable, Comparable<ServerFilter>, Constable

public enum ServerFilter
extends Enum<ServerFilter>

A list of the possible filters for the server list.

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
FILTER	Filter for servers that have the same ServerType as a provided ServerID
NONE	No filter
OFFLINE	Filter for servers that are offline
ONLINE	Filter for servers that are online

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets associated value for the server filter - Used for API requests.
String	getValueStr()	Gets associated value for the server filter - Used for API requests.
static ServerFilter	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServerFilter[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final ServerFilter NONE

No filter

ONLINE

public static final ServerFilter ONLINE

Filter for servers that are online

OFFLINE

public static final ServerFilter OFFLINE

Filter for servers that are offline

FILTER

public static final ServerFilter FILTER

Filter for servers that have the same ServerType as a provided ServerID

Method Details

values

public static ServerFilter[] 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 ServerFilter 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

getValue

public int getValue()

Gets associated value for the server filter - Used for API requests.

Returns:

The server filter as INT.

getValueStr

public String getValueStr()

Gets associated value for the server filter - Used for API requests.

Returns:

The server filter as STRING.