From ccb361d3de525005d753f18facaa7aa1ea709c3a Mon Sep 17 00:00:00 2001
From: Costin Leau <cleau@vmware.com>
Date: Mon, 6 Feb 2012 18:40:19 +0200
Subject: [PATCH] javadoc updates

---
 .../data/hadoop/HadoopSecurityException.java  | 11 ++++++++++
 .../ConfigurationFactoryBean.java             | 21 ++++++++++++++++++-
 .../configuration/ConfigurationUtils.java     |  9 ++++----
 3 files changed, 36 insertions(+), 5 deletions(-)

diff --git a/src/main/java/org/springframework/data/hadoop/HadoopSecurityException.java b/src/main/java/org/springframework/data/hadoop/HadoopSecurityException.java
index 0d7eea83a..9dff53d21 100644
--- a/src/main/java/org/springframework/data/hadoop/HadoopSecurityException.java
+++ b/src/main/java/org/springframework/data/hadoop/HadoopSecurityException.java
@@ -23,10 +23,21 @@
 @SuppressWarnings("serial")
 public class HadoopSecurityException extends HadoopException {
 
+	/**
+	 * Constructs a new <code>HadoopSecurityException</code> instance.
+	 *
+	 * @param message message
+	 * @param ex exception
+	 */
 	public HadoopSecurityException(String message, Throwable ex) {
 		super(message, ex);
 	}
 
+	/**
+	 * Constructs a new <code>HadoopSecurityException</code> instance.
+	 *
+	 * @param message message
+	 */
 	public HadoopSecurityException(String message) {
 		super(message);
 	}
diff --git a/src/main/java/org/springframework/data/hadoop/configuration/ConfigurationFactoryBean.java b/src/main/java/org/springframework/data/hadoop/configuration/ConfigurationFactoryBean.java
index 129c673a5..33db6a9a0 100644
--- a/src/main/java/org/springframework/data/hadoop/configuration/ConfigurationFactoryBean.java
+++ b/src/main/java/org/springframework/data/hadoop/configuration/ConfigurationFactoryBean.java
@@ -109,6 +109,8 @@ public void setBeanClassLoader(ClassLoader classLoader) {
 
 
 	/**
+	 * Sets the parent configuration.
+	 * 
 	 * @param configuration The configuration to set.
 	 */
 	public void setConfiguration(Configuration configuration) {
@@ -116,6 +118,8 @@ public void setConfiguration(Configuration configuration) {
 	}
 
 	/**
+	 * Indicates whether to load the defaults (the default) or not for this configuration.
+	 * 
 	 * @param loadDefaults The loadDefaults to set.
 	 */
 	public void setLoadDefaults(boolean loadDefaults) {
@@ -123,6 +127,8 @@ public void setLoadDefaults(boolean loadDefaults) {
 	}
 
 	/**
+	 * Sets the configuration resources.
+	 * 
 	 * @param resources The resources to set.
 	 */
 	public void setResources(Set<Resource> resources) {
@@ -130,6 +136,8 @@ public void setResources(Set<Resource> resources) {
 	}
 
 	/**
+	 * Sets the configuration properties.
+	 * 
 	 * @param properties The properties to set.
 	 */
 	public void setProperties(Properties properties) {
@@ -137,12 +145,23 @@ public void setProperties(Properties properties) {
 	}
 
 	/**
-	 * @param initialize The initialize to set.
+	 * Indicates whether the configuration object should be initialized (true) or not.
+	 * This option should normally be set to true as it causes the jars, streams and resources
+	 * set to be loaded - postponing the initializing might cause these to become unreadable.
+	 * 
+	 * @param initialize whether to initialize or not.
 	 */
 	public void setInitialize(boolean initialize) {
 		this.initialize = initialize;
 	}
 
+	/**
+	 * Indicates whether the configuration should register an URL handler (for allowing urls
+	 * to understand HDFS prefixes, such as hdfs) or not. As this operation impacts an entire VM
+	 * and can be invoked at most once per JVM, by default it is false.
+	 * 
+	 * @param register whether to register an URL handler or not
+	 */
 	public void setRegisterUrlHandler(boolean register) {
 		this.registerJvmUrl = register;
 	}
diff --git a/src/main/java/org/springframework/data/hadoop/configuration/ConfigurationUtils.java b/src/main/java/org/springframework/data/hadoop/configuration/ConfigurationUtils.java
index 3e725de57..a13012ad4 100644
--- a/src/main/java/org/springframework/data/hadoop/configuration/ConfigurationUtils.java
+++ b/src/main/java/org/springframework/data/hadoop/configuration/ConfigurationUtils.java
@@ -31,8 +31,8 @@ public abstract class ConfigurationUtils {
 	/**
 	 * Adds the specified properties to the given {@link Configuration} object.  
 	 * 
-	 * @param configuration
-	 * @param properties
+	 * @param configuration configuration to manipulate. Should not be null.
+	 * @param properties properties to add to the configuration. May be null.
 	 */
 	public static void addProperties(Configuration configuration, Properties properties) {
 		Assert.notNull(configuration, "A non-null configuration is required");
@@ -48,8 +48,9 @@ public static void addProperties(Configuration configuration, Properties propert
 	/**
 	 * Creates a new {@link Configuration} based on the given arguments.
 	 * 
-	 * @param original
-	 * @param properties
+	 * @param original initial configuration to read from. May be null. 
+	 * @param properties properties object to add to the newly created configuration. May be null.
+	 * @return newly created configuration based on the input parameters.
 	 */
 	public static Configuration createFrom(Configuration original, Properties properties) {
 		Configuration cfg = (original != null ? new Configuration(original) : new Configuration());