discord4j.rest.request

Class RouteMatcher

java.lang.Object

discord4j.rest.request.RouteMatcher

@Experimental
public class RouteMatcher
extends Object

A predicate that can match a given DiscordRequest. You can create instances of this class using the route(Route) factory, or through any() to provide a catch-all matcher.

Constructor Summary

Constructors

Constructor and Description
RouteMatcher(DiscordRequest<?> request, Predicate<Map<String,String>> requestVariableMatcher)

Method Summary

Modifier and Type	Method and Description
static RouteMatcher	any() Create a new RouteMatcher that returns true for every request.
boolean	matches(DiscordRequest<?> otherRequest) Tests this matcher against the given DiscordRequest.
static RouteMatcher	route(Route<?> route) Create a new RouteMatcher that matches any request made for the given Route.
static RouteMatcher	route(Route<?> route, Predicate<Map<String,String>> requestVariableMatcher) Create a new RouteMatcher that matches every request made for the given Route that also match a given Predicate of URI variables.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RouteMatcher

public RouteMatcher(DiscordRequest<?> request,
                    Predicate<Map<String,String>> requestVariableMatcher)

Method Detail

any

public static RouteMatcher any()

Create a new RouteMatcher that returns true for every request.

Returns:

a new RouteMatcher

route

public static RouteMatcher route(Route<?> route)

Create a new RouteMatcher that matches any request made for the given Route. A list of Route objects exist in the Routes class.

Parameters:

route - the Route to be matched by this instance

Returns:

a new RouteMatcher

route

public static RouteMatcher route(Route<?> route,
                                 Predicate<Map<String,String>> requestVariableMatcher)

Create a new RouteMatcher that matches every request made for the given Route that also match a given Predicate of URI variables.

The given predicate will receive a Map of String URI template parameters as keys and String values used to compile the URI for a DiscordRequest. This means you would expect keys as guild.id, channel.id, message.id, user.id, among others. Refer to the actual Route instances declared in the Routes class for the exact template keys used in the requests you want to match.

Parameters:

route - the Route to be matched by this instance

requestVariableMatcher - a Map of String keys and values representing the URI template and the completed value for a given DiscordRequest, respectively

Returns:

a new RouteMatcher

matches

public boolean matches(DiscordRequest<?> otherRequest)

Tests this matcher against the given DiscordRequest.

Parameters:

otherRequest - the DiscordRequest argument

Returns:

true if the input argument matches the predicate, otherwise false