xyz.jpenilla.squaremap.api.Pair Maven / Gradle / Ivy

Go to download
package xyz.jpenilla.squaremap.api;

import java.util.Objects;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Data class for holding a pair of non-null objects with generic types.
 *
 * @param  Left generic type argument
 * @param  Right generic type argument
 */
public final class Pair {
    private final L left;
    private final R right;

    private Pair(final @NonNull L left, final @NonNull R right) {
        this.left = left;
        this.right = right;
    }

    /**
     * Get the left value
     *
     * @return Left value
     */
    public @NonNull L left() {
        return this.left;
    }

    /**
     * Get the right value
     *
     * @return Right value
     */
    public @NonNull R right() {
        return this.right;
    }

    @Override
    public boolean equals(final @Nullable Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || this.getClass() != o.getClass()) {
            return false;
        }
        final @Nullable Pair pair = (Pair) o;
        return this.left.equals(pair.left) && this.right.equals(pair.right);
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.left, this.right);
    }

    /**
     * Create a new Pair
     *
     * @param left  Left value
     * @param right Right value
     * @param    Left generic type
     * @param    Right generic type
     * @return new pair
     */
    public static  @NonNull Pair of(final @NonNull L left, final @NonNull R right) {
        return new Pair<>(left, right);
    }
}