Skip to content

Commit

Permalink
ACCUMULO-4170 Clarify ClientConfiguration javadocs
Browse files Browse the repository at this point in the history
Updated the javadoc information for the loadDefaults() method.
Specifically reworked the default search path information to be
displayed as a list rather than inline, thereby easing readability.
Reworded a few of the sentences.

Closes #307
  • Loading branch information
jmark99 authored and keith-turner committed Oct 13, 2017
1 parent ae3aa10 commit e7d2bfa
Showing 1 changed file with 15 additions and 7 deletions.
Expand Up @@ -199,13 +199,21 @@ public ClientConfiguration(Configuration... configs) {
}

/**
* Attempts to load a configuration file from the system. Uses the "ACCUMULO_CLIENT_CONF_PATH" environment variable, split on File.pathSeparator, for a list
* of target files. If not set, uses the following in this order- ~/.accumulo/config $ACCUMULO_CONF_DIR/client.conf -OR- $ACCUMULO_HOME/conf/client.conf
* (depending on whether $ACCUMULO_CONF_DIR is set) /etc/accumulo/client.conf
*
* A client configuration will then be read from each location using PropertiesConfiguration to construct a configuration. That means the latest item will be
* the one in the configuration.
*
* Attempts to load a configuration file from the system using the default search paths. Uses the <em>ACCUMULO_CLIENT_CONF_PATH</em> environment variable,
* split on <em>File.pathSeparator</em>, for a list of target files.
* <p>
* If <em>ACCUMULO_CLIENT_CONF_PATH</em> is not set, uses the following in this order:
* <ul>
* <li>~/.accumulo/config
* <li><em>$ACCUMULO_CONF_DIR</em>/client.conf, if <em>$ACCUMULO_CONF_DIR</em> is defined.
* <li>/etc/accumulo/client.conf
* <li>/etc/accumulo/conf/client.conf
* </ul>
* <p>
* A client configuration will then be read from each location using <em>PropertiesConfiguration</em> to construct a configuration. That means the latest item
* will be the one in the configuration.
* <p>
*
* @see PropertiesConfiguration
* @see File#pathSeparator
*/
Expand Down

0 comments on commit e7d2bfa

Please sign in to comment.