Changeset 9266 in josm for trunk/src/org/openstreetmap

Timestamp:

2016-01-02T18:51:06+01:00 (9 years ago)

Author:

simon04

Message:

Refactoring: move getMatchingPresets to TaggingPresets and add some Javadoc

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• dialogs/properties/PresetListPanel.java (modified) (2 diffs)
• dialogs/properties/TagEditHelper.java (modified) (2 diffs)
• dialogs/relation/GenericRelationEditor.java (modified) (2 diffs)
• dialogs/relation/MemberTableModel.java (modified) (2 diffs)
• tagging/ac/AutoCompletionManager.java (modified) (2 diffs)
• tagging/presets/TaggingPreset.java (modified) (3 diffs)
• tagging/presets/TaggingPresets.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/gui/dialogs/properties/PresetListPanel.java

@@ -17 +17 @@
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetLabel;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetType;
+import org.openstreetmap.josm.gui.tagging.presets.TaggingPresets;
 import org.openstreetmap.josm.tools.GBC;
 
@@ -47 +48 @@
         }
 
-        for (final TaggingPreset t : TaggingPreset.getMatchingPresets(types, tags, true)) {
+        for (final TaggingPreset t : TaggingPresets.getMatchingPresets(types, tags, true)) {
             final JLabel lbl = new TaggingPresetLabel(t);
             lbl.addMouseListener(new MouseAdapter() {

trunk/src/org/openstreetmap/josm/gui/dialogs/properties/TagEditHelper.java

@@ -74 +74 @@
 import org.openstreetmap.josm.gui.tagging.ac.AutoCompletionManager;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPreset;
+import org.openstreetmap.josm.gui.tagging.presets.TaggingPresets;
 import org.openstreetmap.josm.gui.util.GuiHelper;
 import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher;
@@ -739 +740 @@
                     Map<String, String> map = new HashMap<>();
                     map.put(t.getKey(), t.getValue());
-                    for (TaggingPreset tp : TaggingPreset.getMatchingPresets(null, map, false)) {
+                    for (TaggingPreset tp : TaggingPresets.getMatchingPresets(null, map, false)) {
                         icon = tp.getIcon();
                         if (icon != null) {

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java

@@ -86 +86 @@
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetHandler;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetType;
+import org.openstreetmap.josm.gui.tagging.presets.TaggingPresets;
 import org.openstreetmap.josm.io.OnlineResource;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
@@ -763 +764 @@
         CheckParameterUtil.ensureParameterNotNull(orig, "orig");
         try {
-            final Collection<TaggingPreset> presets = TaggingPreset.getMatchingPresets(
+            final Collection<TaggingPreset> presets = TaggingPresets.getMatchingPresets(
                     EnumSet.of(TaggingPresetType.RELATION), orig.getKeys(), false);
             Relation relation = new Relation(orig);

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTableModel.java

@@ -42 +42 @@
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetHandler;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetType;
+import org.openstreetmap.josm.gui.tagging.presets.TaggingPresets;
 import org.openstreetmap.josm.gui.util.GuiHelper;
 import org.openstreetmap.josm.gui.widgets.OsmPrimitivesTableModel;
@@ -422 +423 @@
 
     private void addMembersAtIndex(List<? extends OsmPrimitive> primitives, int index) {
-        final Collection<TaggingPreset> presets = TaggingPreset.getMatchingPresets(EnumSet.of(TaggingPresetType.RELATION),
+        final Collection<TaggingPreset> presets = TaggingPresets.getMatchingPresets(EnumSet.of(TaggingPresetType.RELATION),
                 presetHandler.getSelection().iterator().next().getKeys(), false);
         if (primitives == null)

trunk/src/org/openstreetmap/josm/gui/tagging/ac/AutoCompletionManager.java

@@ -30 +30 @@
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPreset;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetItem;
+import org.openstreetmap.josm.gui.tagging.presets.TaggingPresets;
 import org.openstreetmap.josm.gui.tagging.presets.items.CheckGroup;
 import org.openstreetmap.josm.gui.tagging.presets.items.KeyedItem;
@@ -335 +336 @@
     public void populateWithMemberRoles(AutoCompletionList list, Relation r) {
         CheckParameterUtil.ensureParameterNotNull(list, "list");
-        Collection<TaggingPreset> presets = r != null ? TaggingPreset.getMatchingPresets(null, r.getKeys(), false) : null;
+        Collection<TaggingPreset> presets = r != null ? TaggingPresets.getMatchingPresets(null, r.getKeys(), false) : null;
         if (r != null && presets != null && !presets.isEmpty()) {
             for (TaggingPreset tp : presets) {

trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPreset.java

@@ -296 +296 @@
     }
 
+    /**
+     * Determines whether a dialog can be shown for this preset, i.e., at least one tag can/must be set by the user.
+     *
+     * @return {@code true} if a dialog can be shown for this preset
+     */
     public boolean isShowable() {
         for (TaggingPresetItem i : data) {
@@ -503 +508 @@
     }
 
-    @Override
+    /**
+     * Determines whether this preset matches the given primitive, i.e.,
+     * whether the {@link #typeMatches(Collection) type matches} and the {@link TaggingPresetItem#matches(Map) tags match}.
+     *
+     * @param p the primitive
+     * @return {@code true} if this preset matches the primitive
+     */
+     @Override
     public boolean evaluate(OsmPrimitive p) {
         return matches(EnumSet.of(TaggingPresetType.forPrimitive(p)), p.getKeys(), false);
     }
 
+    /**
+     * Determines whether this preset matches the parameters.
+     *
+     * @param t the preset types to include, see {@link #typeMatches(Collection)}
+     * @param tags the tags to perform matching on, see {@link TaggingPresetItem#matches(Map)}
+     * @param onlyShowable whether the preset must be {@link #isShowable() showable}
+     * @return {@code true} if this preset matches the parameters.
+     */
     public boolean matches(Collection<TaggingPresetType> t, Map<String, String> tags, boolean onlyShowable) {
         if (onlyShowable && !isShowable())
@@ -525 +545 @@
     }
 
-    public static Collection<TaggingPreset> getMatchingPresets(final Collection<TaggingPresetType> t,
-            final Map<String, String> tags, final boolean onlyShowable) {
-        return Utils.filter(TaggingPresets.getTaggingPresets(), new Predicate<TaggingPreset>() {
-            @Override
-            public boolean evaluate(TaggingPreset object) {
-                return object.matches(t, tags, onlyShowable);
-            }
-        });
-    }
-
     /**
      * Action that adds or removes the button on main toolbar

trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresets.java

@@ -96 +96 @@
     }
 
+    /**
+     * Replies a new collection of all presets matching the parameters.
+     *
+     * @param t the preset types to include
+     * @param tags the tags to perform matching on, see {@link TaggingPresetItem#matches(Map)}
+     * @param onlyShowable whether only {@link TaggingPreset#isShowable() showable} presets should be returned
+     * @return a new collection of all presets matching the parameters.
+     * @see TaggingPreset#matches(Collection, Map, boolean)
+     * @since 9266
+     */
+    public static Collection<TaggingPreset> getMatchingPresets(final Collection<TaggingPresetType> t,
+                                                               final Map<String, String> tags, final boolean onlyShowable) {
+        return Utils.filter(getTaggingPresets(), new Predicate<TaggingPreset>() {
+            @Override
+            public boolean evaluate(TaggingPreset object) {
+                return object.matches(t, tags, onlyShowable);
+            }
+        });
+    }
+
+    /**
+     * Replies a new collection of all presets matching the given preset.
+     *
+     * @param primitive the primitive
+     * @return a new collection of all presets matching the given preset.
+     * @see TaggingPreset#evaluate(OsmPrimitive)
+     * @since 9265
+     */
     public static Collection<TaggingPreset> getMatchingPresets(final OsmPrimitive primitive) {
         return Utils.filter(getTaggingPresets(), new Predicate<TaggingPreset>() {