io.r2dbc.postgresql.codec.Box Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of r2dbc-postgresql Show documentation

Reactive Relational Database Connectivity Driver Implementation for Postgresql

There is a newer version: 0.8.13.RELEASE

package io.r2dbc.postgresql.codec;

import io.r2dbc.postgresql.util.Assert;

import java.util.Objects;

/**
 * Value object that maps to the {@code box} datatype in Postgres.
 * 
 * Uses {@code double} to represent the coordinates.
 *
 * @since 0.8.5
 */
public final class Box {

    /**
     * Typically upper right corner.
     */
    private final Point a;

    /**
     * Typically lower left corner.
     */
    private final Point b;

    private Box(Point a, Point b) {
        this.a = Assert.requireNonNull(a, "point A must not be null");
        this.b = Assert.requireNonNull(b, "point B must not be null");
    }

    /**
     * Create a new {@link Box} given parameters {@link Point points }{@code a} and {@code b}.
     * Any two opposite corners can be supplied on input, but the values will be reordered as needed to store the upper right and lower left corners, in that order.
     *
     * @param a first corner
     * @param b second corner
     * @return the new {@link Box} object
     * @throws IllegalArgumentException if {@code a} or {@code b} is {@code null}
     */
    public static Box of(Point a, Point b) {
        return new Box(a, b);
    }

    public Point getA() {
        return this.a;
    }

    public Point getB() {
        return this.b;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Box box = (Box) o;
        return (this.a.equals(box.a) && this.b.equals(box.b))
            || (this.a.equals(box.b) && this.b.equals(box.a));
    }

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

    @Override
    public String toString() {
        return String.format("(%s,%s)", this.a, this.b);
    }

}