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

Timestamp:

2016-04-09T17:07:54+02:00 (8 years ago)

Author:

Don-vip

Message:

refactor classes from corrector package, add javadoc

Location:

trunk/src/org/openstreetmap/josm/data

Files:

• correction (added)
• correction/Correction.java (moved) (moved from trunk/src/org/openstreetmap/josm/corrector/Correction.java ) (1 diff)
• correction/RoleCorrection.java (moved) (moved from trunk/src/org/openstreetmap/josm/corrector/RoleCorrection.java ) (1 diff)
• correction/TagCorrection.java (moved) (moved from trunk/src/org/openstreetmap/josm/corrector/TagCorrection.java ) (2 diffs)
• correction/package-info.java (added)
• package-info.java (added)
• projection/package-info.java (added)
• validation/package-info.java (added)

trunk/src/org/openstreetmap/josm/data/correction/Correction.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-package org.openstreetmap.josm.corrector;
+package org.openstreetmap.josm.data.correction;
 
+/**
+ * Data correction. Represents any change.
+ * @since 1001
+ */
 public interface Correction {
 

trunk/src/org/openstreetmap/josm/data/correction/RoleCorrection.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-package org.openstreetmap.josm.corrector;
+package org.openstreetmap.josm.data.correction;
 
 import org.openstreetmap.josm.data.osm.Relation;
 import org.openstreetmap.josm.data.osm.RelationMember;
 
+/**
+ * Represents a change of a single {@link RelationMember} role.
+ * @since 1001
+ */
 public class RoleCorrection implements Correction {
 
+    /** OSM relation */
     public final Relation relation;
+    /** Relation member index */
     public final int position;
+    /** Relation member */
     public final RelationMember member;
+    /** New role */
     public final String newRole;
 
-    public RoleCorrection(Relation relation, int position,
-                          RelationMember member, String newRole) {
+    /**
+     * Constructs a new {@code RoleCorrection}.
+     * @param relation OSM relation
+     * @param position relation member index
+     * @param member relation member
+     * @param newRole new role
+     */
+    public RoleCorrection(Relation relation, int position, RelationMember member, String newRole) {
         this.relation = relation;
         this.position = position;

trunk/src/org/openstreetmap/josm/data/correction/TagCorrection.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-package org.openstreetmap.josm.corrector;
+package org.openstreetmap.josm.data.correction;
 
 /**
- * TagCorrection reprepresents a change of a single
- * tag. Both key and value can be subject of this change.
+ * Represents a change of a single tag.
+ * Both key and value can be subject of this change.
+ * @since 729
  */
 public class TagCorrection implements Correction {
 
+    /** Old key */
     public final String oldKey;
+    /** New key */
     public final String newKey;
+    /** Old value */
     public final String oldValue;
+    /** New value */
     public final String newValue;
 
-    public TagCorrection(String oldKey, String oldValue, String newKey,
-            String newValue) {
+    /**
+     * Constructs a new {@code TagCorrection}.
+     * @param oldKey old key
+     * @param oldValue old value
+     * @param newKey new key
+     * @param newValue new value
+     */
+    public TagCorrection(String oldKey, String oldValue, String newKey, String newValue) {
         this.oldKey = oldKey;
         this.oldValue = oldValue;
@@ -21 +32 @@
     }
 
+    /**
+     * Determines if the key has changed.
+     * @return {@code true} if the key has changed
+     */
     public boolean isKeyChanged() {
         return !newKey.equals(oldKey);
     }
 
+    /**
+     * Determines if the value has changed.
+     * @return {@code true} if the value has changed
+     */
     public boolean isValueChanged() {
         return !newValue.equals(oldValue);