discord4j.rest.request.BucketKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of discord4j-rest Show documentation
A JVM-based REST/WS wrapper for the official Discord Bot API
There is a newer version: 3.3.0-RC2
/*
 * This file is part of Discord4J.
 *
 * Discord4J is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Discord4J is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Discord4J.  If not, see .
 */
package discord4j.rest.request;

import discord4j.rest.route.Route;
import discord4j.rest.route.Routes;
import discord4j.rest.util.RouteUtils;
import reactor.util.annotation.Nullable;

import java.util.Objects;

/**
 * Used to access the appropriate {@link RequestStream RequestStream} according to the bucket
 * that requests for the stream fall into.
 * 
 * Following the 
 * Discord documentation, requests belong to the same bucket if:
 * 

 * The {@link Route#getUriTemplate()} are equal.
 * The {@link #majorParam major parameters} are equal.
 * 
 * Note that HTTP method is not considered (requests fall into the same bucket even if the methods are different)
 * in all but one case. Requests on the {@link Routes#MESSAGE_DELETE message delete route} fall
 * into a separate bucket.
 * 
 * This is a value-based class.
 *
 * @since 3.0
 */
public final class BucketKey {

    private final String uriTemplate;
    @Nullable
    private final String majorParam;

    private BucketKey(String uriTemplate, String completeUri) {
        this.uriTemplate = uriTemplate;
        this.majorParam = RouteUtils.getMajorParam(uriTemplate, completeUri);
    }

    public static BucketKey of(String uriTemplate, String completeUri) {
        return new BucketKey(uriTemplate, completeUri);
    }

    public static BucketKey of(DiscordWebRequest request) {
        if (Routes.MESSAGE_DELETE.equals(request.getRoute())) {
            return BucketKey.of("DELETE " + request.getRoute().getUriTemplate(), request.getCompleteUri());
        }
        return BucketKey.of(request.getRoute().getUriTemplate(), request.getCompleteUri());
    }

    @Override
    public int hashCode() {
        return Objects.hash(uriTemplate, majorParam);
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }

        BucketKey bucket = (BucketKey) obj;

        return uriTemplate.equals(bucket.uriTemplate) && Objects.equals(majorParam, bucket.majorParam);
    }

    @Override
    public String toString() {
        return Integer.toHexString(hashCode());
    }
}