Changeset 5386 in josm for trunk/src/org/openstreetmap/josm/io/OsmApiInitializationException.java

Timestamp:

2012-07-31T21:48:49+02:00 (12 years ago)

Author:

Don-vip

Message:

see #7914 - Introduce OsmApi.MAX_DOWNLOAD_THREADS and improve javadoc in some classes of josm.io package

File:

• trunk/src/org/openstreetmap/josm/io/OsmApiInitializationException.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/io/OsmApiInitializationException.java

@@ -2 +2 @@
 package org.openstreetmap.josm.io;
 
+/**
+ * Exception thrown when a communication error occured with the OSM server during API initialization.
+ * @see OsmApi#initialize
+ */
 public class OsmApiInitializationException extends OsmTransferException {
 
-    public OsmApiInitializationException() {
-        super();
-    }
-
-    public OsmApiInitializationException(String message, Throwable cause) {
-        super(message, cause);
-    }
-
+    /**
+     * Constructs an {@code OsmApiInitializationException} with the specified detail message.
+     * The cause is not initialized, and may subsequently be initialized by a call to {@link #initCause}.
+     *
+     * @param message The detail message (which is saved for later retrieval by the {@link #getMessage} method)
+     */
     public OsmApiInitializationException(String message) {
         super(message);
     }
 
+    /**
+     * Constructs an {@code OsmApiInitializationException} with the specified cause and a detail message of 
+     * <tt>(cause==null ? null : cause.toString())</tt> 
+     * (which typically contains the class and detail message of <tt>cause</tt>).
+     *
+     * @param cause the cause (which is saved for later retrieval by the {@link #getCause} method). 
+     *              A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.
+     */
     public OsmApiInitializationException(Throwable cause) {
         super(cause);
     }
+
+    /**
+     * Constructs an {@code OsmApiInitializationException} with the specified detail message and cause.
+     *
+     * <p> Note that the detail message associated with {@code cause} is <i>not</i> automatically incorporated 
+     * into this exception's detail message.
+     *
+     * @param message The detail message (which is saved for later retrieval by the {@link #getMessage} method)
+     * @param cause   The cause (which is saved for later retrieval by the {@link #getCause} method).
+     *                A null value is permitted, and indicates that the cause is nonexistent or unknown.
+     *
+     */
+    public OsmApiInitializationException(String message, Throwable cause) {
+        super(message, cause);
+    }
 }