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 d22d15fa8e6c9d1ff00844b637661db97b2025eb Author: Martin Desruisseaux <[email protected]> AuthorDate: Wed Sep 4 17:50:38 2019 +0200 Rename ChangeListener as StoreListener and ChangeEvent as StoreEvent. https://issues.apache.org/jira/browse/SIS-421 --- .../apache/sis/util/logging/WarningListener.java | 2 +- .../sis/storage/earthobservation/LandsatStore.java | 8 +++---- .../apache/sis/storage/geotiff/GeoTiffStore.java | 8 +++---- .../org/apache/sis/storage/netcdf/NetcdfStore.java | 8 +++---- .../java/org/apache/sis/storage/sql/SQLStore.java | 8 +++---- .../sis/internal/storage/AbstractResource.java | 8 +++---- .../apache/sis/internal/storage/URIDataStore.java | 8 +++---- .../apache/sis/internal/storage/folder/Store.java | 8 +++---- .../main/java/org/apache/sis/storage/Resource.java | 26 +++++++++++----------- .../event/{ChangeEvent.java => StoreEvent.java} | 9 ++++---- .../{ChangeListener.java => StoreListener.java} | 20 ++++++++--------- .../org/apache/sis/storage/event/package-info.java | 7 ++---- .../java/org/apache/sis/storage/DataStoreMock.java | 8 +++---- 13 files changed, 63 insertions(+), 65 deletions(-) diff --git a/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListener.java b/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListener.java index 4781f09..17c9562 100644 --- a/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListener.java +++ b/core/sis-utility/src/main/java/org/apache/sis/util/logging/WarningListener.java @@ -42,7 +42,7 @@ import java.util.logging.LogRecord; * * @see WarningListeners * @see org.apache.sis.storage.DataStore#addWarningListener(WarningListener) - * @see org.apache.sis.storage.event.ChangeListener + * @see org.apache.sis.storage.event.StoreListener * * @since 0.3 * @module diff --git a/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatStore.java b/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatStore.java index 574b940..c23a061 100644 --- a/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatStore.java +++ b/storage/sis-earth-observation/src/main/java/org/apache/sis/storage/earthobservation/LandsatStore.java @@ -31,8 +31,8 @@ import org.apache.sis.storage.DataStoreException; import org.apache.sis.storage.DataStoreReferencingException; import org.apache.sis.storage.UnsupportedStorageException; import org.apache.sis.storage.StorageConnector; -import org.apache.sis.storage.event.ChangeEvent; -import org.apache.sis.storage.event.ChangeListener; +import org.apache.sis.storage.event.StoreEvent; +import org.apache.sis.storage.event.StoreListener; import org.apache.sis.internal.storage.URIDataStore; import org.apache.sis.setup.OptionKey; @@ -178,7 +178,7 @@ public class LandsatStore extends DataStore { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void addListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void addListener(StoreListener<? super T> listener, Class<T> eventType) { } /** @@ -189,7 +189,7 @@ public class LandsatStore extends DataStore { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void removeListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void removeListener(StoreListener<? super T> listener, Class<T> eventType) { } /** diff --git a/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/GeoTiffStore.java b/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/GeoTiffStore.java index b476d01..065dbdb 100644 --- a/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/GeoTiffStore.java +++ b/storage/sis-geotiff/src/main/java/org/apache/sis/storage/geotiff/GeoTiffStore.java @@ -42,8 +42,8 @@ import org.apache.sis.storage.DataStoreContentException; import org.apache.sis.storage.UnsupportedStorageException; import org.apache.sis.storage.DataStoreClosedException; import org.apache.sis.storage.IllegalNameException; -import org.apache.sis.storage.event.ChangeEvent; -import org.apache.sis.storage.event.ChangeListener; +import org.apache.sis.storage.event.StoreEvent; +import org.apache.sis.storage.event.StoreListener; import org.apache.sis.internal.storage.io.ChannelDataInput; import org.apache.sis.internal.storage.io.IOUtilities; import org.apache.sis.internal.storage.MetadataBuilder; @@ -340,7 +340,7 @@ public class GeoTiffStore extends DataStore implements Aggregate { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void addListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void addListener(StoreListener<? super T> listener, Class<T> eventType) { } /** @@ -351,7 +351,7 @@ public class GeoTiffStore extends DataStore implements Aggregate { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void removeListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void removeListener(StoreListener<? super T> listener, Class<T> eventType) { } /** diff --git a/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/NetcdfStore.java b/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/NetcdfStore.java index 653bdf8..0e33f37 100644 --- a/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/NetcdfStore.java +++ b/storage/sis-netcdf/src/main/java/org/apache/sis/storage/netcdf/NetcdfStore.java @@ -39,8 +39,8 @@ import org.apache.sis.internal.util.UnmodifiableArrayList; import org.apache.sis.internal.util.Strings; import org.apache.sis.setup.OptionKey; import org.apache.sis.storage.Resource; -import org.apache.sis.storage.event.ChangeEvent; -import org.apache.sis.storage.event.ChangeListener; +import org.apache.sis.storage.event.StoreEvent; +import org.apache.sis.storage.event.StoreListener; import org.apache.sis.util.CharSequences; import org.apache.sis.util.Version; import ucar.nc2.constants.ACDD; @@ -222,7 +222,7 @@ public class NetcdfStore extends DataStore implements Aggregate { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void addListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void addListener(StoreListener<? super T> listener, Class<T> eventType) { } /** @@ -233,7 +233,7 @@ public class NetcdfStore extends DataStore implements Aggregate { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void removeListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void removeListener(StoreListener<? super T> listener, Class<T> eventType) { } /** diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/storage/sql/SQLStore.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/storage/sql/SQLStore.java index b7b1061..0d83fd4 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/storage/sql/SQLStore.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/storage/sql/SQLStore.java @@ -32,8 +32,8 @@ import org.apache.sis.storage.DataStore; import org.apache.sis.storage.DataStoreException; import org.apache.sis.storage.IllegalNameException; import org.apache.sis.storage.StorageConnector; -import org.apache.sis.storage.event.ChangeEvent; -import org.apache.sis.storage.event.ChangeListener; +import org.apache.sis.storage.event.StoreEvent; +import org.apache.sis.storage.event.StoreListener; import org.apache.sis.internal.sql.feature.Database; import org.apache.sis.internal.sql.feature.Resources; import org.apache.sis.internal.storage.MetadataBuilder; @@ -263,7 +263,7 @@ public class SQLStore extends DataStore implements Aggregate { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void addListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void addListener(StoreListener<? super T> listener, Class<T> eventType) { } /** @@ -274,7 +274,7 @@ public class SQLStore extends DataStore implements Aggregate { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void removeListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void removeListener(StoreListener<? super T> listener, Class<T> eventType) { } /** diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/AbstractResource.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/AbstractResource.java index f279e9d..d3ca538 100644 --- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/AbstractResource.java +++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/AbstractResource.java @@ -26,8 +26,8 @@ import org.apache.sis.util.logging.WarningListeners; import org.apache.sis.storage.Resource; import org.apache.sis.storage.DataStore; import org.apache.sis.storage.DataStoreException; -import org.apache.sis.storage.event.ChangeEvent; -import org.apache.sis.storage.event.ChangeListener; +import org.apache.sis.storage.event.StoreEvent; +import org.apache.sis.storage.event.StoreListener; /** @@ -177,7 +177,7 @@ public abstract class AbstractResource implements Resource, Localized { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void addListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void addListener(StoreListener<? super T> listener, Class<T> eventType) { } /** @@ -188,6 +188,6 @@ public abstract class AbstractResource implements Resource, Localized { * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void removeListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void removeListener(StoreListener<? super T> listener, Class<T> eventType) { } } diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/URIDataStore.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/URIDataStore.java index 5137fbf..25f179e 100644 --- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/URIDataStore.java +++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/URIDataStore.java @@ -31,8 +31,8 @@ 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.storage.event.ChangeEvent; -import org.apache.sis.storage.event.ChangeListener; +import org.apache.sis.storage.event.StoreEvent; +import org.apache.sis.storage.event.StoreListener; import org.apache.sis.internal.storage.io.IOUtilities; @@ -276,7 +276,7 @@ public abstract class URIDataStore extends DataStore implements StoreResource, R * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void addListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void addListener(StoreListener<? super T> listener, Class<T> eventType) { } /** @@ -288,6 +288,6 @@ public abstract class URIDataStore extends DataStore implements StoreResource, R * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void removeListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void removeListener(StoreListener<? super T> listener, Class<T> eventType) { } } diff --git a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java index 3712d60..6b46c89 100644 --- a/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java +++ b/storage/sis-storage/src/main/java/org/apache/sis/internal/storage/folder/Store.java @@ -55,8 +55,8 @@ import org.apache.sis.internal.storage.MetadataBuilder; import org.apache.sis.internal.storage.StoreUtilities; import org.apache.sis.internal.storage.StoreResource; import org.apache.sis.internal.storage.Resources; -import org.apache.sis.storage.event.ChangeEvent; -import org.apache.sis.storage.event.ChangeListener; +import org.apache.sis.storage.event.StoreEvent; +import org.apache.sis.storage.event.StoreListener; /** @@ -410,7 +410,7 @@ class Store extends DataStore implements StoreResource, Aggregate, DirectoryStre * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void addListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void addListener(StoreListener<? super T> listener, Class<T> eventType) { } /** @@ -421,7 +421,7 @@ class Store extends DataStore implements StoreResource, Aggregate, DirectoryStre * @param eventType {@inheritDoc} */ @Override - public <T extends ChangeEvent> void removeListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void removeListener(StoreListener<? super T> listener, Class<T> eventType) { } /** diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/Resource.java b/storage/sis-storage/src/main/java/org/apache/sis/storage/Resource.java index e8f2eed..9996ed4 100644 --- a/storage/sis-storage/src/main/java/org/apache/sis/storage/Resource.java +++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/Resource.java @@ -19,8 +19,8 @@ package org.apache.sis.storage; import java.util.Optional; import org.opengis.util.GenericName; import org.opengis.metadata.Metadata; -import org.apache.sis.storage.event.ChangeEvent; -import org.apache.sis.storage.event.ChangeListener; +import org.apache.sis.storage.event.StoreEvent; +import org.apache.sis.storage.event.StoreListener; /** @@ -134,12 +134,12 @@ public interface Resource { Metadata getMetadata() throws DataStoreException; /** - * Registers a listener that is notified each time a change occurs in the resource content or structure. - * The resource will call the {@link ChangeListener#changeOccured(ChangeEvent)} + * Registers a listener that is notified when some kind of events occur in the resource content or structure. + * The resource will call the {@link StoreListener#eventOccured(StoreEvent)} * method when a new event matching the {@code eventType} is produced. * * <p>Registering a listener for a given {@code eventType} also register the listener for all sub-types. - * The same listener can be added multiple times for different even type. + * The same listener can be added multiple times for different even types. * Adding many times the same listener with the same even type has no effect: * the listener will only be called once per event.</p> * @@ -150,26 +150,26 @@ public interface Resource { * For example the resource may discard a listener if no event of the given type happen on this resource.</p> * * @param <T> compile-time value of the {@code eventType} argument. - * @param listener listener to notify about changes. - * @param eventType type of {@linkplain ChangeEvent} to listen (can not be {@code null}). + * @param listener listener to notify about events. + * @param eventType type of {@link StoreEvent} to listen (can not be {@code null}). */ - <T extends ChangeEvent> void addListener(ChangeListener<? super T> listener, Class<T> eventType); + <T extends StoreEvent> void addListener(StoreListener<? super T> listener, Class<T> eventType); /** * Unregisters a listener previously added to this resource for the given type of events. * The {@code eventType} must be the exact same class than the one given to the {@code addListener(…)} method. * * <div class="note"><b>Example:</b> - * if the same listener has been added for {@code ChangeEvent} and {@code StructuralChangeEvent}, that listener - * will be notified only once for all {@code ChangeEvent}s. If that listener is removed for {@code ChangeEvent}, + * if the same listener has been added for {@code StoreEvent} and {@code StructuralChangeEvent}, that listener + * will be notified only once for all {@code StoreEvent}s. If that listener is removed for {@code StoreEvent}, * then the listener will still receive {@code StructuralChangeEvent}s.</div> * * <p>Calling multiple times this method with the same listener and event type or a listener * which is unknown to this resource will have no effect and will not raise an exception.</p> * * @param <T> compile-time value of the {@code eventType} argument. - * @param listener listener to stop notifying about changes. - * @param eventType type of {@linkplain ChangeEvent} which were listened (can not be {@code null}). + * @param listener listener to stop notifying about events. + * @param eventType type of {@link StoreEvent} which were listened (can not be {@code null}). */ - <T extends ChangeEvent> void removeListener(ChangeListener<? super T> listener, Class<T> eventType); + <T extends StoreEvent> void removeListener(StoreListener<? super T> listener, Class<T> eventType); } diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/event/ChangeEvent.java b/storage/sis-storage/src/main/java/org/apache/sis/storage/event/StoreEvent.java similarity index 86% rename from storage/sis-storage/src/main/java/org/apache/sis/storage/event/ChangeEvent.java rename to storage/sis-storage/src/main/java/org/apache/sis/storage/event/StoreEvent.java index 6e2545a..8462e9d 100644 --- a/storage/sis-storage/src/main/java/org/apache/sis/storage/event/ChangeEvent.java +++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/event/StoreEvent.java @@ -21,18 +21,19 @@ import org.apache.sis.storage.Resource; /** - * Parent class of all events related to a change in the metadata, content or structure of a resource. + * Parent class of events happening in a data store resource. + * The event may be a warning or a change in the metadata, content or structure of a resource. * Those events are created by {@link Resource} implementations and sent to all registered listeners. * * @author Johann Sorel (Geomatys) * @version 1.0 * - * @see ChangeListener + * @see StoreListener * * @since 1.0 * @module */ -public abstract class ChangeEvent extends EventObject { +public abstract class StoreEvent extends EventObject { /** * For cross-version compatibility. */ @@ -44,7 +45,7 @@ public abstract class ChangeEvent extends EventObject { * @param source the resource on which the event initially occurred. * @throws IllegalArgumentException if the given source is null. */ - public ChangeEvent(Resource source) { + public StoreEvent(Resource source) { super(source); } diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/event/ChangeListener.java b/storage/sis-storage/src/main/java/org/apache/sis/storage/event/StoreListener.java similarity index 68% rename from storage/sis-storage/src/main/java/org/apache/sis/storage/event/ChangeListener.java rename to storage/sis-storage/src/main/java/org/apache/sis/storage/event/StoreListener.java index a5892ab..4ba393a 100644 --- a/storage/sis-storage/src/main/java/org/apache/sis/storage/event/ChangeListener.java +++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/event/StoreListener.java @@ -20,35 +20,35 @@ import org.apache.sis.storage.Resource; /** - * Defines an object which listens for changes in resources. - * The changes in resources are described by {@link ChangeEvent} instances. - * {@link Resource} implementations are responsible for instantiating the most specific {@code ChangeEvent} subclass + * Defines an object which listens for events in resources (changes or warnings). + * The events in resources are described by {@link StoreEvent} instances. + * {@link Resource} implementations are responsible for instantiating the most specific {@code StoreEvent} subclass * for the type of event, for example: * * <ul> + * <li>When a warning occurred.</li> * <li>When the data store content changed (e.g. new feature instance added or removed).</li> * <li>When the data store structure changed (e.g. a column is added in tabular data).</li> * <li>Any other change at implementation choice.</li> * </ul> * - * Then, all {@code ChangeListener}s that declared an interest in {@code ChangeEvent}s of that kind are notified. + * Then, all {@code StoreListener}s that declared an interest in {@code StoreEvent}s of that kind are notified. * * @author Johann Sorel (Geomatys) * @version 1.0 * * @param <T> the type of events of interest to this listener. * - * @see ChangeEvent - * @see org.apache.sis.util.logging.WarningListener + * @see StoreEvent * * @since 1.0 * @module */ -public interface ChangeListener<T extends ChangeEvent> { +public interface StoreListener<T extends StoreEvent> { /** - * Invoked <em>after</em> a change occurred in a resource. + * Invoked <em>after</em> a warning or a change occurred in a resource. * - * @param event resource event, never null. + * @param event description of the change or warning that occurred in a resource. Shall not be {@code null}. */ - void changeOccured(T event); + void eventOccured(T event); } diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/event/package-info.java b/storage/sis-storage/src/main/java/org/apache/sis/storage/event/package-info.java index e2f3744..4525209 100644 --- a/storage/sis-storage/src/main/java/org/apache/sis/storage/event/package-info.java +++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/event/package-info.java @@ -18,13 +18,10 @@ /** * Provides interfaces and classes for dealing with different types of events fired by resources. - * The different types of events are differentiated by the {@link ChangeEvent} subclasses. - * There is different subclasses for structural changes or changes in resource content. + * The different types of events are differentiated by the {@link StoreEvent} subclasses. + * There is different subclasses for warnings, structural changes or changes in resource content. * It is possible to register a listener for only some specific types of events. * - * <p>Note that warnings that may occur during exploitation of a resource are handled by an interface - * defined in another package, {@link org.apache.sis.util.logging.WarningListener}.</p> - * * @author Johann Sorel (Geomatys) * @since 1.0 * @version 1.0 diff --git a/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreMock.java b/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreMock.java index 77cf42f..16b1f60 100644 --- a/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreMock.java +++ b/storage/sis-storage/src/test/java/org/apache/sis/storage/DataStoreMock.java @@ -18,8 +18,8 @@ package org.apache.sis.storage; import org.opengis.metadata.Metadata; import org.opengis.parameter.ParameterValueGroup; -import org.apache.sis.storage.event.ChangeEvent; -import org.apache.sis.storage.event.ChangeListener; +import org.apache.sis.storage.event.StoreEvent; +import org.apache.sis.storage.event.StoreListener; /** @@ -62,11 +62,11 @@ final strictfp class DataStoreMock extends DataStore { } @Override - public <T extends ChangeEvent> void addListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void addListener(StoreListener<? super T> listener, Class<T> eventType) { } @Override - public <T extends ChangeEvent> void removeListener(ChangeListener<? super T> listener, Class<T> eventType) { + public <T extends StoreEvent> void removeListener(StoreListener<? super T> listener, Class<T> eventType) { } @Override
