Polishing

Make Point final and reduce PointCodec visibility. Introduce factory method for Point type. Update documentation.

[resolves #283][#282]

Author: mp911de

README.md

@@ -360,7 +360,7 @@ This reference table shows the type mapping between [PostgreSQL][p] and Java dat
 | [`oid`][psql-oid-ref]                           | [**`Integer`**][java-integer-ref], [`Boolean`][java-boolean-ref], [`Byte`][java-byte-ref], [`Short`][java-short-ref], [`Long`][java-long-ref], [`BigDecimal`][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref]|
 | [`path`][psql-path-ref]                         | Not yet supported.|
 | [`pg_lsn`][psql-pg_lsn-ref]                     | Not yet supported.|
-| [`point`][psql-point-ref]                       | Not yet supported.|
+| [`point`][psql-point-ref]                       | **`Point`**|
 | [`polygon`][psql-polygon-ref]                   | Not yet supported.|
 | [`real`][psql-real-ref]                         | [**`Float`**][java-float-ref], [`Double`][java-double-ref], [`Boolean`][java-boolean-ref], [`Byte`][java-byte-ref], [`Short`][java-short-ref], [`Integer`][java-integer-ref], [`Long`][java-long-ref], [`BigDecimal`][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref]|
 | [`smallint`][psql-smallint-ref]                 | [**`Short`**][java-short-ref], [`Boolean`][java-boolean-ref], [`Byte`][java-byte-ref], [`Integer`][java-integer-ref], [`Long`][java-long-ref], [`BigDecimal`][java-bigdecimal-ref], [`BigInteger`][java-biginteger-ref]|

src/main/java/io/r2dbc/postgresql/codec/Point.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 the original author or authors.
+ * Copyright 2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,103 +17,81 @@
 package io.r2dbc.postgresql.codec;
 
 /**
- * <p>It maps to the point datatype in org.postgresql.</p>
- *
- * <p> It uses double to represent the coordinates.</p>
+ * Value object that maps to the {@code point} datatype in Postgres.
+ * <p>
+ * Uses {@code double} to represent the coordinates.
  */
-public class Point {
+public final class Point {
 
     private final double x;
 
     private final double y;
 
-    /**
-     * @param x coordinate
-     * @param y coordinate
-     */
-    public Point(double x, double y) {
+    private Point(double x, double y) {
         this.x = x;
         this.y = y;
     }
 
+    /**
+     * Create a new {@link Point} given {@code x} and {@code y} coordinates.
+     *
+     * @param x the x axis coordinate
+     * @param y the y axis coordinate
+     * @return the new {@link Point} object
+     */
+    public static Point of(double x, double y) {
+        return new Point(x, y);
+    }
+
     public double getX() {
-        return x;
+        return this.x;
     }
 
     public double getY() {
-        return y;
+        return this.y;
     }
 
     /**
-     * Translate the point by the supplied amount.
+     * Translate the point by the supplied amount by adding {@code x} and {@code y} offsets.
      *
      * @param x integer amount to add on the x axis
      * @param y integer amount to add on the y axis
-     * @return - new point with translated values
+     * @return new {@link Point} with translated values
      */
     public Point translate(int x, int y) {
         return translate((double) x, (double) y);
     }
 
     /**
-     * Translate the point by the supplied amount.
+     * Translate the point by the supplied amount by adding {@code x} and {@code y} offsets.
      *
      * @param x double amount to add on the x axis
      * @param y double amount to add on the y axis
-     * @return - new point with translated values
+     * @return new {@link Point} with translated values
      */
     public Point translate(double x, double y) {
         return new Point(this.x + x, this.y + y);
     }
 
-    /**
-     * Moves the point to the supplied coordinates.
-     *
-     * @param x integer coordinate
-     * @param y integer coordinate
-     */
-    public Point move(int x, int y) {
-        return setLocation(x, y);
-    }
-
-    /**
-     * Moves the point to the supplied coordinates.
-     *
-     * @param x double coordinate
-     * @param y double coordinate
-     * @return - new point with provided coordinates
-     */
-    public Point move(double x, double y) {
-        return new Point(x, y);
-    }
-
-    /**
-     * Moves the point to the supplied coordinates.
-     *
-     * @param x integer coordinate
-     * @param y integer coordinate
-     * @return - return new Point with these coordinates
-     */
-    public Point setLocation(int x, int y) {
-        return move((double) x, (double) y);
-    }
-
+    @Override
     public boolean equals(Object obj) {
         if (obj instanceof Point) {
             Point p = (Point) obj;
-            return x == p.x && y == p.y;
+            return this.x == p.x && this.y == p.y;
         }
         return false;
     }
 
+    @Override
     public int hashCode() {
-        long v1 = Double.doubleToLongBits(x);
-        long v2 = Double.doubleToLongBits(y);
+        long v1 = Double.doubleToLongBits(this.x);
+        long v2 = Double.doubleToLongBits(this.y);
         return (int) (v1 ^ v2 ^ (v1 >>> 32) ^ (v2 >>> 32));
     }
 
+    @Override
     public String toString() {
-        return "(" + x + "," + y + ")";
+        return "(" + this.x + "," + this.y + ")";
     }
 
 }

src/main/java/io/r2dbc/postgresql/codec/PointCodec.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 the original author or authors.
+ * Copyright 2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@
 import static io.r2dbc.postgresql.message.Format.FORMAT_BINARY;
 import static io.r2dbc.postgresql.type.PostgresqlObjectId.POINT;
 
-public class PointCodec extends AbstractCodec<Point> {
+final class PointCodec extends AbstractCodec<Point> {
 
     private final ByteBufAllocator byteBufAllocator;
 
@@ -53,15 +53,16 @@ Point doDecode(ByteBuf buffer, PostgresqlObjectId dataType, Format format, Class
         if (format == FORMAT_BINARY) {
             double x = buffer.readDouble();
             double y = buffer.readDouble();
-            return new Point(x, y);
-        } else {
-            String decodedAsString = ByteBufUtils.decode(buffer);
-            String parenRemovedVal = decodedAsString.replaceAll("[()]", "");
-            String[] coordinatesAsString = parenRemovedVal.split(",");
-            double x = Double.parseDouble(coordinatesAsString[0]);
-            double y = Double.parseDouble(coordinatesAsString[1]);
-            return new Point(x, y);
+            return Point.of(x, y);
         }
+
+
+        String decodedAsString = ByteBufUtils.decode(buffer);
+        String parenRemovedVal = decodedAsString.replaceAll("[()]", "");
+        String[] coordinatesAsString = parenRemovedVal.split(",");
+        double x = Double.parseDouble(coordinatesAsString[0]);
+        double y = Double.parseDouble(coordinatesAsString[1]);
+        return Point.of(x, y);
     }
 
     /**
@@ -79,7 +80,7 @@ public Parameter encodeNull() {
         return createNull(POINT, FORMAT_BINARY);
     }
 
-    public int lengthInBytes() {
+    int lengthInBytes() {
         return 16;
     }
 

src/test/java/io/r2dbc/postgresql/AbstractCodecIntegrationTests.java

@@ -363,7 +363,9 @@ void offsetDateTime() {
 
     @Test
     void point() {
-        testCodec(Point.class, new Point(1.12, 2.12), "POINT");
+        testCodec(Point.class, Point.of(1.12, 2.12), "POINT");
+        testCodec(Point.class, Point.of(Integer.MIN_VALUE, Integer.MAX_VALUE), "POINT");
+        testCodec(Point.class, Point.of(Double.MIN_VALUE, Double.MAX_VALUE), "POINT");
     }
 
     @Test

src/test/java/io/r2dbc/postgresql/codec/PointCodecTest.java

@@ -74,7 +74,7 @@ void doDecodeNoFormat() {
     @Test
     void doDecode() {
         PointCodec codec = new PointCodec(TEST);
-        Point point = new Point(1.12, 2.12);
+        Point point = Point.of(1.12, 2.12);
         ByteBuf pointAsBinary = TEST.buffer(codec.lengthInBytes()).writeDouble(1.12).writeDouble(2.12);
         assertThat(codec.doDecode(pointAsBinary, POINT, FORMAT_BINARY, Point.class)).isEqualTo(point);
     }
@@ -90,7 +90,7 @@ void doEncode() {
         PointCodec codec = new PointCodec(TEST);
         ByteBuf pointAsBinary = TEST.buffer(codec.lengthInBytes()).writeDouble(1.12).writeDouble(2.12);
 
-        ParameterAssert.assertThat(codec.doEncode(new Point(1.12, 2.12)))
+        ParameterAssert.assertThat(codec.doEncode(Point.of(1.12, 2.12)))
             .hasFormat(FORMAT_BINARY)
             .hasType(POINT.getObjectId())
             .hasValue(pointAsBinary);