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

Timestamp:

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

Author:

michael2402

Message:

See #14794: More javadoc for data.osm package

Location:

trunk/src/org/openstreetmap/josm/data/osm

Files:

• AbstractPrimitive.java (modified) (3 diffs)
• BBox.java (modified) (2 diffs)
• ChangesetCacheListener.java (modified) (1 diff)
• NodeData.java (modified) (1 diff)
• OsmPrimitive.java (modified) (1 diff)
• RelationMemberData.java (modified) (1 diff)
• RelationToChildReference.java (modified) (3 diffs)
• SimplePrimitiveId.java (modified) (2 diffs)
• WayData.java (modified) (3 diffs)
• history/HistoryDataSet.java (modified) (1 diff)

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

@@ -307 +307 @@
     }
 
+    /**
+     * Gets the type this primitive is displayed at
+     * @return A {@link OsmPrimitiveType}
+     */
     public OsmPrimitiveType getDisplayType() {
         return getType();
@@ -669 +673 @@
     }
 
+    /**
+     * Gets a key ignoring the case of the key
+     * @param key The key to get
+     * @return The value for a key that matches the given key ignoring case.
+     */
     public final String getIgnoreCase(String key) {
         String[] keys = this.keys;
@@ -681 +690 @@
     }
 
+    /**
+     * Gets the number of keys
+     * @return The number of keys set for this primitive.
+     */
     public final int getNumKeys() {
         String[] keys = this.keys;

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

@@ -299 +299 @@
     }
 
+    /**
+     * Converts the bounds to a rectangle
+     * @return The rectangle in east/north space.
+     */
     public Rectangle2D toRectangle() {
         return new Rectangle2D.Double(xmin, ymin, xmax - xmin, ymax - ymin);
@@ -339 +343 @@
     }
 
+    /**
+     * Creates a CSV string for this bbox
+     * @param separator The separator to use
+     * @return A string
+     */
     public String toStringCSV(String separator) {
         return Utils.join(separator, Arrays.asList(

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

@@ -2 +2 @@
 package org.openstreetmap.josm.data.osm;
 
+/**
+ * A listener that listens to changes on the {@link ChangesetCache}
+ * @see ChangesetCacheEvent
+ */
 @FunctionalInterface
 public interface ChangesetCacheListener {
 
+    /**
+     * Gets notified on changeset cache updates
+     * @param event The event that happened
+     */
     void changesetCacheUpdated(ChangesetCacheEvent event);
 }

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

@@ -7 +7 @@
 import org.openstreetmap.josm.data.projection.Projections;
 
+/**
+ * The data on a single node (tags and position) that is stored in the database
+ */
 public class NodeData extends PrimitiveData implements INode {
 

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

@@ -1014 +1014 @@
     }
 
+    /**
+     * Gets a list of all primitives in the current dataset that reference this primitive.
+     * @return The referrers
+     */
     public final List<OsmPrimitive> getReferrers() {
         return getReferrers(false);

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

@@ -7 +7 @@
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 
+/**
+ * This is the data (role, type and id) that is stored in the database for a given relation member.
+ */
 public class RelationMemberData implements PrimitiveId, Serializable {
 

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;

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

@@ -10 +10 @@
 import java.util.regex.Pattern;
 
+/**
+ * A primitive id and a primitive type
+ */
 public class SimplePrimitiveId implements PrimitiveId, Serializable {
 
@@ -17 +20 @@
     private final OsmPrimitiveType type;
 
+    /**
+     * A pattern that is used to parse a textual primitive id
+     */
     public static final Pattern ID_PATTERN = Pattern.compile("(n|node|w|way|r|rel|relation)[ /]?(\\d+)");
 
+    /**
+     * A pattern that is used to parse an id range
+     */
     public static final Pattern MULTIPLE_IDS_PATTERN = Pattern.compile(ID_PATTERN.pattern() + "(-(\\d+))?");
 
+    /**
+     * Create a new primtive id
+     * @param id The id
+     * @param type The type of the primitive
+     */
     public SimplePrimitiveId(long id, OsmPrimitiveType type) {
         this.id = id;

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

@@ -3 +3 @@
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 
 import org.openstreetmap.josm.data.osm.visitor.PrimitiveVisitor;
 
+/**
+ * The data (tags and node ids) that is stored for a way in the database
+ */
 public class WayData extends PrimitiveData implements IWay {
 
@@ -37 +41 @@
     }
 
+    /**
+     * Gets a list of nodes the way consists of
+     * @return The ids of the nodes
+     */
     public List<Long> getNodes() {
-        return nodes;
+        return Collections.unmodifiableList(nodes);
     }
 
@@ -57 +65 @@
     }
 
+    /**
+     * Sets the nodes array
+     * @param nodes The nodes this way consists of
+     */
     public void setNodes(List<Long> nodes) {
         this.nodes = new ArrayList<>(nodes);

trunk/src/org/openstreetmap/josm/data/osm/history/HistoryDataSet.java

@@ -197 +197 @@
     }
 
+    /**
+     * Gets a unsorted set of all changeset ids that were used by the primitives in this data set
+     * @return The ids
+     */
     public Collection<Long> getChangesetIds() {
         final Set<Long> ids = new HashSet<>();