com.plotsquared.core.plot.PlotId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of plotsquared-core Show documentation
PlotSquared, a land and world management plugin for Minecraft.
There is a newer version: 7.4.0
/*
 * PlotSquared, a land and world management plugin for Minecraft.
 * Copyright (C) IntellectualSites 
 * Copyright (C) IntellectualSites team and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.plotsquared.core.plot;

import com.plotsquared.core.location.Direction;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * The PlotId class represents a Plot's x and y coordinates within a {@link PlotArea}. PlotId x,y values do not correspond to Block locations.
 * A PlotId instance can be created using the {@link #of(int, int)} method or parsed from a string using the {@link #fromString(String)} method.
 */
public final class PlotId {

    private final int x;
    private final int y;
    private final int hash;

    /**
     * Constructs a new PlotId with the given x and y coordinates.
     *
     * @param x the x-coordinate of the plot
     * @param y the y-coordinate of the plot
     */
    private PlotId(final int x, final int y) {
        this.x = x;
        this.y = y;
        this.hash = (this.getX() << 16) | (this.getY() & 0xFFFF);
    }

    /**
     * Returns a new PlotId instance with the specified x and y coordinates.
     *
     * @param x the x-coordinate of the plot
     * @param y the y-coordinate of the plot
     * @return a new PlotId instance with the specified x and y coordinates
     */
    public static @NonNull PlotId of(final int x, final int y) {
        return new PlotId(x, y);
    }

    /**
     * Get a Plot Id based on a string
     *
     * @param string to create id from
     * @return the PlotId representation of the argument
     * @throws IllegalArgumentException if the string does not contain a valid PlotId
     */
    public static @NonNull PlotId fromString(final @NonNull String string) {
        final PlotId plot = fromStringOrNull(string);
        if (plot == null) {
            throw new IllegalArgumentException("Cannot create PlotID. String invalid.");
        }
        return plot;
    }

    /**
     * Returns a PlotId object from the given string, or null if the string is invalid.
     * The string should be in the format "x;y" where x and y are integers.
     * The string can also contain any combination of the characters ";_,."
     * as delimiters.
     *
     * @param string the string to parse
     * @return a PlotId object parsed from the given string, or null if the string is invalid
     */
    public static @Nullable PlotId fromStringOrNull(final @NonNull String string) {
        final String[] parts = string.split("[;_,.]");
        if (parts.length < 2) {
            return null;
        }
        int x;
        int y;
        try {
            x = Integer.parseInt(parts[0]);
            y = Integer.parseInt(parts[1]);
        } catch (final NumberFormatException ignored) {
            return null;
        }
        return of(x, y);
    }


    /**
     * Returns a new PlotId instance from the given hash.
     *
     * @param hash the hash to unpair
     * @return a new PlotId instance
     */
    public static @NonNull PlotId unpair(final int hash) {
        return PlotId.of(hash >> 16, hash & 0xFFFF);
    }

    /**
     * Returns the x-coordinate of this Plot ID.
     *
     * @return the x-coordinate of this Plot ID
     */
    public int getX() {
        return this.x;
    }

    /**
     * Returns the y-coordinate of this Plot ID.
     *
     * @return the y-coordinate of this Plot ID
     */
    public int getY() {
        return this.y;
    }

    /**
     * Returns the next Plot ID for claiming purposes based on the current Plot ID.
     *
     * @return the next Plot ID
     */
    public @NonNull PlotId getNextId() {
        final int absX = Math.abs(x);
        final int absY = Math.abs(y);
        if (absX > absY) {
            if (x > 0) {
                return PlotId.of(x, y + 1);
            } else {
                return PlotId.of(x, y - 1);
            }
        } else if (absY > absX) {
            if (y > 0) {
                return PlotId.of(x - 1, y);
            } else {
                return PlotId.of(x + 1, y);
            }
        } else {
            if (x == y && x > 0) {
                return PlotId.of(x, y + 1);
            }
            if (x == absX) {
                return PlotId.of(x, y + 1);
            }
            if (y == absY) {
                return PlotId.of(x, y - 1);
            }
            return PlotId.of(x + 1, y);
        }
    }

    /**
     * Returns a new Plot ID in the specified relative direction based on the
     * current Plot ID.
     *
     * @param direction the direction in which to get the relative Plot ID
     * @return the relative Plot ID
     */
    public @NonNull PlotId getRelative(final @NonNull Direction direction) {
        return switch (direction) {
            case NORTH -> PlotId.of(this.getX(), this.getY() - 1);
            case EAST -> PlotId.of(this.getX() + 1, this.getY());
            case SOUTH -> PlotId.of(this.getX(), this.getY() + 1);
            case WEST -> PlotId.of(this.getX() - 1, this.getY());
            default -> this;
        };
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (this.hashCode() != obj.hashCode()) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final PlotId other = (PlotId) obj;
        return this.getX() == other.getX() && this.getY() == other.getY();
    }

    /**
     * Returns a string representation of this Plot ID in the format "x;y".
     *
     *  The format is {@code x + ";" + y}
     *
     * @return a string representation of this Plot ID
     */
    @Override
    public @NonNull String toString() {
        return this.getX() + ";" + this.getY();
    }

    /**
     * Returns a string representation of this Plot ID with the specified separator.
     * 
     * The format is {@code x + separator + y}
     *
     * @param separator the separator to use between the X and Y coordinates
     * @return a string representation of this Plot ID with the specified separator
     */
    public @NonNull String toSeparatedString(String separator) {
        return this.getX() + separator + this.getY();
    }

    /**
     * Returns a string representation of this Plot ID in the format "x,y".
     *
     * @return a string representation of this Plot ID
     */
    public @NonNull String toCommaSeparatedString() {
        return this.getX() + "," + this.getY();
    }

    /**
     * Returns a string representation of this Plot ID in the format "x_y".
     *
     * @return a string representation of this Plot ID
     */

    public @NonNull String toUnderscoreSeparatedString() {
        return this.getX() + "_" + this.getY();
    }

    /**
     * Returns a string representation of this Plot ID in the format "x-y".
     *
     * @return a string representation of this Plot ID
     */
    public @NonNull String toDashSeparatedString() {
        return this.getX() + "-" + this.getY();
    }

    @Override
    public int hashCode() {
        return this.hash;
    }


    /**
     * An iterator that iterates over a range of {@link PlotId}s.
     * The range is defined by a start and end {@link PlotId}.
     */
    public static final class PlotRangeIterator implements Iterator, Iterable {

        private final PlotId start;
        private final PlotId end;

        private int x;
        private int y;

        private PlotRangeIterator(final @NonNull PlotId start, final @NonNull PlotId end) {
            this.start = start;
            this.end = end;
            this.x = this.start.getX();
            this.y = this.start.getY();
        }

        /**
         * Returns a new {@link PlotRangeIterator} that iterates over the range of Plots between the specified start and end Plots (inclusive).
         *
         * @param start the starting Plot of the range
         * @param end the ending Plot of the range
         * @return a new {@link PlotRangeIterator} that iterates over the range of Plots between the specified start and end Plots (inclusive)
         */
        public static PlotRangeIterator range(final @NonNull PlotId start, final @NonNull PlotId end) {
            return new PlotRangeIterator(start, end);
        }

        @Override
        public boolean hasNext() {
            // end is fully included
            return this.x <= this.end.getX() && this.y <= this.end.getY();
        }

        @Override
        public PlotId next() {
            if (!hasNext()) {
                throw new NoSuchElementException("The iterator has no more entries");
            }
            // increment *after* getting the result to include the minimum
            // the id to return
            PlotId result = PlotId.of(this.x, this.y);
            // first increase y, then x
            if (this.y == this.end.getY()) {
                this.x++;
                this.y = this.start.getY();
            } else {
                this.y++;
            }
            return result;
        }

        @NonNull
        @Override
        public Iterator iterator() {
            return this;
        }

    }

}