discord4j.rest.route

Class Route

java.lang.Object

discord4j.rest.route.Route

public class Route
extends Object

Provides a mapping between a Discord API endpoint and its response type.

Method Summary

Modifier and Type	Method and Description
static Route	delete(String uri)
boolean	equals(Object obj)
static Route	get(String uri)
HttpMethod	getMethod() Return the HTTP method for this route.
String	getUriTemplate() Return the URI template that defines this route.
int	hashCode()
DiscordWebRequest	newRequest(Object... uriVars) Prepare a request, expanding this route template URI with the given parameters.
static Route	patch(String uri)
static Route	post(String uri)
static Route	put(String uri)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

get

public static Route get(String uri)

post

public static Route post(String uri)

put

public static Route put(String uri)

patch

public static Route patch(String uri)

delete

public static Route delete(String uri)

getMethod

public HttpMethod getMethod()

Return the HTTP method for this route.

Returns:

the HttpMethod of this Route

newRequest

public DiscordWebRequest newRequest(Object... uriVars)

Prepare a request, expanding this route template URI with the given parameters.

Parameters:

uriVars - the values to expand each template parameter

Returns:

a request that is ready to be routed

See Also:

DiscordWebRequest.exchange(discord4j.rest.request.Router)

getUriTemplate

public String getUriTemplate()

Return the URI template that defines this route.

Returns:

a URI template, probably containing path parameters, that is defining this Route

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object