sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject [sis] 02/02: Javadoc clarifications.
Date Tue, 24 Jul 2018 14:29:04 GMT
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 e666c78746643fbccea7b513f9758eda0dee364e
Author: Martin Desruisseaux <martin.desruisseaux@geomatys.com>
AuthorDate: Tue Jul 24 16:28:36 2018 +0200

    Javadoc clarifications.
---
 .../java/org/apache/sis/storage/earthobservation/LandsatReader.java | 4 ++++
 .../src/main/java/org/apache/sis/storage/StorageConnector.java      | 6 ++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatReader.java
b/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatReader.java
index 45eaea3..1d99247 100644
--- a/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatReader.java
+++ b/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatReader.java
@@ -107,6 +107,10 @@ final class LandsatReader {
     /**
      * Names of Landsat bands.
      *
+     * @todo Those names and the wavelength could be moved to the {@code SpatialMetadata}
database,
+     *       as described in <a href="https://issues.apache.org/jira/browse/SIS-338">SIS-338</a>.
+     *       It would make easier to enrich the metadata with more information.
+     *
      * @see #bands
      * @see #band(String, int)
      */
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 7566008..543ec67 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
@@ -752,8 +752,10 @@ public class StorageConnector implements Serializable {
      * @param  <T>   the compile-time type of the {@code type} argument.
      * @param  type  the desired type as one of {@code ByteBuffer}, {@code DataInput}, {@code
Connection}
      *               class or other type supported by {@code StorageConnector} subclasses.
-     * @return the storage as a view of the given type, or {@code null} if no view can be
created for the given type.
-     * @throws IllegalArgumentException if the given {@code type} argument is not a supported
type.
+     * @return the storage as a view of the given type, or {@code null} if the given type
is one of the supported
+     *         types listed in javadoc but no view can be created for the source given at
construction time.
+     * @throws IllegalArgumentException if the given {@code type} argument is not one of
the supported types
+     *         listed in this javadoc or in subclass javadoc.
      * @throws DataStoreException if an error occurred while opening a stream or database
connection.
      *
      * @see #getStorage()


Mime
View raw message