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

Timestamp:

2013-03-31T21:38:01+02:00 (12 years ago)

Author:

stoecker

Message:

javadoc fixes

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/CloseChangesetAction.java (modified) (1 diff)
• actions/CreateMultipolygonAction.java (modified) (4 diffs)
• actions/MergeNodesAction.java (modified) (1 diff)
• data/osm/User.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/actions/CloseChangesetAction.java

@@ -78 +78 @@
         private UserInfo userInfo;
 
-        /**
-         *
-         * @param model provides the user id of the current user and accepts the changesets
-         * after download
-         */
         public DownloadOpenChangesetsTask() {
             super(tr("Downloading open changesets ...", false /* don't ignore exceptions */));

trunk/src/org/openstreetmap/josm/actions/CreateMultipolygonAction.java

@@ -130 +130 @@
     }
 
-    /** Enable this action only if something is selected */
+    /** 
+      * Enable this action only if something is selected
+      *
+      * @param selection the current selection, gets tested for emptyness
+      */
     @Override protected void updateEnabledState(Collection < ? extends OsmPrimitive > selection) {
         setEnabled(selection != null && !selection.isEmpty());
@@ -137 +141 @@
     /**
      * This method analyzes ways and creates multipolygon.
-     * @param selectedWays
-     * @return null, if there was a problem with the ways.
+     * @param selectedWays list of selected ways
+     * @return <code>null</code>, if there was a problem with the ways.
      */
     private MultipolygonCreate analyzeWays(Collection < Way > selectedWays) {
@@ -155 +159 @@
     /**
      * Builds a relation from polygon ways.
-     * @param pol
-     * @return
+     * @param pol data storage class containing polygon information
+     * @return multipolygon relation
      */
     private Relation createRelation(MultipolygonCreate pol) {
@@ -182 +186 @@
      * This method removes tags/value pairs from inner and outer ways and put them on relation if necessary
      * Function was extended in reltoolbox plugin by Zverikk and copied back to the core 
-     * @param relation
+     * @param relation the multipolygon style relation to process
+     * @return a list of commands to execute
      */
     private List<Command> removeTagsFromWaysIfNeeded( Relation relation ) {
-        Map<String, String> values = new HashMap<String, String>();
-
-        if( relation.hasKeys() ) {
-            for( String key : relation.keySet() ) {
-                values.put(key, relation.get(key));
-            }
-        }
-
-        List<Way> innerWays = new ArrayList<Way>();
-        List<Way> outerWays = new ArrayList<Way>();
-
-        Set<String> conflictingKeys = new TreeSet<String>();
-
-        for( RelationMember m : relation.getMembers() ) {
-
-            if( m.hasRole() && "inner".equals(m.getRole()) && m.isWay() && m.getWay().hasKeys() ) {
-                innerWays.add(m.getWay());
-            }
-
-            if( m.hasRole() && "outer".equals(m.getRole()) && m.isWay() && m.getWay().hasKeys() ) {
-                Way way = m.getWay();
-                outerWays.add(way);
+        Map<String, String> values = new HashMap<String, String>();
+
+        if( relation.hasKeys() ) {
+            for( String key : relation.keySet() ) {
+                values.put(key, relation.get(key));
+            }
+        }
+
+        List<Way> innerWays = new ArrayList<Way>();
+        List<Way> outerWays = new ArrayList<Way>();
+
+        Set<String> conflictingKeys = new TreeSet<String>();
+
+        for( RelationMember m : relation.getMembers() ) {
+
+            if( m.hasRole() && "inner".equals(m.getRole()) && m.isWay() && m.getWay().hasKeys() ) {
+                innerWays.add(m.getWay());
+            }
+
+            if( m.hasRole() && "outer".equals(m.getRole()) && m.isWay() && m.getWay().hasKeys() ) {
+                Way way = m.getWay();
+                outerWays.add(way);
                 
-                for( String key : way.keySet() ) {
-                    if( !values.containsKey(key) ) { //relation values take precedence
-                        values.put(key, way.get(key));
-                    } else if( !relation.hasKey(key) && !values.get(key).equals(way.get(key)) ) {
-                        conflictingKeys.add(key);
-                    }
-                }
-            }
-        }
-
-        // filter out empty key conflicts - we need second iteration
-        if( !Main.pref.getBoolean("multipoly.alltags", false) )
-            for( RelationMember m : relation.getMembers() )
-                if( m.hasRole() && m.getRole().equals("outer") && m.isWay() )
-                    for( String key : values.keySet() )
-                        if( !m.getWay().hasKey(key) && !relation.hasKey(key) )
-                            conflictingKeys.add(key);
-
-        for( String key : conflictingKeys )
-            values.remove(key);
-
-        for( String linearTag : Main.pref.getCollection("multipoly.lineartagstokeep", DEFAULT_LINEAR_TAGS) )
-            values.remove(linearTag);
-
-        if( values.containsKey("natural") && values.get("natural").equals("coastline") )
-            values.remove("natural");
-
-        values.put("area", "yes");
-
-        List<Command> commands = new ArrayList<Command>();
-        boolean moveTags = Main.pref.getBoolean("multipoly.movetags", true);
-
-        for( String key : values.keySet() ) {
-            List<OsmPrimitive> affectedWays = new ArrayList<OsmPrimitive>();
-            String value = values.get(key);
-
-            for( Way way : innerWays ) {
-                if( way.hasKey(key) && (value.equals(way.get(key))) ) {
-                    affectedWays.add(way);
-                }
-            }
-
-            if( moveTags ) {
-                // remove duplicated tags from outer ways
-                for( Way way : outerWays ) {
-                    if( way.hasKey(key) ) {
-                        affectedWays.add(way);
-                    }
-                }
-            }
-
-            if( affectedWays.size() > 0 ) {
+                for( String key : way.keySet() ) {
+                    if( !values.containsKey(key) ) { //relation values take precedence
+                        values.put(key, way.get(key));
+                    } else if( !relation.hasKey(key) && !values.get(key).equals(way.get(key)) ) {
+                        conflictingKeys.add(key);
+                    }
+                }
+            }
+        }
+
+        // filter out empty key conflicts - we need second iteration
+        if( !Main.pref.getBoolean("multipoly.alltags", false) )
+            for( RelationMember m : relation.getMembers() )
+                if( m.hasRole() && m.getRole().equals("outer") && m.isWay() )
+                    for( String key : values.keySet() )
+                        if( !m.getWay().hasKey(key) && !relation.hasKey(key) )
+                            conflictingKeys.add(key);
+
+        for( String key : conflictingKeys )
+            values.remove(key);
+
+        for( String linearTag : Main.pref.getCollection("multipoly.lineartagstokeep", DEFAULT_LINEAR_TAGS) )
+            values.remove(linearTag);
+
+        if( values.containsKey("natural") && values.get("natural").equals("coastline") )
+            values.remove("natural");
+
+        values.put("area", "yes");
+
+        List<Command> commands = new ArrayList<Command>();
+        boolean moveTags = Main.pref.getBoolean("multipoly.movetags", true);
+
+        for( String key : values.keySet() ) {
+            List<OsmPrimitive> affectedWays = new ArrayList<OsmPrimitive>();
+            String value = values.get(key);
+
+            for( Way way : innerWays ) {
+                if( way.hasKey(key) && (value.equals(way.get(key))) ) {
+                    affectedWays.add(way);
+                }
+            }
+
+            if( moveTags ) {
+                // remove duplicated tags from outer ways
+                for( Way way : outerWays ) {
+                    if( way.hasKey(key) ) {
+                        affectedWays.add(way);
+                    }
+                }
+            }
+
+            if( affectedWays.size() > 0 ) {
                 // reset key tag on affected ways
-                commands.add(new ChangePropertyCommand(affectedWays, key, null));
-            }
-        }
-
-        if( moveTags ) {
-            // add those tag values to the relation
-
-            boolean fixed = false;
-            Relation r2 = new Relation(relation);
-            for( String key : values.keySet() ) {
-                if( !r2.hasKey(key) && !key.equals("area") ) {
-                    if( relation.isNew() )
-                        relation.put(key, values.get(key));
-                    else
-                        r2.put(key, values.get(key));
-                    fixed = true;
-                }
-            }
-            if( fixed && !relation.isNew() )
-                commands.add(new ChangeCommand(relation, r2));
-        }
-
-        return commands;
+                commands.add(new ChangePropertyCommand(affectedWays, key, null));
+            }
+        }
+
+        if( moveTags ) {
+            // add those tag values to the relation
+
+            boolean fixed = false;
+            Relation r2 = new Relation(relation);
+            for( String key : values.keySet() ) {
+                if( !r2.hasKey(key) && !key.equals("area") ) {
+                    if( relation.isNew() )
+                        relation.put(key, values.get(key));
+                    else
+                        r2.put(key, values.get(key));
+                    fixed = true;
+                }
+            }
+            if( fixed && !relation.isNew() )
+                commands.add(new ChangeCommand(relation, r2));
+        }
+
+        return commands;
     }
 }

trunk/src/org/openstreetmap/josm/actions/MergeNodesAction.java

@@ -272 +272 @@
      * @param targetNode the target node the collection of nodes is merged to. Must not be null.
      * @param targetLocationNode this node's location will be used for the targetNode.
-     * @throw IllegalArgumentException thrown if layer is null
+     * @throws IllegalArgumentException thrown if layer is null
      */
     public static Command mergeNodes(OsmDataLayer layer, Collection<Node> nodes, Node targetNode, Node targetLocationNode) {

trunk/src/org/openstreetmap/josm/data/osm/User.java

@@ -119 +119 @@
      * Replies the user name
      *
-     * @return the user name. Never null, but may be the empty string
+     * @return the user name. Never <code>null</code>, but may be the empty string
      */
     public String getName() {
@@ -128 +128 @@
      * Returns the list of user names
      *
-     * @returns list of names
+     * @return list of names
      */
     public ArrayList<String> getNames() {
@@ -147 +147 @@
      *
      * @param name
+     * @return <code>true</code> if the name is in the names list
      */
     public boolean hasName(String name) {
@@ -160 +161 @@
      * always bound to a user with the same name.
      *
+     * @return the user id
      */
     public long getId() {