changes to deploy 1.0

javadoc and comments pom.xml changes release by running `mvn deploy` instructions from https://blog.10pines.com/2018/06/25/publish-artifacts-on-maven-central/ settings in ` ~/.m2/settings.xml`
oshai · Feb 3, 2023 · ead53a3 · ead53a3
1 parent 676e514
commit ead53a3
Show file tree

Hide file tree

Showing 12 changed files with 114 additions and 231 deletions.
diff --git a/pom.xml b/pom.xml
@@ -6,8 +6,43 @@
 
     <groupId>io.github.oshai</groupId>
     <artifactId>jooq-postgis-spatial</artifactId>
-    <version>1.0-SNAPSHOT</version>
-
+    <version>1.0</version>
+    <packaging>jar</packaging>
+    <name>jooq-postgis-spatial</name>
+    <description>jOOQ data type converters and binders for PostGIS spatial database.</description>
+    <url>https://github.com/oshai/jooq-postgis-spatial</url>
+    <licenses>
+        <license>
+            <name>The Apache Software License, Version 2.0</name>
+            <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
+        </license>
+    </licenses>
+    <developers>
+        <developer>
+            <name>Ohad Shai</name>
+            <email>[email protected]</email>
+            <organization>github</organization>
+            <organizationUrl>https://www.github.com</organizationUrl>
+        </developer>
+    </developers>
+    <scm>
+        <connection>scm:git:git://github.com/oshai/jooq-postgis-spatial.git</connection>
+        <developerConnection>scm:git:ssh://github.com:oshai/jooq-postgis-spatial.git</developerConnection>
+        <url>https://github.com/oshai/jooq-postgis-spatial/tree/master</url>
+    </scm>
+    <distributionManagement>
+        <!-- see https://blog.10pines.com/2018/06/25/publish-artifacts-on-maven-central/ -->
+        <snapshotRepository>
+            <id>sonatype-nexus-snapshots</id>
+            <name>Sonatype Nexus Snapshots</name>
+            <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
+        </snapshotRepository>
+        <repository>
+            <id>sonatype-nexus-staging</id>
+            <name>Nexus Release Repository</name>
+            <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2</url>
+        </repository>
+    </distributionManagement>
     <dependencies>
         <dependency>
             <groupId>org.jetbrains.kotlin</groupId>
@@ -105,6 +140,40 @@
                         <goals>
                             <goal>sign</goal>
                         </goals>
+                        <configuration>
+                            <gpgArguments>
+                                <arg>--pinentry-mode</arg>
+                                <arg>loopback</arg>
+                            </gpgArguments>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <!-- Attach source jars-->
+            <plugin>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>${version.plugin.source}</version>
+                <executions>
+                    <execution>
+                        <id>attach-source</id>
+                        <phase>compile</phase>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <!-- Attach javadocs jar -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>${version.plugin.javadoc}</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
                     </execution>
                 </executions>
             </plugin>
@@ -116,6 +185,8 @@
         <kotlin.version>1.8.0</kotlin.version>
         <postgresql.version>9.4-1201-jdbc4</postgresql.version>
         <jooq.version>3.7.3</jooq.version>
+        <version.plugin.javadoc>3.4.1</version.plugin.javadoc>
+        <version.plugin.source>3.2.1</version.plugin.source>
         <jts.version>1.13</jts.version>
         <postgis-jdbc.version>2.2.0</postgis-jdbc.version>
     </properties>

diff --git a/src/main/java/net/dmitry/jooq/postgis/spatial/jts/JTS.java b/src/main/java/net/dmitry/jooq/postgis/spatial/jts/JTS.java
@@ -1,23 +1,4 @@
-/*
- * This file is part of Hibernate Spatial, an extension to the
- *  hibernate ORM solution for spatial (geographic) data.
- *
- *  Copyright © 2007-2012 Geovise BVBA
- *
- *  This library 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 2.1 of the License, or (at your option) any later version.
- *
- *  This library 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 this library; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- */
+
 package net.dmitry.jooq.postgis.spatial.jts;
 
 import com.vividsolutions.jts.geom.PrecisionModel;

diff --git a/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/DoubleComparator.java b/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/DoubleComparator.java
@@ -1,29 +1,13 @@
-/*
- * This file is part of Hibernate Spatial, an extension to the
- *  hibernate ORM solution for spatial (geographic) data.
- *
- *  Copyright © 2007-2012 Geovise BVBA
- *
- *  This library 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 2.1 of the License, or (at your option) any later version.
- *
- *  This library 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 this library; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- */
+
 package net.dmitry.jooq.postgis.spatial.jts.mgeom;
 
 /**
  * This utility class is used to testsuite-suite doubles for equality
  *
- * @author Didier H. Besset <p/> Adapted from "Object-oriented implementation of
+ * @author Didier H. Besset
+ *
+ *
+ * Adapted from "Object-oriented implementation of
  *         numerical methods"
  */
 //TODO: This class should be removed.

diff --git a/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/EventLocator.java b/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/EventLocator.java
@@ -1,23 +1,4 @@
-/*
- * This file is part of Hibernate Spatial, an extension to the
- *  hibernate ORM solution for spatial (geographic) data.
- *
- *  Copyright © 2007-2012 Geovise BVBA
- *
- *  This library 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 2.1 of the License, or (at your option) any later version.
- *
- *  This library 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 this library; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- */
+
 package net.dmitry.jooq.postgis.spatial.jts.mgeom;
 
 import com.vividsolutions.jts.geom.Coordinate;
@@ -33,8 +14,10 @@ public class EventLocator {
 	/**
 	 * Returns the point on the specified MGeometry where its measure equals the specified position.
 	 *
+	 * @param lrs geom
+	 * @param position double
 	 * @return a Point Geometry
-	 * @throws MGeometryException
+	 * @throws MGeometryException on problem
 	 */
 	public static Point getPointGeometry(MGeometry lrs, double position)
 			throws MGeometryException {

diff --git a/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/MCoordinate.java b/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/MCoordinate.java
@@ -1,23 +1,4 @@
-/*
- * This file is part of Hibernate Spatial, an extension to the
- *  hibernate ORM solution for spatial (geographic) data.
- *
- *  Copyright © 2007-2012 Geovise BVBA
- *
- *  This library 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 2.1 of the License, or (at your option) any later version.
- *
- *  This library 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 this library; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- */
+
 package net.dmitry.jooq.postgis.spatial.jts.mgeom;
 
 import com.vividsolutions.jts.geom.Coordinate;
@@ -28,7 +9,8 @@
  * (x,y,z) are coordinates in a 3 dimensional space (cartesian for example), and
  * the fourth is a measure value used for linear referencing. Note that the
  * measure value is independent of whether the (x,y,z) values are used. For
- * example, the z value can not be used while the measure value is used. <p/>
+ * example, the z value can not be used while the measure value is used.
+ *
  * While this class extends the Coordinate class, it can be used seamlessly as a
  * substitute in the event that the Measure value is not used. In these cases
  * the Measure value shall simply be Double.NaN

diff --git a/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/MCoordinateSequence.java b/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/MCoordinateSequence.java
@@ -1,23 +1,4 @@
-/*
- * This file is part of Hibernate Spatial, an extension to the
- *  hibernate ORM solution for spatial (geographic) data.
- *
- *  Copyright © 2007-2012 Geovise BVBA
- *
- *  This library 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 2.1 of the License, or (at your option) any later version.
- *
- *  This library 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 this library; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- */
+
 package net.dmitry.jooq.postgis.spatial.jts.mgeom;
 
 import com.vividsolutions.jts.geom.Coordinate;
@@ -59,7 +40,7 @@ public static MCoordinate[] copy(CoordinateSequence coordSeq) {
 	 * Copy constructor -- simply aliases the input array, for better
 	 * performance.
 	 *
-	 * @param coordinates
+	 * @param coordinates c
 	 */
 	public MCoordinateSequence(MCoordinate[] coordinates) {
 		this.coordinates = coordinates;
@@ -70,7 +51,7 @@ public MCoordinateSequence(MCoordinate[] coordinates) {
 	 * copy of the input array, since the actual class of the Coordinates in the
 	 * input array may be different from MCoordinate.
 	 *
-	 * @param copyCoords
+	 * @param copyCoords c
 	 */
 	public MCoordinateSequence(Coordinate[] copyCoords) {
 		coordinates = copy(copyCoords);
@@ -79,7 +60,7 @@ public MCoordinateSequence(Coordinate[] copyCoords) {
 	/**
 	 * Constructor that makes a copy of a CoordinateSequence.
 	 *
-	 * @param coordSeq
+	 * @param coordSeq c
 	 */
 	public MCoordinateSequence(CoordinateSequence coordSeq) {
 		coordinates = copy(coordSeq);
@@ -140,6 +121,9 @@ public double getY(int index) {
 	}
 
 	/**
+	 *
+	 * @param index the index
+	 *
 	 * @return the measure value of the coordinate in the index
 	 */
 	public double getM(int index) {

diff --git a/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/MCoordinateSequenceFactory.java b/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/MCoordinateSequenceFactory.java
@@ -1,23 +1,4 @@
-/*
- * This file is part of Hibernate Spatial, an extension to the
- *  hibernate ORM solution for spatial (geographic) data.
- *
- *  Copyright © 2007-2012 Geovise BVBA
- *
- *  This library 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 2.1 of the License, or (at your option) any later version.
- *
- *  This library 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 this library; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- */
+
 package net.dmitry.jooq.postgis.spatial.jts.mgeom;
 
 import com.vividsolutions.jts.geom.Coordinate;
@@ -45,6 +26,8 @@ private MCoordinateSequenceFactory() {
 
 	/**
 	 * Returns the singleton instance of MCoordinateSequenceFactory
+	 *
+	 * @return instance
 	 */
 	public static MCoordinateSequenceFactory instance() {
 		return instance;

diff --git a/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/MGeometry.java b/src/main/java/net/dmitry/jooq/postgis/spatial/jts/mgeom/MGeometry.java
@@ -1,23 +1,4 @@
-/*
- * This file is part of Hibernate Spatial, an extension to the
- *  hibernate ORM solution for spatial (geographic) data.
- *
- *  Copyright © 2007-2012 Geovise BVBA
- *
- *  This library 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 2.1 of the License, or (at your option) any later version.
- *
- *  This library 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 this library; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- */
+
 package net.dmitry.jooq.postgis.spatial.jts.mgeom;
 
 import com.vividsolutions.jts.geom.Coordinate;
@@ -62,7 +43,9 @@ public interface MGeometry extends Cloneable, Serializable {
 	 * @param tolerance distance to the MGeometry within which Coordinate c has to lie
 	 * @return the measure value if Coordinate c is within tolerance of the
 	 *         Geometry, else Double.NaN
-	 *         <p/>
+	 *
+	 *
+	 *
 	 *         When the geometry is a ring or is self-intersecting more
 	 *         coordinates may be determined by one coordinate. In that case,
 	 *         the lowest measure is returned.
@@ -140,6 +123,7 @@ public CoordinateSequence[] getCoordinatesBetween(double begin, double end)
 	 * <li> [5,3,3,0] - Non-strict Monotone Decreasing
 	 * </ul>
 	 *
+	 * @param strict isStrict
 	 * @return true if the coordinates in the CoordinateSequence of the geometry
 	 *         are monotone.
 	 */
@@ -161,7 +145,7 @@ public CoordinateSequence[] getCoordinatesBetween(double begin, double end)
 
 	/**
 	 * Returns this <code>MGeometry</code> as a <code>Geometry</code>.
-	 * <p/>
+	 * <p></p>
 	 * Modifying the returned <code>Geometry</code> will result in internal state changes.
 	 *
 	 * @return this object as a Geometry.