samophis.lavalink.client.entities

Enum LoadType

java.lang.Object

java.lang.Enum<LoadType>

samophis.lavalink.client.entities.LoadType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LoadType>

public enum LoadType
extends java.lang.Enum<LoadType>

Represents the type of the loaded source from the LavaHttpManager.resolveTracks(String, Consumer) method.

Note: In the earlier versions of Lavalink, LOAD_FAILED or NO_MATCHES will never be returned. This is because these versions only have an isPlaylist field, and some (v2) don't even have that.
Only the very latest versions of v3 have support for load types.

Since:

2.3.0

Author:

Sam Pritchard

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOAD_FAILED If Lavaplayer failed to load the audio source.
NO_MATCHES If no matches for the provided identifier could be found.
PLAYLIST_LOADED If a playlist was loaded.
SEARCH_RESULT If a search result was loaded.
TRACK_LOADED If a single AudioTrack was loaded.
UNKNOWN If Lavalink didn't work properly or if an unrecognized load type was returned.

Method Summary

Modifier and Type	Method and Description
static LoadType	from(java.lang.String name) Returns the LoadType associated with a provided name, returning UNKNOWN otherwise.
static LoadType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LoadType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRACK_LOADED

public static final LoadType TRACK_LOADED

If a single AudioTrack was loaded.

PLAYLIST_LOADED

public static final LoadType PLAYLIST_LOADED

If a playlist was loaded.

SEARCH_RESULT

public static final LoadType SEARCH_RESULT

If a search result was loaded.

NO_MATCHES

public static final LoadType NO_MATCHES

If no matches for the provided identifier could be found.

LOAD_FAILED

public static final LoadType LOAD_FAILED

If Lavaplayer failed to load the audio source.

UNKNOWN

public static final LoadType UNKNOWN

If Lavalink didn't work properly or if an unrecognized load type was returned.

Method Detail

values

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

Returns:

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

valueOf

public static LoadType 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

from

@Nonnull
public static LoadType from(@Nonnull
                                     java.lang.String name)

Returns the LoadType associated with a provided name, returning UNKNOWN otherwise.

Parameters:

name - The not-null name to search for.

Returns:

A not-null LoadType.