This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch geoapi-4.0
in repository https://gitbox.apache.org/repos/asf/sis.git
commit 175b9f0cedf9a06f064c9cbc4aedaa9e5acae700
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Sun Apr 16 18:50:45 2023 +0200
Fix some javadoc errors.
---
.../sis/coverage/grid/GridCoverageProcessor.java | 1 +
.../apache/sis/parameter/ParameterValueList.java | 2 +-
.../referencing/factory/sql/AuthorityCodes.java | 2 +-
.../referencing/operation/projection/Mercator.java | 4 +-
.../org/apache/sis/storage/StorageConnector.java | 44 ++++++++++++----------
5 files changed, 29 insertions(+), 24 deletions(-)
diff --git
a/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridCoverageProcessor.java
b/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridCoverageProcessor.java
index c38ec7d876..a708489344 100644
---
a/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridCoverageProcessor.java
+++
b/core/sis-feature/src/main/java/org/apache/sis/coverage/grid/GridCoverageProcessor.java
@@ -31,6 +31,7 @@ import org.opengis.referencing.crs.CoordinateReferenceSystem;
import org.opengis.referencing.operation.MathTransform;
import org.opengis.referencing.operation.MathTransform1D;
import org.opengis.referencing.operation.TransformException;
+import org.apache.sis.coverage.Category;
import org.apache.sis.coverage.RegionOfInterest;
import org.apache.sis.coverage.SampleDimension;
import org.apache.sis.coverage.SubspaceNotSpecifiedException;
diff --git
a/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java
b/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java
index b7abe02409..c14390e7ed 100644
---
a/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java
+++
b/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java
@@ -43,7 +43,7 @@ import org.apache.sis.internal.referencing.Resources;
* This class performs checks on the parameter values to be added or removed.
* This implementation supports {@code set(…)}, {@code add(…)} and {@code
remove(…)} operations.
*
- * <h4>Implementation note</h4>
+ * <h2>Implementation note</h2>
* This class reproduces some {@link java.util.ArrayList} functionalities.
* However, we do <strong>not</strong> extend {@code ArrayList} because we
really need the default method
* implementations provided by {@code AbstractList} — the optimizations
performed by {@code ArrayList}
diff --git
a/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/AuthorityCodes.java
b/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/AuthorityCodes.java
index 6c1e899463..bcf8bcb5a0 100644
---
a/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/AuthorityCodes.java
+++
b/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/AuthorityCodes.java
@@ -26,8 +26,8 @@ import java.sql.PreparedStatement;
import java.sql.Statement;
import org.opengis.referencing.operation.Projection;
import org.apache.sis.util.collection.BackingStoreException;
-import org.apache.sis.internal.util.AbstractMap;
import org.apache.sis.util.collection.IntegerList;
+import org.apache.sis.internal.util.AbstractMap;
/**
diff --git
a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/projection/Mercator.java
b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/projection/Mercator.java
index add9caf444..fe6d1f2275 100644
---
a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/projection/Mercator.java
+++
b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/projection/Mercator.java
@@ -492,8 +492,8 @@ subst: if (variant.spherical || (eccentricity == 0 &&
getClass() == Mercator.cl
/**
* Provides the transform equations for the spherical case of the Mercator
projection.
*
- * <h4>Implementation note</h4>
- * this class contains an explicit check for latitude values at a pole. If
floating point arithmetic had infinite
+ * <h2>Implementation note</h2>
+ * This class contains an explicit check for latitude values at a pole. If
floating point arithmetic had infinite
* precision, such checks would not be necessary since the formulas lead
naturally to infinite values at poles,
* which is the correct answer. In practice the infinite value emerges by
itself at only one pole, and the other
* one produces a high value (approximately 1E+16). This is because there
is no accurate representation of π/2,
diff --git
a/storage/sis-storage/src/main/java/org/apache/sis/storage/StorageConnector.java
b/storage/sis-storage/src/main/java/org/apache/sis/storage/StorageConnector.java
index 269ba41729..759331e2a1 100644
---
a/storage/sis-storage/src/main/java/org/apache/sis/storage/StorageConnector.java
+++
b/storage/sis-storage/src/main/java/org/apache/sis/storage/StorageConnector.java
@@ -20,6 +20,9 @@ import java.util.Map;
import java.util.Iterator;
import java.util.IdentityHashMap;
import java.util.function.UnaryOperator;
+import java.net.URI;
+import java.net.URL;
+import java.io.File;
import java.io.Reader;
import java.io.DataInput;
import java.io.DataOutput;
@@ -35,8 +38,9 @@ import java.nio.channels.Channel;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.WritableByteChannel;
import java.nio.channels.SeekableByteChannel;
-import java.nio.file.NoSuchFileException;
+import java.nio.file.Path;
import java.nio.file.OpenOption;
+import java.nio.file.NoSuchFileException;
import javax.imageio.stream.ImageInputStream;
import javax.imageio.stream.ImageOutputStream;
import javax.imageio.IIOException;
@@ -77,10 +81,10 @@ import org.apache.sis.setup.OptionKey;
* {@code StorageConnector} wraps an input {@link Object}, which can be any of
the following types:
*
* <ul>
- * <li>A {@link java.nio.file.Path} or a {@link java.io.File} for a file or
a directory.</li>
- * <li>A {@link java.net.URI} or a {@link java.net.URL} to a distant
resource.</li>
+ * <li>A {@link Path} or a {@link File} for a file or a directory.</li>
+ * <li>A {@link URI} or a {@link URL} to a distant resource.</li>
* <li>A {@link CharSequence} interpreted as a filename or a URL.</li>
- * <li>A {@link java.nio.channels.Channel}, {@link DataInput}, {@link
InputStream} or {@link Reader}.</li>
+ * <li>A {@link Channel}, {@link DataInput}, {@link InputStream} or {@link
Reader}.</li>
* <li>A {@link DataSource} or a {@link Connection} to a JDBC database.</li>
* <li>Any other {@code DataStore}-specific object, for example {@link
ucar.nc2.NetcdfFile}.</li>
* </ul>
@@ -222,10 +226,10 @@ public class StorageConnector implements Serializable {
* exception if the conversion fail. Instead, getStorageAs(Class) will
return null.
* Classes not listed here will let the UnconvertibleObjectException
propagates.
*/
- add(java.net.URI.class, null);
- add(java.net.URL.class, null);
- add(java.io.File.class, null);
- add(java.nio.file.Path.class, null);
+ add(URI.class, null);
+ add(URL.class, null);
+ add(File.class, null);
+ add(Path.class, null);
}
/**
@@ -294,7 +298,7 @@ public class StorageConnector implements Serializable {
* used independently. They are views that may advance {@code storage}
position, but not at the same time than the
* {@link #view} position (typically because the view reads some bytes in
advance and stores them in a buffer).
* Such coupling may occur when the storage is an {@link InputStream}, an
{@link java.io.OutputStream} or a
- * {@link java.nio.channels.Channel}. The coupled {@link #view} can be:
+ * {@link Channel}. The coupled {@link #view} can be:
*
* <ul>
* <li>{@link Reader} that are wrappers around {@code InputStream}.</li>
@@ -641,8 +645,8 @@ public class StorageConnector implements Serializable {
* {@linkplain #getStorage() storage} object:
*
* <ul>
- * <li>For {@link java.nio.file.Path}, {@link java.io.File}, {@link
java.net.URI} or {@link java.net.URL}
- * instances, this method uses dedicated API like {@link
java.nio.file.Path#getFileName()}.</li>
+ * <li>For {@link Path}, {@link File}, {@link URI} or {@link URL}
+ * instances, this method uses dedicated API like {@link
Path#getFileName()}.</li>
* <li>For {@link CharSequence} instances, this method gets a string
representation of the storage object
* and returns the part after the last {@code '/'} character or
platform-dependent name separator.</li>
* <li>For instances of unknown type, this method builds a string
representation using the class name.
@@ -669,7 +673,7 @@ public class StorageConnector implements Serializable {
* the following choices based on the type of the {@linkplain
#getStorage() storage} object:
*
* <ul>
- * <li>For {@link java.nio.file.Path}, {@link java.io.File}, {@link
java.net.URI}, {@link java.net.URL} or
+ * <li>For {@link Path}, {@link File}, {@link URI}, {@link URL} or
* {@link CharSequence} instances, this method returns the string
after the last {@code '.'} character
* in the filename, provided that the {@code '.'} is not the first
filename character. This may be an
* empty string if the filename has no extension, but never {@code
null}.</li>
@@ -701,17 +705,17 @@ public class StorageConnector implements Serializable {
* <ul>
* <li>{@link String}:
* <ul>
- * <li>If the {@linkplain #getStorage() storage} object is an
instance of the {@link java.nio.file.Path},
- * {@link java.io.File}, {@link java.net.URL}, {@link
java.net.URI} or {@link CharSequence} types,
+ * <li>If the {@linkplain #getStorage() storage} object is an
instance of the {@link Path},
+ * {@link File}, {@link URL}, {@link URI} or {@link
CharSequence} types,
* returns the string representation of their path.</li>
*
* <li>Otherwise this method returns {@code null}.</li>
* </ul>
* </li>
- * <li>{@link java.nio.file.Path}, {@link java.net.URI}, {@link
java.net.URL}, {@link java.io.File}:
+ * <li>{@link Path}, {@link URI}, {@link URL}, {@link File}:
* <ul>
- * <li>If the {@linkplain #getStorage() storage} object is an
instance of the {@link java.nio.file.Path},
- * {@link java.io.File}, {@link java.net.URL}, {@link
java.net.URI} or {@link CharSequence} types and
+ * <li>If the {@linkplain #getStorage() storage} object is an
instance of the {@link Path},
+ * {@link File}, {@link URL}, {@link URI} or {@link
CharSequence} types and
* that type can be converted to the requested type, returned
the conversion result.</li>
*
* <li>Otherwise this method returns {@code null}.</li>
@@ -735,8 +739,8 @@ public class StorageConnector implements Serializable {
* backed by a read-only view of that buffer is created when
first needed and returned.
* The properties (position, mark, limit) of the original buffer
are unmodified.</li>
*
- * <li>Otherwise if the input is an instance of {@link
java.nio.file.Path}, {@link java.io.File},
- * {@link java.net.URI}, {@link java.net.URL}, {@link
CharSequence}, {@link InputStream} or
+ * <li>Otherwise if the input is an instance of {@link Path}, {@link
File},
+ * {@link URI}, {@link URL}, {@link CharSequence}, {@link
InputStream} or
* {@link java.nio.channels.ReadableByteChannel}, then an {@link
ImageInputStream} backed by a
* {@link ByteBuffer} is created when first needed and
returned.</li>
*
@@ -830,7 +834,7 @@ public class StorageConnector implements Serializable {
* Note that InputStream may need to be reset if it has been used
indirectly by other kind
* of stream (for example a java.io.Reader). Example:
*
- * 1) The storage specified at construction time is a
java.nio.file.Path.
+ * 1) The storage specified at construction time is a `Path`.
* 2) getStorageAs(InputStream.class) opens an InputStream. Caller
rewinds it after use.
* 3) getStorageAs(Reader.class) wraps the InputStream. Caller
rewinds the Reader after use,
* but invoking BufferedReader.reset() has no effect on the
underlying InputStream.
