This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sis.git
commit 39df6c6024da0ad136d1f1cebb39aaff8d501727
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Tue Apr 16 13:59:09 2024 +0200
Add warnings about `GeodeticCRS` type that may be replaced by `GeodeticCRS`
type in a future version.
---
.../sis/referencing/factory/ConcurrentAuthorityFactory.java | 4 ++++
.../apache/sis/referencing/factory/GeodeticAuthorityFactory.java | 4 ++++
.../org/apache/sis/referencing/factory/GeodeticObjectFactory.java | 8 ++++++++
.../apache/sis/referencing/factory/MultiAuthoritiesFactory.java | 4 ++++
4 files changed, 20 insertions(+)
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/ConcurrentAuthorityFactory.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/ConcurrentAuthorityFactory.java
index 2688f607cd..63527e9e79 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/ConcurrentAuthorityFactory.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/ConcurrentAuthorityFactory.java
@@ -935,6 +935,10 @@ public abstract class ConcurrentAuthorityFactory<DAO
extends GeodeticAuthorityFa
* {@link #createCoordinateReferenceSystem(String)} method cached a
value before to try that method.</li>
* </ul>
*
+ * <div class="warning"><b>Warning:</b> In a future SIS version, the
return type may be changed to the
+ * {@link GeodeticCRS} parent interface. This is because ISO 19111 does
not defines specific interface
+ * for the geocentric case. Users should assign the return value to a
{@code GeodeticCRS} type.</div>
+ *
* @return the coordinate reference system for the given code.
* @throws FactoryException if the object creation failed.
*/
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticAuthorityFactory.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticAuthorityFactory.java
index a5d86d0ee3..db8b1d7f60 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticAuthorityFactory.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticAuthorityFactory.java
@@ -344,6 +344,10 @@ public abstract class GeodeticAuthorityFactory extends
AbstractFactory implement
* <tr><td>EPSG:4984</td> <td>World Geodetic System 1972</td></tr>
* </table>
*
+ * <div class="warning"><b>Warning:</b> In a future SIS version, the
return type may be changed to the
+ * {@link GeodeticCRS} parent interface. This is because ISO 19111 does
not defines specific interface
+ * for the geocentric case. Users should assign the return value to a
{@code GeodeticCRS} type.</div>
+ *
* <h4>Default implementation</h4>
* The default implementation delegates to {@link
#createCoordinateReferenceSystem(String)} and casts the result.
* If the result cannot be casted, then a {@link
NoSuchAuthorityCodeException} is thrown.
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java
index 771df2dd98..7c8d8f2d31 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/GeodeticObjectFactory.java
@@ -320,6 +320,10 @@ public class GeodeticObjectFactory extends AbstractFactory
implements CRSFactory
* An {@linkplain #createGeocentricCRS(Map, GeodeticDatum, SphericalCS)
alternate method} allows creation of the
* same kind of CRS with spherical coordinate system instead of a
Cartesian one.
*
+ * <div class="warning"><b>Warning:</b> In a future SIS version, the
return type may be changed to the
+ * {@link GeodeticCRS} parent interface. This is because ISO 19111 does
not defines specific interface
+ * for the geocentric case. Users should assign the return value to a
{@code GeodeticCRS} type.</div>
+ *
* <h4>Dependencies</h4>
* The components needed by this method can be created by the following
methods:
* <ol>
@@ -398,6 +402,10 @@ public class GeodeticObjectFactory extends AbstractFactory
implements CRSFactory
* An {@linkplain #createGeocentricCRS(Map, GeodeticDatum, CartesianCS)
alternate method} allows creation of the
* same kind of CRS with Cartesian coordinate system instead of a
spherical one.
*
+ * <div class="warning"><b>Warning:</b> In a future SIS version, the
return type may be changed to the
+ * {@link GeodeticCRS} parent interface. This is because ISO 19111 does
not defines specific interface
+ * for the geocentric case. Users should assign the return value to a
{@code GeodeticCRS} type.</div>
+ *
* <h4>Dependencies</h4>
* The components needed by this method can be created by the following
methods:
* <ol>
diff --git
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/MultiAuthoritiesFactory.java
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/MultiAuthoritiesFactory.java
index ead0363423..03f1fb1498 100644
---
a/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/MultiAuthoritiesFactory.java
+++
b/endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/factory/MultiAuthoritiesFactory.java
@@ -954,6 +954,10 @@ public class MultiAuthoritiesFactory extends
GeodeticAuthorityFactory implements
* <li>{@code http://www.opengis.net/gml/srs/}<var>authority</var>{@code
.xml#}<var>code</var></li>
* </ul>
*
+ * <div class="warning"><b>Warning:</b> In a future SIS version, the
return type may be changed to the
+ * {@link GeodeticCRS} parent interface. This is because ISO 19111 does
not defines specific interface
+ * for the geocentric case. Users should assign the return value to a
{@code GeodeticCRS} type.</div>
+ *
* @return the coordinate reference system for the given code.
* @throws FactoryException if the object creation failed.
*/
