Changeset 12190 in josm for trunk/src/org/openstreetmap/josm/data/osm/RelationToChildReference.java

Timestamp:

2017-05-16T00:01:44+02:00 (7 years ago)

Author:

michael2402

Message:

See #14794: More javadoc for data.osm package

File:

• trunk/src/org/openstreetmap/josm/data/osm/RelationToChildReference.java (modified) (3 diffs)

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

@@ -7 +7 @@
 import java.util.Set;
 
+/**
+ * This is an extension of {@link RelationMember} that stores the parent relation and the index in it in addition to the role/child.
+ */
 public class RelationToChildReference {
 
@@ -48 +51 @@
     private final OsmPrimitive child;
 
+    /**
+     * Create a new {@link RelationToChildReference}
+     * @param parent The parent relation
+     * @param position The position of the child in the parent
+     * @param role The role of the child
+     * @param child The actual child (member of parent)
+     */
     public RelationToChildReference(Relation parent, int position, String role, OsmPrimitive child) {
         this.parent = parent;
@@ -55 +65 @@
     }
 
+    /**
+     * Create a new {@link RelationToChildReference}
+     * @param parent The parent relation
+     * @param position The position of the child in the parent
+     * @param member The role and relation for the child
+     */
     public RelationToChildReference(Relation parent, int position, RelationMember member) {
-        this.parent = parent;
-        this.position = position;
-        this.role = member.getRole();
-        this.child = member.getMember();
+        this(parent, position, member.getRole(), member.getMember());
     }
 
+    /**
+     * Get the parent relation
+     * @return The parent
+     */
     public Relation getParent() {
         return parent;
     }
 
+    /**
+     * Get the position of the child in the parent
+     * @return The position of the child
+     */
     public int getPosition() {
         return position;
     }
 
+    /**
+     * Get the role of the child
+     * @return The role
+     */
     public String getRole() {
         return role;
     }
 
+    /**
+     * Get the actual child
+     * @return The child
+     */
     public OsmPrimitive getChild() {
         return child;