discord4j.gateway.ShardInfo Maven / Gradle / Ivy

Go to download
/*
 * 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.gateway;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import reactor.util.annotation.Nullable;
import reactor.util.function.Tuple2;
import reactor.util.function.Tuples;

import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;

/**
 * A container to express a shard index and count.
 */
public class ShardInfo {

    private static final Map, ShardInfo> CACHE = new ConcurrentHashMap<>();

    private final int index;
    private final int count;

    private ShardInfo(int index, int count) {
        this.index = index;
        this.count = count;
    }

    @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
    public static ShardInfo create(@JsonProperty("index") int index, @JsonProperty("count") int count) {
        return CACHE.computeIfAbsent(Tuples.of(index, count), t2 -> new ShardInfo(t2.getT1(), t2.getT2()));
    }

    /**
     * Return the shard index represented by this {@link ShardInfo}.
     *
     * @return the shard number (0-based)
     */
    public int getIndex() {
        return index;
    }

    /**
     * Return the shard count represented by this {@link ShardInfo}.
     *
     * @return the number of shards
     */
    public int getCount() {
        return count;
    }

    /**
     * Return this {@link ShardInfo} object in array representation: [index, count]
     *
     * @return an array with 2 elements, {@code index} and {@code count}
     */
    public int[] asArray() {
        return new int[]{index, count};
    }

    @Override
    public boolean equals(@Nullable Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        ShardInfo shardInfo = (ShardInfo) o;
        return index == shardInfo.index && count == shardInfo.count;
    }

    @Override
    public int hashCode() {
        return Objects.hash(index, count);
    }

    /**
     * Return a string form of this {@link ShardInfo} using the following pattern: {@code index,count}
     *
     * @return a formatted string representing this object
     */
    public String format() {
        return index + "," + count;
    }

    @Override
    public String toString() {
        return "ShardInfo{" +
                "index=" + index +
                ", count=" + count +
                '}';
    }
}