Changeset 12825 in josm for trunk/src/org/openstreetmap/josm/io

Timestamp:

2017-09-11T20:43:41+02:00 (7 years ago)

Author:

Don-vip

Message:

see #15229 - see #15182 - make FileWatcher generic so it has no more dependence on MapCSS

File:

• trunk/src/org/openstreetmap/josm/io/FileWatcher.java (modified) (6 diffs)

trunk/src/org/openstreetmap/josm/io/FileWatcher.java

@@ -12 +12 @@
 import java.nio.file.WatchKey;
 import java.nio.file.WatchService;
-import java.util.Collections;
+import java.util.EnumMap;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.concurrent.Executors;
+import java.util.Objects;
+import java.util.function.Consumer;
 
 import org.openstreetmap.josm.data.preferences.sources.SourceEntry;
-import org.openstreetmap.josm.data.validation.OsmValidator;
-import org.openstreetmap.josm.data.validation.tests.MapCSSTagChecker;
+import org.openstreetmap.josm.data.preferences.sources.SourceType;
 import org.openstreetmap.josm.gui.mappaint.StyleSource;
-import org.openstreetmap.josm.gui.mappaint.loader.MapPaintStyleLoader;
-import org.openstreetmap.josm.gui.mappaint.mapcss.parsergen.ParseException;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.Logging;
-import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -36 +33 @@
     private Thread thread;
 
-    private final Map<Path, StyleSource> styleMap = new HashMap<>();
-    private final Map<Path, SourceEntry> ruleMap = new HashMap<>();
+    private static final Map<SourceType, Consumer<SourceEntry>> loaderMap = new EnumMap<>(SourceType.class);
+    private final Map<Path, SourceEntry> sourceMap = new HashMap<>();
 
     /**
@@ -66 +63 @@
      * @throws IllegalStateException if the watcher service failed to start
      * @throws IOException if an I/O error occurs
+     * @deprecated To be removed end of 2017. Use {@link #registerSource} instead
      */
+    @Deprecated
     public void registerStyleSource(StyleSource style) throws IOException {
-        register(style, styleMap);
+        registerSource(style);
     }
 
@@ -78 +77 @@
      * @throws IOException if an I/O error occurs
      * @since 7276
+     * @deprecated To be removed end of 2017. Use {@link #registerSource} instead
      */
+    @Deprecated
     public void registerValidatorRule(SourceEntry rule) throws IOException {
-        register(rule, ruleMap);
+        registerSource(rule);
     }
 
-    private <T extends SourceEntry> void register(T obj, Map<Path, T> map) throws IOException {
-        CheckParameterUtil.ensureParameterNotNull(obj, "obj");
+    /**
+     * Registers a source for local file changes, allowing dynamic reloading.
+     * @param src The source to watch
+     * @throws IllegalArgumentException if {@code rule} is null or if it does not provide a local file
+     * @throws IllegalStateException if the watcher service failed to start
+     * @throws IOException if an I/O error occurs
+     * @since 12825
+     */
+    public void registerSource(SourceEntry src) throws IOException {
+        CheckParameterUtil.ensureParameterNotNull(src, "src");
         if (watcher == null) {
             throw new IllegalStateException("File watcher is not available");
         }
         // Get local file, as this method is only called for local style sources
-        File file = new File(obj.url);
+        File file = new File(src.url);
         // Get parent directory as WatchService allows only to monitor directories, not single files
         File dir = file.getParentFile();
         if (dir == null) {
-            throw new IllegalArgumentException("Resource "+obj+" does not have a parent directory");
+            throw new IllegalArgumentException("Resource "+src+" does not have a parent directory");
         }
         synchronized (this) {
@@ -99 +108 @@
             // (it returns the same key so it should not send events several times)
             dir.toPath().register(watcher, StandardWatchEventKinds.ENTRY_MODIFY, StandardWatchEventKinds.ENTRY_CREATE);
-            map.put(file.toPath(), obj);
+            sourceMap.put(file.toPath(), src);
         }
+    }
+
+    /**
+     * Registers a source loader, allowing dynamic reloading when an entry changes.
+     * @param type the source type for which the loader operates
+     * @param loader the loader in charge of reloading any source of given type when it changes
+     * @return the previous loader registered for this source type, if any
+     * @since 12825
+     */
+    public static Consumer<SourceEntry> registerLoader(SourceType type, Consumer<SourceEntry> loader) {
+        return loaderMap.put(Objects.requireNonNull(type, "type"), Objects.requireNonNull(loader, "loader"));
     }
 
@@ -148 +168 @@
 
                 synchronized (this) {
-                    StyleSource style = styleMap.get(fullPath);
-                    SourceEntry rule = ruleMap.get(fullPath);
-                    if (style != null) {
-                        Logging.info("Map style "+style.getDisplayString()+" has been modified. Reloading style...");
-                        Executors.newSingleThreadExecutor(Utils.newThreadFactory("mapstyle-reload-%d", Thread.NORM_PRIORITY)).submit(
-                                new MapPaintStyleLoader(Collections.singleton(style)));
-                    } else if (rule != null) {
-                        Logging.info("Validator rule "+rule.getDisplayString()+" has been modified. Reloading rule...");
-                        MapCSSTagChecker tagChecker = OsmValidator.getTest(MapCSSTagChecker.class);
-                        if (tagChecker != null) {
-                            try {
-                                tagChecker.addMapCSS(rule.url);
-                            } catch (IOException | ParseException e) {
-                                Logging.warn(e);
-                            }
+                    SourceEntry source = sourceMap.get(fullPath);
+                    if (source != null) {
+                        Consumer<SourceEntry> loader = loaderMap.get(source.type);
+                        if (loader != null) {
+                            Logging.info("Source "+source.getDisplayString()+" has been modified. Reloading it...");
+                            loader.accept(source);
+                        } else {
+                            Logging.warn("Received {0} event for unregistered source type: {1}", kind.name(), source.type);
                         }
                     } else if (Logging.isDebugEnabled()) {