Author: desruisseaux
Date: Sat Mar 31 10:14:16 2018
New Revision: 1828091
URL: http://svn.apache.org/viewvc?rev=1828091&view=rev
Log:
Javadoc on add/remove listener methods.
Modified:
sis/branches/JDK8/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatStore.java
sis/branches/JDK8/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/GeoTiffStore.java
sis/branches/JDK8/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/NetcdfStore.java
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/AbstractResource.java
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/URIDataStore.java
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java
sis/branches/JDK8/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreMock.java
Modified:
sis/branches/JDK8/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatStore.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatStore.java?rev=1828091&r1=1828090&r2=1828091&view=diff
==============================================================================
---
sis/branches/JDK8/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatStore.java
[UTF-8] (original)
+++
sis/branches/JDK8/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatStore.java
[UTF-8] Sat Mar 31 10:14:16 2018
@@ -29,10 +29,10 @@ import org.apache.sis.storage.DataStoreE
import org.apache.sis.storage.DataStoreReferencingException;
import org.apache.sis.storage.UnsupportedStorageException;
import org.apache.sis.storage.StorageConnector;
-import org.apache.sis.internal.storage.URIDataStore;
-import org.apache.sis.setup.OptionKey;
import org.apache.sis.storage.event.ChangeEvent;
import org.apache.sis.storage.event.ChangeListener;
+import org.apache.sis.internal.storage.URIDataStore;
+import org.apache.sis.setup.OptionKey;
import org.apache.sis.util.Debug;
@@ -65,7 +65,7 @@ import org.apache.sis.util.Debug;
*
* @author Thi Phuong Hao Nguyen (VNSC)
* @author Martin Desruisseaux (Geomatys)
- * @version 0.8
+ * @version 1.0
* @since 0.8
* @module
*/
@@ -147,18 +147,22 @@ public class LandsatStore extends DataSt
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, since this resource produces no
events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void addListener(ChangeListener<? super T>
listener, Class<T> eventType) {
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, since this resource produces no
events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void removeListener(ChangeListener<? super
T> listener, Class<T> eventType) {
Modified:
sis/branches/JDK8/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/GeoTiffStore.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/GeoTiffStore.java?rev=1828091&r1=1828090&r2=1828091&view=diff
==============================================================================
---
sis/branches/JDK8/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/GeoTiffStore.java
[UTF-8] (original)
+++
sis/branches/JDK8/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/GeoTiffStore.java
[UTF-8] Sat Mar 31 10:14:16 2018
@@ -33,15 +33,15 @@ import org.apache.sis.storage.StorageCon
import org.apache.sis.storage.DataStoreException;
import org.apache.sis.storage.DataStoreContentException;
import org.apache.sis.storage.UnsupportedStorageException;
+import org.apache.sis.storage.DataStoreClosedException;
+import org.apache.sis.storage.event.ChangeEvent;
+import org.apache.sis.storage.event.ChangeListener;
import org.apache.sis.internal.storage.io.ChannelDataInput;
import org.apache.sis.internal.storage.io.IOUtilities;
import org.apache.sis.internal.storage.MetadataBuilder;
import org.apache.sis.internal.storage.URIDataStore;
import org.apache.sis.internal.util.Constants;
import org.apache.sis.metadata.sql.MetadataStoreException;
-import org.apache.sis.storage.DataStoreClosedException;
-import org.apache.sis.storage.event.ChangeEvent;
-import org.apache.sis.storage.event.ChangeListener;
import org.apache.sis.util.resources.Errors;
@@ -51,7 +51,7 @@ import org.apache.sis.util.resources.Err
* @author Rémi Maréchal (Geomatys)
* @author Martin Desruisseaux (Geomatys)
* @author Thi Phuong Hao Nguyen (VNSC)
- * @version 0.8
+ * @version 1.0
* @since 0.8
* @module
*/
@@ -180,18 +180,22 @@ public class GeoTiffStore extends DataSt
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, since this resource produces no
events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void addListener(ChangeListener<? super T>
listener, Class<T> eventType) {
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, since this resource produces no
events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void removeListener(ChangeListener<? super
T> listener, Class<T> eventType) {
Modified:
sis/branches/JDK8/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/NetcdfStore.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/NetcdfStore.java?rev=1828091&r1=1828090&r2=1828091&view=diff
==============================================================================
---
sis/branches/JDK8/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/NetcdfStore.java
[UTF-8] (original)
+++
sis/branches/JDK8/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/NetcdfStore.java
[UTF-8] Sat Mar 31 10:14:16 2018
@@ -46,7 +46,7 @@ import ucar.nc2.constants.CDM;
* Instances of this data store are created by {@link
NetcdfStoreProvider#open(StorageConnector)}.
*
* @author Martin Desruisseaux (Geomatys)
- * @version 0.8
+ * @version 1.0
*
* @see NetcdfStoreProvider
*
@@ -179,18 +179,22 @@ public class NetcdfStore extends DataSto
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, since this resource produces no
events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void addListener(ChangeListener<? super T>
listener, Class<T> eventType) {
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, since this resource produces no
events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void removeListener(ChangeListener<? super
T> listener, Class<T> eventType) {
Modified:
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/AbstractResource.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/AbstractResource.java?rev=1828091&r1=1828090&r2=1828091&view=diff
==============================================================================
---
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/AbstractResource.java
[UTF-8] (original)
+++
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/AbstractResource.java
[UTF-8] Sat Mar 31 10:14:16 2018
@@ -37,7 +37,7 @@ import org.apache.sis.storage.event.Chan
* Base implementation of resources contained in data stores.
*
* @author Martin Desruisseaux (Geomatys)
- * @version 0.8
+ * @version 1.0
* @since 0.8
* @module
*/
@@ -125,18 +125,22 @@ public abstract class AbstractResource i
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, on the assumption that most
resources produce no events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void addListener(ChangeListener<? super T>
listener, Class<T> eventType) {
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, on the assumption that most
resources produce no events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void removeListener(ChangeListener<? super
T> listener, Class<T> eventType) {
Modified:
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/URIDataStore.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/URIDataStore.java?rev=1828091&r1=1828090&r2=1828091&view=diff
==============================================================================
---
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/URIDataStore.java
[UTF-8] (original)
+++
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/URIDataStore.java
[UTF-8] Sat Mar 31 10:14:16 2018
@@ -28,9 +28,9 @@ import org.apache.sis.storage.DataStore;
import org.apache.sis.storage.DataStoreProvider;
import org.apache.sis.storage.DataStoreException;
import org.apache.sis.storage.IllegalOpenParameterException;
-import org.apache.sis.internal.storage.io.IOUtilities;
import org.apache.sis.storage.event.ChangeEvent;
import org.apache.sis.storage.event.ChangeListener;
+import org.apache.sis.internal.storage.io.IOUtilities;
/**
@@ -231,18 +231,24 @@ public abstract class URIDataStore exten
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, on the assumption that most data
stores
+ * (at least the read-only ones) produce no events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void addListener(ChangeListener<? super T>
listener, Class<T> eventType) {
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, on the assumption that most data
stores
+ * (at least the read-only ones) produce no events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void removeListener(ChangeListener<? super
T> listener, Class<T> eventType) {
Modified:
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java?rev=1828091&r1=1828090&r2=1828091&view=diff
==============================================================================
---
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java
[UTF-8] (original)
+++
sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java
[UTF-8] Sat Mar 31 10:14:16 2018
@@ -342,18 +342,22 @@ class Store extends DataStore implements
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, since this resource produces no
events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void addListener(ChangeListener<? super T>
listener, Class<T> eventType) {
}
/**
- * This resource produces no events.
+ * Ignored in current implementation, since this resource produces no
events.
*
- * {@inheritDoc }
+ * @param <T> {@inheritDoc}
+ * @param listener {@inheritDoc}
+ * @param eventType {@inheritDoc}
*/
@Override
public <T extends ChangeEvent> void removeListener(ChangeListener<? super
T> listener, Class<T> eventType) {
Modified:
sis/branches/JDK8/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreMock.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreMock.java?rev=1828091&r1=1828090&r2=1828091&view=diff
==============================================================================
---
sis/branches/JDK8/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreMock.java
[UTF-8] (original)
+++
sis/branches/JDK8/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreMock.java
[UTF-8] Sat Mar 31 10:14:16 2018
@@ -26,7 +26,7 @@ import org.opengis.parameter.ParameterVa
* A dummy data store
*
* @author Martin Desruisseaux (Geomatys)
- * @version 0.8
+ * @version 1.0
* @since 0.8
* @module
*/
