Changeset 2101 for FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/handlers/PropertiesLoader.java

Timestamp:

2008-06-23 00:00:48 (7 months ago)

Author:

mosipov

Message:

NEW - #1968: Javadoc issues

Files:

• FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/handlers/PropertiesLoader.java (modified) (4 diffs)

FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/handlers/PropertiesLoader.java

@@ -26 +26 @@
 import java.util.Properties;
 
-import net.fckeditor.tool.Utils;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Handler to hold the basic properties.<br>
- * The main default file is 'default.properties' in the deepth of the classpath and should be
- * untouched. If there is a file named 'fckeditor.properties' in the root of the classpath, it will
- * be loaded. Values which are loaded before, will be overwritten.<br>
- * If you won't use an extra properties file to adjust the defaults, you can use
- * {@link #setProperty(String, String)} instead.
+ * This handler gives you access to properties stored in
+ * <code>/net/fckeditor/handlers/default.properties</code> and
+ * <code>/fckeditor.properties</code>.<br />
+ * This class loads the properties files as follows:
+ * <ol>
+ * <li>Load <code>default.properties</code></li>
+ * <li>Load <code>fckeditor.properties</code> if present.</li>
+ * </ol>
+ * <em>Attention</em>: Properties specified in
+ * <code>fckeditor.properties</code> will override properties loaded from
+ * <code>default.properties</code>. (intended behavior)<br />
+ * <em>Hint</em>: You may set properties programmatically with
+ * {@link #setProperty(String, String)} instead or additionally.
  * 
  * @version $Id$
@@ -47 +52 @@
         static {
                 try {
-                        // 1. load system defaults
+                        // 1. load library defaults
                         properties.load(new BufferedInputStream(PropertiesLoader.class
                                 .getResourceAsStream("default.properties")));
@@ -54 +59 @@
                         InputStream in = PropertiesLoader.class.getResourceAsStream("/fckeditor.properties");
                         if (in == null)
-                                logger.warn("Can't find user properties!");
+                                logger.warn("Can't find fckeditor.properties!");
                         else {
                                 try {
                                         properties.load(new BufferedInputStream(in));
-                                        logger.info("User's properties loaded successfully!");
+                                        logger.info("fckeditor.properties loaded successfully!");
                                 } catch (IOException e) {
-                                        logger.error("Error while loading user properties!", e);
-                                        throw new RuntimeException("Can't load user properties!", e);
+                                        logger.error("Error while loading fckeditor.properties!", e);
+                                        throw new RuntimeException("Can't load fckeditor.properties!", e);
                                 }
                         }
                 } catch (IOException e) {
-                        logger.error("Error while loading default properties!", e);
-                        throw new RuntimeException("Can't load default properties!", e);
+                        logger.error("Error while loading default.properties!", e);
+                        throw new RuntimeException("Can't load default.properties!", e);
                 }
         }
 
         /**
-         * Getter for a property of 'key'.
+         * Getter for a property.
          * 
          * @param key
-         *            the propery key
-         * @return the value in this property list with the specified key value.
+         *            The property key.
+         * @return The value for the specified key.
          * @see Properties#getProperty(String)
          */
@@ -83 +88 @@
 
         /**
-         * Setter for a property. If the property already exists, the value will be overwritten.<br>
-         * Hint: This method is intended for an alternative way to set user defaults programmatically
-         * instead of using the 'fckeditor.properties'. It should never used inside FCKeditor.Java !!!
+         * Setter for a property. If the property already exists, the value will be
+         * overridden.<br />
+         * <em>Hint</em>: This method is intended as an alternative way to set
+         * properties programmatically instead of using the
+         * <code>fckeditor.properties</code>. It should never used inside
+         * FCKeditor.Java!!!
          * 
          * @param key
-         *            key the propery key
+         *            The property key.
          * @param value
-         * @throws IllegalArgumentException
-         *             if 'key' is empty.
+         *            The property value.
          * @see Properties#setProperty(String, String)
          */
         public static void setProperty(final String key, final String value) {
-                if (Utils.isEmpty(key))
-                        new IllegalArgumentException("The 'key' of a property schouldn't be null!");
                 properties.setProperty(key, value);
         }