Javadoc

Author: garydgregory

src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java

@@ -1385,7 +1385,7 @@ public void setListDelimiterHandler(final ListDelimiterHandler listDelimiterHand
     }
 
     /**
-     * Allows setting the logger to be used by this configuration object. This method makes it possible for clients to
+     * Sets the logger to be used by this configuration object. This method makes it possible for clients to
      * exactly control logging behavior. Per default a logger is set that will ignore all log messages. Derived classes that
      * want to enable logging should call this method during their initialization with the logger to be used. It is legal to
      * pass a <strong>null</strong> logger; in this case, logging will be disabled.

src/main/java/org/apache/commons/configuration2/INIConfiguration.java

@@ -599,7 +599,7 @@ private String escapeValue(final String value) {
     }
 
     /**
-     * Tries to find the index of the separator character in the given string. This method checks for the presence of
+     * Finds the index of the separator character in the given string. This method checks for the presence of
      * separator characters in the given string. If multiple characters are found, the first one is assumed to be the
      * correct separator. If there are quoting characters, they are taken into account, too.
      *
@@ -729,7 +729,7 @@ private boolean isCommentChar(final char c) {
     }
 
     /**
-     * Determine if the given line is a comment line.
+     * Tests if the given line is a comment line.
      *
      * @param line The line to check.
      * @return true if the line is empty or starts with one of the comment characters
@@ -743,7 +743,7 @@ protected boolean isCommentLine(final String line) {
     }
 
     /**
-     * Determine if the given line is a section.
+     * Tests if the given line is a section.
      *
      * @param line The line to check.
      * @return true if the line contains a section
@@ -781,7 +781,7 @@ private boolean lineContinues(final String line, final int pos) {
     }
 
     /**
-     * Parse the value to remove the quotes and ignoring the comment. Example:
+     * Parses the value to remove the quotes and ignoring the comment. Example:
      *
      * <pre>
      * &quot;value&quot; ; comment -&gt; value
@@ -868,7 +868,7 @@ private String parseValue(final String val, final BufferedReader reader) throws
     }
 
     /**
-     * Load the configuration from the given reader. Note that the {@code clear()} method is not called so the configuration
+     * Reads the configuration from the given reader. Note that the {@code clear()} method is not called so the configuration
      * read in will be merged with the current configuration.
      *
      * @param in the reader to read the configuration from.
@@ -887,7 +887,7 @@ public void read(final Reader in) throws ConfigurationException, IOException {
     }
 
     /**
-     * Allows setting the leading comment separator which is used in reading an INI file
+     * Sets the leading comment separator which is used in reading an INI file
      *
      * @param separator String of the new separator for INI reading
      * @since 2.5
@@ -902,7 +902,7 @@ public void setCommentLeadingCharsUsedInInput(final String separator) {
     }
 
     /**
-     * Allows setting the key and value separator which is used in reading an INI file
+     * Sets the key and value separator which is used in reading an INI file
      *
      * @param separator String of the new separator for INI reading
      * @since 2.5
@@ -917,7 +917,7 @@ public void setSeparatorUsedInInput(final String separator) {
     }
 
     /**
-     * Allows setting the key and value separator which is used for the creation of the resulting INI output
+     * Sets the key and value separator which is used for the creation of the resulting INI output
      *
      * @param separator String of the new separator for INI output
      * @since 2.2
@@ -927,7 +927,7 @@ public void setSeparatorUsedInOutput(final String separator) {
     }
 
     /**
-     * Save the configuration to the specified writer.
+     * Writes the configuration to the specified writer.
      *
      * @param writer   The writer to save the configuration to.
      * @throws ConfigurationException If an error occurs while writing the configuration

src/main/java/org/apache/commons/configuration2/builder/INIBuilderProperties.java

@@ -34,7 +34,7 @@
 public interface INIBuilderProperties<T> {
 
     /**
-     * Allows setting the leading comment separator which is used in reading an INI file.
+     * Sets the leading comment separator which is used in reading an INI file.
      *
      * @param separator String of the new separator for INI reading
      * @return a reference to this object for method chaining
@@ -46,7 +46,7 @@ default T setCommentLeadingCharsUsedInInput(final String separator) {
     }
 
     /**
-     * Allows setting the key and value separator which is used in reading an INI file.
+     * Sets the key and value separator which is used in reading an INI file.
      *
      * @param separator String of the new separator for INI reading
      * @return a reference to this object for method chaining
@@ -58,7 +58,7 @@ default T setSeparatorUsedInInput(final String separator) {
     }
 
     /**
-     * Allows setting the separator between key and value to be used when writing an INI file.
+     * Sets the separator between key and value to be used when writing an INI file.
      *
      * @param separator the new separator for INI output
      * @return a reference to this object for method chaining

src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java

@@ -38,7 +38,7 @@
 public interface XMLBuilderProperties<T> {
 
     /**
-     * Allows setting the {@code DocumentBuilder} for parsing an XML document. This is the most flexible way of customizing
+     * Sets the {@code DocumentBuilder} for parsing an XML document. This is the most flexible way of customizing
      * XML processing.
      *
      * @param docBuilder the {@code DocumentBuilder} to use
@@ -47,7 +47,7 @@ public interface XMLBuilderProperties<T> {
     T setDocumentBuilder(DocumentBuilder docBuilder);
 
     /**
-     * Allows setting the {@code EntityResolver} which maps entity references during XML parsing.
+     * Sets the {@code EntityResolver} which maps entity references during XML parsing.
      *
      * @param resolver the {@code EntityResolver} to use
      * @return a reference to this object for method chaining

src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java

@@ -482,7 +482,7 @@ public void setInterpolator(final ConfigurationInterpolator ci) {
     }
 
     /**
-     * Allows setting the logger to be used by this object. This method makes it possible for clients to exactly control
+     * Sets the logger to be used by this object. This method makes it possible for clients to exactly control
      * logging behavior. Per default a logger is set that will ignore all log messages. Derived classes that want to enable
      * logging should call this method during their initialization with the logger to be used. Passing in <strong>null</strong> as
      * argument disables logging.

src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java

@@ -145,7 +145,7 @@ public void read(final Reader in) throws ConfigurationException, IOException {
         }
 
         /**
-         * Allows setting the content.
+         * Sets the content.
          *
          * @param content the content
          */