Changeset 9823 in josm for trunk/src/org/openstreetmap/josm/data

Timestamp:

2016-02-18T17:39:58+01:00 (9 years ago)

Author:

bastiK

Message:

move preference writing to new class; some refactoring

Location:

trunk/src/org/openstreetmap/josm/data

Files:

• Preferences.java (modified) (7 diffs)
• preferences/PreferencesReader.java (modified) (4 diffs)
• preferences/PreferencesWriter.java (added)

trunk/src/org/openstreetmap/josm/data/Preferences.java

@@ -58 +58 @@
 import org.openstreetmap.josm.data.preferences.MapListSetting;
 import org.openstreetmap.josm.data.preferences.PreferencesReader;
+import org.openstreetmap.josm.data.preferences.PreferencesWriter;
 import org.openstreetmap.josm.data.preferences.Setting;
 import org.openstreetmap.josm.data.preferences.SettingVisitor;
@@ -538 +539 @@
         try (PrintWriter out = new PrintWriter(new OutputStreamWriter(
                 new FileOutputStream(prefFile + "_tmp"), StandardCharsets.UTF_8), false)) {
-            out.print(toXML(settings, false, defaults));
+            PreferencesWriter writer = new PreferencesWriter(out, false, defaults);
+            writer.write(settings);
         }
 
@@ -576 +578 @@
         File pref = getPreferenceFile();
         PreferencesReader.validateXML(pref);
-        PreferencesReader reader = new PreferencesReader(false);
-        reader.fromXML(pref);
+        PreferencesReader reader = new PreferencesReader(pref, false);
+        reader.parse();
         settingsMap.clear();
         settingsMap.putAll(reader.getSettings());
@@ -596 +598 @@
         File def = getDefaultsCacheFile();
         PreferencesReader.validateXML(def);
-        PreferencesReader reader = new PreferencesReader(true);
-        reader.fromXML(def);
+        PreferencesReader reader = new PreferencesReader(def, true);
+        reader.parse();
         defaultsMap.clear();
         long minTime = System.currentTimeMillis() / 1000 - MAX_AGE_DEFAULT_PREFERENCES;
@@ -611 +613 @@
      * @param in XML reader
      * @throws XMLStreamException if any XML stream error occurs
-     */
-    public void fromXML(Reader in) throws XMLStreamException {
-        PreferencesReader reader = new PreferencesReader(false);
-        reader.fromXML(in);
+     * @throws IOException if any I/O error occurs
+     */
+    public void fromXML(Reader in) throws XMLStreamException, IOException {
+        PreferencesReader reader = new PreferencesReader(in, false);
+        reader.parse();
         settingsMap.clear();
         settingsMap.putAll(reader.getSettings());
@@ -1399 +1402 @@
     }
 
-    private static class SettingToXml implements SettingVisitor {
-        private final StringBuilder b;
-        private final boolean noPassword;
-        private final boolean defaults;
-        private String key;
-
-        SettingToXml(StringBuilder b, boolean noPassword, boolean defaults) {
-            this.b = b;
-            this.noPassword = noPassword;
-            this.defaults = defaults;
-        }
-
-        public void setKey(String key) {
-            this.key = key;
-        }
-
-        private void addTime(Setting setting) {
-            if (defaults) {
-                Long time = setting.getTime();
-                if (time == null) throw new IllegalStateException();
-                b.append("' time='").append(time);
-            }
-        }
-
-        @Override
-        public void visit(StringSetting setting) {
-            if (noPassword && "osm-server.password".equals(key))
-                return; // do not store plain password.
-            b.append("  <tag key='");
-            b.append(XmlWriter.encode(key));
-            addTime(setting);
-            if (setting.getValue() != null) {
-                b.append("' value='");
-                b.append(XmlWriter.encode(setting.getValue()));
-                b.append("'/>\n");
-            } else if (defaults) {
-                b.append("' xsi:nil='true'/>\n");
-            } else {
-                throw new NullPointerException();
-            }
-        }
-
-        @Override
-        public void visit(ListSetting setting) {
-            b.append("  <list key='").append(XmlWriter.encode(key));
-            addTime(setting);
-            if (setting.getValue() != null) {
-                b.append("'>\n");
-                for (String s : setting.getValue()) {
-                    b.append("    <entry value='").append(XmlWriter.encode(s)).append("'/>\n");
-                }
-                b.append("  </list>\n");
-            } else if (defaults) {
-                b.append("' xsi:nil='true'/>\n");
-            } else {
-                throw new NullPointerException();
-            }
-        }
-
-        @Override
-        public void visit(ListListSetting setting) {
-            b.append("  <lists key='").append(XmlWriter.encode(key));
-            addTime(setting);
-            if (setting.getValue() != null) {
-                b.append("'>\n");
-                for (List<String> list : setting.getValue()) {
-                    b.append("    <list>\n");
-                    for (String s : list) {
-                        b.append("      <entry value='").append(XmlWriter.encode(s)).append("'/>\n");
-                    }
-                    b.append("    </list>\n");
-                }
-                b.append("  </lists>\n");
-            } else if (defaults) {
-                b.append("' xsi:nil='true'/>\n");
-            } else {
-                throw new NullPointerException();
-            }
-        }
-
-        @Override
-        public void visit(MapListSetting setting) {
-            b.append("  <maps key='").append(XmlWriter.encode(key));
-            addTime(setting);
-            if (setting.getValue() != null) {
-                b.append("'>\n");
-                for (Map<String, String> struct : setting.getValue()) {
-                    b.append("    <map>\n");
-                    for (Entry<String, String> e : struct.entrySet()) {
-                        b.append("      <tag key='").append(XmlWriter.encode(e.getKey()))
-                         .append("' value='").append(XmlWriter.encode(e.getValue())).append("'/>\n");
-                    }
-                    b.append("    </map>\n");
-                }
-                b.append("  </maps>\n");
-            } else if (defaults) {
-                b.append("' xsi:nil='true'/>\n");
-            } else {
-                throw new NullPointerException();
-            }
-        }
-    }
-
     /**
      * Returns XML describing these preferences.
@@ -1520 +1420 @@
      */
     public String toXML(Collection<Entry<String, Setting<?>>> settings, boolean nopass, boolean defaults) {
-        String rootElement = defaults ? "preferences-defaults" : "preferences";
-        StringBuilder b = new StringBuilder("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<")
-                .append(rootElement).append(" xmlns='")
-                .append(Main.getXMLBase()).append("/preferences-1.0'");
-        if (defaults) {
-            b.append(" xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'");
-        }
-        b.append(" version='").append(Version.getInstance().getVersion()).append("'>\n");
-        SettingToXml toXml = new SettingToXml(b, nopass, defaults);
-        for (Entry<String, Setting<?>> e : settings) {
-            toXml.setKey(e.getKey());
-            e.getValue().visit(toXml);
-        }
-        b.append("</").append(rootElement).append(">\n");
-        return b.toString();
+        StringWriter sw = new StringWriter();
+        PrintWriter pw = new PrintWriter(sw);
+        PreferencesWriter prefWriter = new PreferencesWriter(pw, nopass, defaults);
+        prefWriter.write(settings);
+        sw.flush();
+        StringBuffer sb = sw.getBuffer();
+        return sb.toString();
     }
 

trunk/src/org/openstreetmap/josm/data/preferences/PreferencesReader.java

@@ -41 +41 @@
 
     private final SortedMap<String, Setting<?>> settings = new TreeMap<>();
+    private XMLStreamReader parser;
     private int version = 0;
-    private XMLStreamReader parser;
+    private Reader reader;
+    private File file;
 
     private final boolean defaults;
@@ -48 +50 @@
     /**
      * Constructs a new {@code PreferencesReader}.
+     * @param file the file
      * @param defaults true when reading from the cache file for default preferences,
      * false for the regular preferences config file
-     */
-    public PreferencesReader(boolean defaults) {
+     * @throws IOException if any I/O error occurs
+     * @throws XMLStreamException if any XML stream error occurs
+     */
+    public PreferencesReader(File file, boolean defaults) throws IOException, XMLStreamException {
         this.defaults = defaults;
+        this.reader = null;
+        this.file = file;
+    }
+
+    /**
+     * Constructs a new {@code PreferencesReader}.
+     * @param reader the {@link Reader}
+     * @param defaults true when reading from the cache file for default preferences,
+     * false for the regular preferences config file
+     * @throws XMLStreamException if any XML stream error occurs
+     */
+    public PreferencesReader(Reader reader, boolean defaults) throws XMLStreamException {
+        this.defaults = defaults;
+        this.reader = reader;
+        this.file = null;
     }
 
@@ -82 +102 @@
 
     /**
-     * Parse preferences XML.
-     * @param f the file
-     * @throws IOException if any I/O error occurs
-     * @throws XMLStreamException if any XML stream error occurs
-     */
-    public void fromXML(File f) throws IOException, XMLStreamException {
-        try (BufferedReader in = Files.newBufferedReader(f.toPath(), StandardCharsets.UTF_8)) {
-            fromXML(in);
-        }
-    }
-
-    /**
-     * Parse preferences XML.
-     * @param in the {@link Reader}
-     * @throws XMLStreamException if any XML stream error occurs
-     */
-    public void fromXML(Reader in) throws XMLStreamException {
-        this.parser = XMLInputFactory.newInstance().createXMLStreamReader(in);
-        parse();
-    }
-
-    /**
      * Return the parsed preferences as a settings map
      * @return the parsed preferences as a settings map
@@ -120 +118 @@
     }
 
-    private void parse() throws XMLStreamException {
+
+    public void parse() throws XMLStreamException, IOException {
+        if (reader != null) {
+            this.parser = XMLInputFactory.newInstance().createXMLStreamReader(reader);
+            doParse();
+        } else {
+            try (BufferedReader in = Files.newBufferedReader(file.toPath(), StandardCharsets.UTF_8)) {
+                this.parser = XMLInputFactory.newInstance().createXMLStreamReader(in);
+                doParse();
+            }
+        }
+    }
+
+    private void doParse() throws XMLStreamException {
         int event = parser.getEventType();
         while (true) {