Skip to content
This repository has been archived by the owner on Apr 5, 2022. It is now read-only.

Commit

Permalink
javadoc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Costin Leau committed Feb 6, 2012
1 parent 58c95ee commit ccb361d
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 5 deletions.
Expand Up @@ -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);
}
Expand Down
Expand Up @@ -109,40 +109,59 @@ public void setBeanClassLoader(ClassLoader classLoader) {


/**
* Sets the parent configuration.
*
* @param configuration The configuration to set.
*/
public void setConfiguration(Configuration configuration) {
this.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) {
this.loadDefaults = loadDefaults;
}

/**
* Sets the configuration resources.
*
* @param resources The resources to set.
*/
public void setResources(Set<Resource> resources) {
this.resources = resources;
}

/**
* Sets the configuration properties.
*
* @param properties The properties to set.
*/
public void setProperties(Properties properties) {
this.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;
}
Expand Down
Expand Up @@ -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");
Expand All @@ -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());
Expand Down

0 comments on commit ccb361d

Please sign in to comment.