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

Timestamp:

2015-06-11T00:17:21+02:00 (9 years ago)

Author:

Don-vip

Message:

see #11266 - tagging presets icons: avoid unnecessary I/O access to non-existing png file + javadoc

File:

• trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetType.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetType.java

@@ -10 +10 @@
  */
 public enum TaggingPresetType {
+    /** Node */
     NODE(/* ICON */ "Mf_node", "node"),
+    /** Way */
     WAY(/* ICON */ "Mf_way", "way"),
+    /** Relation */
     RELATION(/* ICON */ "Mf_relation", "relation"),
+    /** Closed way */
     CLOSEDWAY(/* ICON */ "Mf_closedway", "closedway");
     private final String iconName;
@@ -18 +22 @@
 
     TaggingPresetType(String iconName, String name) {
-        this.iconName = iconName;
+        this.iconName = iconName + ".svg";
         this.name = name;
     }
 
+    /**
+     * Replies the SVG icon name.
+     * @return the SVG icon name
+     */
     public String getIconName() {
         return iconName;
     }
 
+    /**
+     * Replies the name, as used in XML presets.
+     * @return the name: "node", "way", "relation" or "closedway"
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     * Determines the {@code TaggingPresetType} of a given primitive.
+     * @param p The OSM primitive
+     * @return the {@code TaggingPresetType} of {@code p}
+     */
     public static TaggingPresetType forPrimitive(OsmPrimitive p) {
         return forPrimitiveType(p.getDisplayType());
     }
 
+    /**
+     * Determines the {@code TaggingPresetType} of a given primitive type.
+     * @param type The OSM primitive type
+     * @return the {@code TaggingPresetType} of {@code type}
+     */
     public static TaggingPresetType forPrimitiveType(OsmPrimitiveType type) {
         if (type == OsmPrimitiveType.NODE) return NODE;
@@ -43 +65 @@
     }
 
+    /**
+     * Determines the {@code TaggingPresetType} from a given string.
+     * @param type The OSM primitive type as string ("node", "way", "relation" or "closedway")
+     * @return the {@code TaggingPresetType} from {@code type}
+     */
     public static TaggingPresetType fromString(String type) {
         for (TaggingPresetType t : TaggingPresetType.values()) {
@@ -51 +78 @@
         return null;
     }
-
 }