Package io.github.thoroldvix.api

Enum Class YtApiV3Endpoint

java.lang.Object

java.lang.Enum<YtApiV3Endpoint>

io.github.thoroldvix.api.YtApiV3Endpoint

All Implemented Interfaces:

Serializable, Comparable<YtApiV3Endpoint>, Constable

public enum YtApiV3Endpoint
extends Enum<YtApiV3Endpoint>

The YouTube API V3 endpoints. Used by the YoutubeClient.

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
CHANNELS
PLAYLIST_ITEMS
SEARCH

Method Summary

Modifier and Type	Method	Description
String	toString()
String	url()
String	url(Map<String,String> params)
static YtApiV3Endpoint	valueOf(String name)	Returns the enum constant of this class with the specified name.
static YtApiV3Endpoint[]	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

PLAYLIST_ITEMS

public static final YtApiV3Endpoint PLAYLIST_ITEMS

SEARCH

public static final YtApiV3Endpoint SEARCH

CHANNELS

public static final YtApiV3Endpoint CHANNELS

Method Details

values

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

url

public String url()

Returns:

The URL of the endpoint.

url

public String url(Map<String,String> params)

Parameters:

params - A map of parameters to include in the request.

Returns:

The URL of the endpoint with the specified parameters.

toString

public String toString()

Overrides:

toString in class Enum<YtApiV3Endpoint>