Changeset 5481 in josm for trunk/src/org/openstreetmap/josm/Main.java

Timestamp:

2012-08-28T00:16:35+02:00 (12 years ago)

Author:

stoecker

Message:

some cleanup, mainly javadoc

File:

• trunk/src/org/openstreetmap/josm/Main.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/Main.java

@@ -16 +16 @@
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -151 +152 @@
     public MainMenu menu;
 
+    /**
+     * The data validation handler.
+     */
     public OsmValidator validator;
     /**
@@ -158 +162 @@
 
     /**
-     * Print a message if logging is on.
+     * Logging level (3 = debug, 2 = info, 1 = warn, 0 = none).
      */
     static public int log_level = 2;
+    /**
+     * Print a warning message if logging is on.
+     * @param msg The message to print.
+     */
     static public void warn(String msg) {
         if (log_level < 1)
@@ -166 +174 @@
         System.out.println(msg);
     }
+    /**
+     * Print an informational message if logging is on.
+     * @param msg The message to print.
+     */
     static public void info(String msg) {
         if (log_level < 2)
@@ -171 +183 @@
         System.out.println(msg);
     }
+    /**
+     * Print an debug message if logging is on.
+     * @param msg The message to print.
+     */
     static public void debug(String msg) {
         if (log_level < 3)
             return;
         System.out.println(msg);
+    }
+    /**
+     * Print a formated warning message if logging is on. Calls {@link MessageFormat#format}
+     * function to format text.
+     * @param msg The formated message to print.
+     * @param objects The objects to insert into format string.
+     */
+    static public void warn(String msg, Object... objects) {
+        warn(MessageFormat.format(msg, objects));
+    }
+    /**
+     * Print a formated informational message if logging is on. Calls {@link MessageFormat#format}
+     * function to format text.
+     * @param msg The formated message to print.
+     * @param objects The objects to insert into format string.
+     */
+    static public void info(String msg, Object... objects) {
+        info(MessageFormat.format(msg, objects));
+    }
+    /**
+     * Print a formated debug message if logging is on. Calls {@link MessageFormat#format}
+     * function to format text.
+     * @param msg The formated message to print.
+     * @param objects The objects to insert into format string.
+     */
+    static public void debug(String msg, Object... objects) {
+        debug(MessageFormat.format(msg, objects));
     }