Changeset 12364 in josm for trunk

Timestamp:

2017-06-09T19:51:54+02:00 (7 years ago)

Author:

michael2402

Message:

Javadoc: CyclicUploadDependencyException

File:

• trunk/src/org/openstreetmap/josm/actions/upload/CyclicUploadDependencyException.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/actions/upload/CyclicUploadDependencyException.java

@@ -10 +10 @@
 import org.openstreetmap.josm.data.osm.Relation;
 
+/**
+ * This is an exception that is thrown if the user attempts to upload a list of relations with a cyclic dependency in them
+ */
 public class CyclicUploadDependencyException extends Exception {
     private final Stack<Relation> cycle;
 
+    /**
+     * Creates a new {@link CyclicUploadDependencyException}
+     * @param cycle The cycle that was found
+     */
     public CyclicUploadDependencyException(Stack<Relation> cycle) {
         this.cycle = cycle;
@@ -44 +51 @@
     }
 
+    /**
+     * Gets the cycle
+     * @return The cycle that was detected
+     */
     public List<Relation> getCyclicUploadDependency() {
         return new ArrayList<>(cycle);