Changeset 2275 in josm for trunk

Timestamp:

2009-10-11T22:03:25+02:00 (15 years ago)

Author:

Gubaer

Message:

fixed #3694: History dialog for relations does not work

Location:

trunk/src/org/openstreetmap/josm/gui/history

Files:

• HistoryBrowser.java (modified) (1 diff)
• HistoryLoadTask.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/gui/history/HistoryBrowser.java

@@ -139 +139 @@
         } else if (history.getEarliest().getType().equals(OsmPrimitiveType.RELATION)) {
             tpViewers.add(relationMemberListViewer);
-            tpViewers.setTitleAt(2, tr("Members"));
+            tpViewers.setTitleAt(1, tr("Members"));
         }
         revalidate();

trunk/src/org/openstreetmap/josm/gui/history/HistoryLoadTask.java

@@ -22 +22 @@
 import org.xml.sax.SAXException;
 
+/**
+ * Loads the the object history of an collection of objects from the
+ * server.
+ *
+ * It provides a fluent API for configuration.
+ * 
+ * Sample usage:
+ * 
+ * <pre>
+ *   HistoryLoadTask task  = new HistoryLoadTask()
+ *      .add(1, OsmPrimitiveType.NODE)
+ *      .add(1233, OsmPrimitiveType.WAY)
+ *      .add(37234, OsmPrimitveType.RELATION)
+ *      .add(aHistoryItem);
+ * 
+ *   Main.worker.execute(task);
+ * 
+ * </pre>
+ */
 public class HistoryLoadTask extends PleaseWaitRunnable {
 
@@ -34 +53 @@
     }
 
+    /**
+     * Adds an object whose history is to be loaded.
+     * 
+     * @param id the object id
+     * @param type the object type
+     * @return this task
+     */
     public HistoryLoadTask add(long id, OsmPrimitiveType type) {
         if (id <= 0)
@@ -45 +71 @@
     }
 
-    public HistoryLoadTask add(HistoryOsmPrimitive primitive) {
+    /**
+     * Adds an object to be loaded, the object is specified by a history item.
+     * 
+     * @param primitive the history item
+     * @return this task
+     * @throws IllegalArgumentException thrown if primitive is null
+     */
+    public HistoryLoadTask add(HistoryOsmPrimitive primitive) throws IllegalArgumentException  {
         if (primitive == null)
             throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null.", "primitive"));
@@ -54 +87 @@
     }
 
-    public HistoryLoadTask add(History history) {
+    /**
+     * Adds an object to be loaded, the object is specified by an already loaded object history.
+     * 
+     * @param history the history. Must not be null.
+     * @return this task
+     * @throws IllegalArgumentException thrown if history is null
+     */
+    public HistoryLoadTask add(History history)throws IllegalArgumentException {
         if (history == null)
             throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null.", "history"));
@@ -63 +103 @@
     }
 
-    public HistoryLoadTask add(OsmPrimitive primitive) {
+    /**
+     * Adds an object to be loaded, the object is specified by an OSM primitive.
+     * 
+     * @param primitive the OSM primitive. Must not be null. primitive.getId() > 0 required.
+     * @return this task
+     * @throws IllegalArgumentException thrown if the primitive is null
+     * @throws IllegalArgumentException thrown if primitive.getId() <= 0
+     */
+    public HistoryLoadTask add(OsmPrimitive primitive) throws IllegalArgumentException {
         if (primitive == null)
             throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null.", "primitive"));
+        if (primitive.getId() <= 0)
+            throw new IllegalArgumentException(tr("Object id > 0 expected. Got {0}", primitive.getId()));
+
         return add(primitive.getId(), OsmPrimitiveType.from(primitive));
     }
 
-    public HistoryLoadTask add(Collection<? extends OsmPrimitive> primitives) {
+    /**
+     * Adds a collection of objects to loaded, specified by a collection of OSM primitives.
+     * 
+     * @param primitive the OSM primitive. Must not be null. primitive.getId() > 0 required.
+     * @return this task
+     * @throws IllegalArgumentException thrown if primitives is null
+     * @throws IllegalArgumentException thrown if one of the ids in the collection <= 0
+     */
+    public HistoryLoadTask add(Collection<? extends OsmPrimitive> primitives) throws IllegalArgumentException{
         if (primitives == null)
             throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null.", "primitives"));