checkManagedControllers(final Col
* Creates a new instance of {@code CombinedReloadingController} and initializes it with the {@code ReloadingController}
* objects to be managed.
*
- * @param subCtrls the collection with sub {@code ReloadingController}s (must not be null or contain null
+ * @param subCtrls the collection with sub {@code ReloadingController}s (must not be null or contain null
* entries)
- * @throws IllegalArgumentException if the passed in collection is null or contains null entries
+ * @throws IllegalArgumentException if the passed in collection is null or contains null entries
*/
public CombinedReloadingController(final Collection subCtrls) {
super(DUMMY);
diff --git a/src/main/java/org/apache/commons/configuration2/reloading/FileHandlerReloadingDetector.java b/src/main/java/org/apache/commons/configuration2/reloading/FileHandlerReloadingDetector.java
index ea0b4d1cf6..c1288af142 100644
--- a/src/main/java/org/apache/commons/configuration2/reloading/FileHandlerReloadingDetector.java
+++ b/src/main/java/org/apache/commons/configuration2/reloading/FileHandlerReloadingDetector.java
@@ -36,7 +36,7 @@
*
* Because file I/O may be expensive it is possible to configure a refresh delay as a time in milliseconds. This is the
* minimum interval between two checks. If the {@code isReloadingRequired()} method is called in shorter intervals, it
- * does not perform a check, but directly returns false.
+ * does not perform a check, but directly returns false.
*
*
* To initialize an instance either {@code isReloadingRequired()} or {@code reloadingPerformed()} can be called. The
@@ -57,7 +57,7 @@ public class FileHandlerReloadingDetector implements ReloadingDetector {
* Helper method for transforming a URL into a file object. This method handles file: and jar: URLs.
*
* @param url the URL to be converted
- * @return the resulting file or null
+ * @return the resulting file or null
*/
private static File fileFromURL(final URL url) {
if (JAR_PROTOCOL.equals(url.getProtocol())) {
@@ -95,7 +95,7 @@ public FileHandlerReloadingDetector() {
* Creates a new instance of {@code FileHandlerReloadingDetector} and initializes it with the {@code FileHandler} to
* monitor and a default refresh delay.
*
- * @param handler the {@code FileHandler} associated with this detector (can be null)
+ * @param handler the {@code FileHandler} associated with this detector (can be null)
*/
public FileHandlerReloadingDetector(final FileHandler handler) {
this(handler, DEFAULT_REFRESH_DELAY_MILLIS);
@@ -106,7 +106,7 @@ public FileHandlerReloadingDetector(final FileHandler handler) {
* monitor and the refresh delay. The handler is directly used, no copy is created. So it is possible to change the
* location monitored by manipulating the {@code FileHandler} object.
*
- * @param handler the {@code FileHandler} associated with this detector (can be null)
+ * @param handler the {@code FileHandler} associated with this detector (can be null)
* @param refreshDelayMillis the refresh delay; a value of 0 means that a check is performed in all cases
*/
public FileHandlerReloadingDetector(final FileHandler handler, final long refreshDelayMillis) {
@@ -115,9 +115,9 @@ public FileHandlerReloadingDetector(final FileHandler handler, final long refres
}
/**
- * Gets the monitored {@code File} or null if it does not exist.
+ * Gets the monitored {@code File} or null if it does not exist.
*
- * @return the monitored {@code File} or null
+ * @return the monitored {@code File} or null
*/
private File getExistingFile() {
File file = getFile();
@@ -130,10 +130,10 @@ private File getExistingFile() {
/**
* Gets the {@code File} object which is monitored by this object. This method is called every time the file's last
- * modification time is needed. If it returns null, no check is performed. This base implementation obtains the
+ * modification time is needed. If it returns null, no check is performed. This base implementation obtains the
* {@code File} from the associated {@code FileHandler}. It can also deal with URLs to jar files.
*
- * @return the {@code File} to be monitored (can be null)
+ * @return the {@code File} to be monitored (can be null)
*/
protected File getFile() {
final URL url = getFileHandler().getURL();
diff --git a/src/main/java/org/apache/commons/configuration2/reloading/PeriodicReloadingTrigger.java b/src/main/java/org/apache/commons/configuration2/reloading/PeriodicReloadingTrigger.java
index 7788cfdc6e..16a4780790 100644
--- a/src/main/java/org/apache/commons/configuration2/reloading/PeriodicReloadingTrigger.java
+++ b/src/main/java/org/apache/commons/configuration2/reloading/PeriodicReloadingTrigger.java
@@ -80,7 +80,7 @@ private static ScheduledExecutorService createDefaultExecutorService() {
/**
* Creates a new instance of {@code PeriodicReloadingTrigger} with a default executor service.
*
- * @param ctrl the {@code ReloadingController} (must not be null)
+ * @param ctrl the {@code ReloadingController} (must not be null)
* @param ctrlParam the optional parameter to be passed to the controller when doing reloading checks
* @param triggerPeriod the period in which the controller is triggered
* @param unit the time unit for the period
@@ -93,11 +93,11 @@ public PeriodicReloadingTrigger(final ReloadingController ctrl, final Object ctr
/**
* Creates a new instance of {@code PeriodicReloadingTrigger} and sets all parameters.
*
- * @param ctrl the {@code ReloadingController} (must not be null)
+ * @param ctrl the {@code ReloadingController} (must not be null)
* @param ctrlParam the optional parameter to be passed to the controller when doing reloading checks
* @param triggerPeriod the period in which the controller is triggered
* @param unit the time unit for the period
- * @param exec the executor service to use (can be null, then a default executor service is created
+ * @param exec the executor service to use (can be null, then a default executor service is created
* @throws IllegalArgumentException if a required argument is missing
*/
public PeriodicReloadingTrigger(final ReloadingController ctrl, final Object ctrlParam, final long triggerPeriod, final TimeUnit unit,
@@ -152,7 +152,7 @@ public void shutdown() {
/**
* Shuts down this trigger and optionally shuts down the {@code ScheduledExecutorService} used by this object. This
* method should be called if this trigger is no more needed. It ensures that the trigger is stopped. If the parameter
- * is true, the executor service is also shut down. This should be done if this trigger is the only user of this
+ * is true, the executor service is also shut down. This should be done if this trigger is the only user of this
* executor service.
*
* @param shutdownExecutor a flag whether the associated {@code ScheduledExecutorService} is to be shut down
diff --git a/src/main/java/org/apache/commons/configuration2/reloading/ReloadingController.java b/src/main/java/org/apache/commons/configuration2/reloading/ReloadingController.java
index 3d5c248534..d034cd0ab5 100644
--- a/src/main/java/org/apache/commons/configuration2/reloading/ReloadingController.java
+++ b/src/main/java/org/apache/commons/configuration2/reloading/ReloadingController.java
@@ -68,7 +68,7 @@ public class ReloadingController implements EventSource {
* Creates a new instance of {@code ReloadingController} and associates it with the given {@code ReloadingDetector}
* object.
*
- * @param detect the {@code ReloadingDetector} (must not be null)
+ * @param detect the {@code ReloadingDetector} (must not be null)
* @throws IllegalArgumentException if the detector is undefined
*/
public ReloadingController(final ReloadingDetector detect) {
@@ -95,7 +95,7 @@ public void addEventListener(final EventType eventType, fin
* operation should be performed. The return value indicates whether a change was detected and an event was sent. Once a
* need for a reload is detected, this controller is in reloading state. Until this state is reset (by calling
* {@link #resetReloadingState()}), no further reloading checks are performed by this method, and no events are fired;
- * it then returns always true.
+ * it then returns always true.
*
* @param data additional data for an event notification
* @return a flag whether a reload operation is necessary
@@ -129,7 +129,7 @@ public ReloadingDetector getDetector() {
}
/**
- * Tests whether this controller is in reloading state. A return value of true means that a previous
+ * Tests whether this controller is in reloading state. A return value of true means that a previous
* invocation of {@code checkForReloading()} has detected the necessity for a reload operation, but
* {@code resetReloadingState()} has not been called yet. In this state no further reloading checks are possible.
*
diff --git a/src/main/java/org/apache/commons/configuration2/reloading/ReloadingDetector.java b/src/main/java/org/apache/commons/configuration2/reloading/ReloadingDetector.java
index 5b5753f102..93d871f3ff 100644
--- a/src/main/java/org/apache/commons/configuration2/reloading/ReloadingDetector.java
+++ b/src/main/java/org/apache/commons/configuration2/reloading/ReloadingDetector.java
@@ -43,13 +43,13 @@ public interface ReloadingDetector {
* Checks whether all criteria for a reload operation are fulfilled. This method is called by external components to
* find out when reloading should take place.
*
- * @return true if a reload operation should be performed, false otherwise
+ * @return true if a reload operation should be performed, false otherwise
*/
boolean isReloadingRequired();
/**
* Notifies this object that a reload operation has been performed. This method is called after
- * {@code reloadingRequired()} has returned true. It can be used to reset internal state in order to detect the
+ * {@code reloadingRequired()} has returned true. It can be used to reset internal state in order to detect the
* next reload operation.
*/
void reloadingPerformed();
diff --git a/src/main/java/org/apache/commons/configuration2/reloading/ReloadingEvent.java b/src/main/java/org/apache/commons/configuration2/reloading/ReloadingEvent.java
index 9eac131a9e..f345d06d1d 100644
--- a/src/main/java/org/apache/commons/configuration2/reloading/ReloadingEvent.java
+++ b/src/main/java/org/apache/commons/configuration2/reloading/ReloadingEvent.java
@@ -67,7 +67,7 @@ public ReloadingController getController() {
* {@link ReloadingController} when it was asked to do a reloading check. This is a generic mechanism to pass arbitrary
* data to reloading listeners.
*
- * @return additional data about the reload operation (can be null)
+ * @return additional data about the reload operation (can be null)
*/
public Object getData() {
return data;
diff --git a/src/main/java/org/apache/commons/configuration2/reloading/VFSFileHandlerReloadingDetector.java b/src/main/java/org/apache/commons/configuration2/reloading/VFSFileHandlerReloadingDetector.java
index 1153ff477d..2e58de5536 100644
--- a/src/main/java/org/apache/commons/configuration2/reloading/VFSFileHandlerReloadingDetector.java
+++ b/src/main/java/org/apache/commons/configuration2/reloading/VFSFileHandlerReloadingDetector.java
@@ -75,7 +75,7 @@ public VFSFileHandlerReloadingDetector(final FileHandler handler, final long ref
}
/**
- * Gets the file that is monitored by this strategy. Note that the return value can be null under some
+ * Gets the file that is monitored by this strategy. Note that the return value can be null under some
* circumstances.
*
* @return the monitored file
@@ -121,7 +121,7 @@ protected long getLastModificationDate() {
/**
* Resolves the URI of the monitored file.
*
- * @return the URI of the monitored file or null if it cannot be resolved
+ * @return the URI of the monitored file or null if it cannot be resolved
*/
protected String resolveFileURI() {
final FileSystem fs = getFileHandler().getFileSystem();
diff --git a/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java b/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
index aa81c54a1d..ea9026e5fb 100644
--- a/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
+++ b/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
@@ -467,7 +467,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
* 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 null as
+ * logging should call this method during their initialization with the logger to be used. Passing in null as
* argument disables logging.
*
* @param log the new logger
diff --git a/src/main/java/org/apache/commons/configuration2/sync/ReadWriteSynchronizer.java b/src/main/java/org/apache/commons/configuration2/sync/ReadWriteSynchronizer.java
index 595b3d21e9..538c76507a 100644
--- a/src/main/java/org/apache/commons/configuration2/sync/ReadWriteSynchronizer.java
+++ b/src/main/java/org/apache/commons/configuration2/sync/ReadWriteSynchronizer.java
@@ -59,9 +59,9 @@ public ReadWriteSynchronizer() {
/**
* Creates a new instance of {@code ReadWriteSynchronizer} and initializes it with the given lock object. This
* constructor can be used to pass a lock object which has been configured externally. If the lock object is
- * null, a default lock object is created.
+ * null, a default lock object is created.
*
- * @param l the lock object to be used (can be null)
+ * @param l the lock object to be used (can be null)
*/
public ReadWriteSynchronizer(final ReadWriteLock l) {
lock = l != null ? l : createDefaultLock();
diff --git a/src/main/java/org/apache/commons/configuration2/sync/SynchronizerSupport.java b/src/main/java/org/apache/commons/configuration2/sync/SynchronizerSupport.java
index 450847dd59..53488c195b 100644
--- a/src/main/java/org/apache/commons/configuration2/sync/SynchronizerSupport.java
+++ b/src/main/java/org/apache/commons/configuration2/sync/SynchronizerSupport.java
@@ -35,7 +35,7 @@
*/
public interface SynchronizerSupport {
/**
- * Gets the {@code Synchronizer} used by this object. An implementation must not return null. If no
+ * Gets the {@code Synchronizer} used by this object. An implementation must not return null. If no
* {@code Synchronizer} has been set so far, a meaningful default {@code Synchronizer} has to be returned.
*
* @return the {@code Synchronizer} used by this object
@@ -46,7 +46,7 @@ public interface SynchronizerSupport {
* Locks this object for the specified mode. This call may block until this object is released from other lock
* operations. When it returns the caller can access the object in a way compatible to the specified {@code LockMode}.
* When done the {@code unlock()} must be called with the same {@code LockMode} argument. In practice, a
- * try-finally construct should be used as in the following example:
+ * try-finally construct should be used as in the following example:
*
*
* SynchronizerSupport syncSupport = ...;
@@ -72,7 +72,7 @@ public interface SynchronizerSupport {
/**
* Sets the {@code Synchronizer} to be used by this object. Calling this method and setting an appropriate
* {@code Synchronizer} determines whether this object can be accessed in a thread-safe way or not. The argument may be
- * null; in this case an implementation should switch to a default {@code Synchronizer}.
+ * null; in this case an implementation should switch to a default {@code Synchronizer}.
*
* @param sync the {@code Synchronizer} for this object
*/
diff --git a/src/main/java/org/apache/commons/configuration2/tree/AbstractImmutableNodeHandler.java b/src/main/java/org/apache/commons/configuration2/tree/AbstractImmutableNodeHandler.java
index bdd7b3a8e3..a2c8b38460 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/AbstractImmutableNodeHandler.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/AbstractImmutableNodeHandler.java
@@ -35,10 +35,10 @@
*/
abstract class AbstractImmutableNodeHandler implements NodeHandler {
/**
- * Checks if the passed in node is defined. Result is true if the node contains any data.
+ * Checks if the passed in node is defined. Result is true if the node contains any data.
*
* @param node the node in question
- * @return true if the node is defined, false otherwise
+ * @return true if the node is defined, false otherwise
*/
static boolean checkIfNodeDefined(final ImmutableNode node) {
return node.getValue() != null || !node.getChildren().isEmpty() || !node.getAttributes().isEmpty();
diff --git a/src/main/java/org/apache/commons/configuration2/tree/ConfigurationNodeVisitorAdapter.java b/src/main/java/org/apache/commons/configuration2/tree/ConfigurationNodeVisitorAdapter.java
index fa4b55adc9..637d94d324 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/ConfigurationNodeVisitorAdapter.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/ConfigurationNodeVisitorAdapter.java
@@ -29,7 +29,7 @@
*/
public class ConfigurationNodeVisitorAdapter implements ConfigurationNodeVisitor {
/**
- * {@inheritDoc} This implementation returns always false; this means that all nodes in the current hierarchy are
+ * {@inheritDoc} This implementation returns always false; this means that all nodes in the current hierarchy are
* traversed.
*/
@Override
diff --git a/src/main/java/org/apache/commons/configuration2/tree/DefaultConfigurationKey.java b/src/main/java/org/apache/commons/configuration2/tree/DefaultConfigurationKey.java
index 83abad0c7b..858e0ee290 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/DefaultConfigurationKey.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/DefaultConfigurationKey.java
@@ -134,8 +134,8 @@ public String currentKey() {
/**
* Returns the current key of the iteration (without skipping to the next element). The boolean parameter indicates
- * wheter a decorated key should be returned. This affects only attribute keys: if the parameter is false, the
- * attribute markers are stripped from the key; if it is true, they remain.
+ * wheter a decorated key should be returned. This affects only attribute keys: if the parameter is false, the
+ * attribute markers are stripped from the key; if it is true, they remain.
*
* @param decorated a flag if the decorated key is to be returned
* @return the current key
@@ -263,7 +263,7 @@ private boolean isAttributeEmulatingMode() {
/**
* Returns a flag whether the current key refers to a property (i.e. is no special attribute key). Usually this method
* will return the opposite of {@code isAttribute()}, but if the delimiters for normal properties and attributes are set
- * to the same string, it is possible that both methods return true.
+ * to the same string, it is possible that both methods return true.
*
* @return a flag if the current key is a property key
* @see #isAttribute()
@@ -321,8 +321,8 @@ public String nextKey() {
/**
* Returns the next key part of this configuration key. The boolean parameter indicates wheter a decorated key should be
- * returned. This affects only attribute keys: if the parameter is false, the attribute markers are stripped from
- * the key; if it is true, they remain.
+ * returned. This affects only attribute keys: if the parameter is false, the attribute markers are stripped from
+ * the key; if it is true, they remain.
*
* @param decorated a flag if the decorated key is to be returned
* @return the next key part
@@ -396,8 +396,8 @@ private static boolean partsEqual(final KeyIterator it1, final KeyIterator it2)
/**
* Creates a new instance of {@code DefaultConfigurationKey} and sets the associated expression engine.
*
- * @param engine the expression engine (must not be null)
- * @throws IllegalArgumentException if the expression engine is null
+ * @param engine the expression engine (must not be null)
+ * @throws IllegalArgumentException if the expression engine is null
*/
public DefaultConfigurationKey(final DefaultExpressionEngine engine) {
this(engine, null);
@@ -407,9 +407,9 @@ public DefaultConfigurationKey(final DefaultExpressionEngine engine) {
* Creates a new instance of {@code DefaultConfigurationKey} and sets the associated expression engine and an initial
* key.
*
- * @param engine the expression engine (must not be null)
+ * @param engine the expression engine (must not be null)
* @param key the key to be wrapped
- * @throws IllegalArgumentException if the expression engine is null
+ * @throws IllegalArgumentException if the expression engine is null
*/
public DefaultConfigurationKey(final DefaultExpressionEngine engine, final String key) {
if (engine == null) {
@@ -436,7 +436,7 @@ public DefaultConfigurationKey append(final String property) {
/**
* Appends the name of a property to this key. If necessary, a property delimiter will be added. If the boolean argument
- * is set to true, property delimiters contained in the property name will be escaped.
+ * is set to true, property delimiters contained in the property name will be escaped.
*
* @param property the name of the property to be added
* @param escape a flag if property delimiters in the passed in property name should be escaped
@@ -660,7 +660,7 @@ private boolean hasTrailingDelimiter(final String key) {
* Tests if the specified key represents an attribute according to the current expression engine.
*
* @param key the key to be checked
- * @return true if this is an attribute key, false otherwise
+ * @return true if this is an attribute key, false otherwise
*/
public boolean isAttributeKey(final String key) {
if (key == null) {
diff --git a/src/main/java/org/apache/commons/configuration2/tree/DefaultExpressionEngine.java b/src/main/java/org/apache/commons/configuration2/tree/DefaultExpressionEngine.java
index d6c236af35..d93295eae6 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/DefaultExpressionEngine.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/DefaultExpressionEngine.java
@@ -114,8 +114,8 @@ public class DefaultExpressionEngine implements ExpressionEngine {
/**
* Creates a new instance of {@code DefaultExpressionEngine} and initializes its symbols.
*
- * @param syms the object with the symbols (must not be null)
- * @throws IllegalArgumentException if the symbols are null
+ * @param syms the object with the symbols (must not be null)
+ * @throws IllegalArgumentException if the symbols are null
*/
public DefaultExpressionEngine(final DefaultExpressionEngineSymbols syms) {
this(syms, null);
@@ -126,9 +126,9 @@ public DefaultExpressionEngine(final DefaultExpressionEngineSymbols syms) {
* node names. The passed in matcher is always used when the names of nodes have to be matched against parts of
* configuration keys.
*
- * @param syms the object with the symbols (must not be null)
- * @param nodeNameMatcher the matcher for node names; can be null, then a default matcher is used
- * @throws IllegalArgumentException if the symbols are null
+ * @param syms the object with the symbols (must not be null)
+ * @param nodeNameMatcher the matcher for node names; can be null, then a default matcher is used
+ * @throws IllegalArgumentException if the symbols are null
*/
public DefaultExpressionEngine(final DefaultExpressionEngineSymbols syms, final NodeMatcher nodeNameMatcher) {
if (syms == null) {
@@ -149,7 +149,7 @@ public String attributeKey(final String parentKey, final String attributeName) {
/**
* {@inheritDoc} This implementation works similar to {@code nodeKey()}; however, each key returned by this method has
* an index (except for the root node). The parent key is prepended to the name of the current node in any case and
- * without further checks. If it is null, only the name of the current node with its index is returned.
+ * without further checks. If it is null, only the name of the current node with its index is returned.
*/
@Override
public String canonicalKey(final T node, final String parentKey, final NodeHandler handler) {
diff --git a/src/main/java/org/apache/commons/configuration2/tree/ExpressionEngine.java b/src/main/java/org/apache/commons/configuration2/tree/ExpressionEngine.java
index fc4087fe63..b0d16a9634 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/ExpressionEngine.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/ExpressionEngine.java
@@ -61,7 +61,7 @@ public interface ExpressionEngine {
*
* @param the type of the node to be processed
* @param node the node, for which the key must be constructed
- * @param parentKey the key of this node's parent (can be null for the root node)
+ * @param parentKey the key of this node's parent (can be null for the root node)
* @param handler the {@code NodeHandler} for accessing the node
* @return the canonical key of this node
*/
@@ -74,7 +74,7 @@ public interface ExpressionEngine {
*
* @param the type of the node to be processed
* @param node the node, for which the key must be constructed
- * @param parentKey the key of this node's parent (can be null for the root node)
+ * @param parentKey the key of this node's parent (can be null for the root node)
* @param handler the {@code NodeHandler} for accessing the node
* @return this node's key
*/
@@ -104,7 +104,7 @@ public interface ExpressionEngine {
* @param root the root node of a hierarchy of nodes
* @param key the key to be evaluated
* @param handler the {@code NodeHandler} for accessing the node
- * @return a list with the results that are matched by the key (should never be null)
+ * @return a list with the results that are matched by the key (should never be null)
*/
List> query(T root, String key, NodeHandler handler);
}
diff --git a/src/main/java/org/apache/commons/configuration2/tree/ImmutableNode.java b/src/main/java/org/apache/commons/configuration2/tree/ImmutableNode.java
index aa41959fa8..c8b9ac82a3 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/ImmutableNode.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/ImmutableNode.java
@@ -160,7 +160,7 @@ public Builder addAttribute(final String name, final Object value) {
* Adds all attributes of the given map to this builder. This method works like {@link #addAttribute(String, Object)},
* but it allows setting multiple attributes at once.
*
- * @param attrs the map with attributes to be added (may be null
+ * @param attrs the map with attributes to be added (may be null
* @return a reference to this object for method chaining
*/
public Builder addAttributes(final Map attrs) {
@@ -173,9 +173,9 @@ public Builder addAttributes(final Map attrs) {
/**
* Adds a child node to this builder. The passed in node becomes a child of the newly created node. If it is
- * null, it is ignored.
+ * null, it is ignored.
*
- * @param c the child node (must not be null)
+ * @param c the child node (must not be null)
* @return a reference to this object for method chaining
*/
public Builder addChild(final ImmutableNode c) {
@@ -303,7 +303,7 @@ public Builder value(final Object v) {
* child nodes are always defined.
*
* @param child the child node to be checked
- * @throws IllegalArgumentException if the child node is null
+ * @throws IllegalArgumentException if the child node is null
*/
private static void checkChildNode(final ImmutableNode child) {
if (child == null) {
@@ -338,9 +338,9 @@ private ImmutableNode(final Builder b) {
/**
* Creates a new {@code ImmutableNode} instance which is a copy of this object, but has the given child node added.
*
- * @param child the child node to be added (must not be null)
+ * @param child the child node to be added (must not be null)
* @return the new node with the child node added
- * @throws IllegalArgumentException if the child node is null
+ * @throws IllegalArgumentException if the child node is null
*/
public ImmutableNode addChild(final ImmutableNode child) {
checkChildNode(child);
@@ -472,9 +472,9 @@ public ImmutableNode removeChild(final ImmutableNode child) {
* new one. If the child to be replaced cannot be found, the same node instance is returned.
*
* @param oldChild the child node to be replaced
- * @param newChild the replacing child node (must not be null)
+ * @param newChild the replacing child node (must not be null)
* @return the new node with the child replaced
- * @throws IllegalArgumentException if the new child node is null
+ * @throws IllegalArgumentException if the new child node is null
*/
public ImmutableNode replaceChild(final ImmutableNode oldChild, final ImmutableNode newChild) {
checkChildNode(newChild);
@@ -497,7 +497,7 @@ public ImmutableNode replaceChild(final ImmutableNode oldChild, final ImmutableN
* ones in the passed in collection. With this method all children can be replaced in a single step. For the collection
* the same rules apply as for {@link Builder#addChildren(Collection)}.
*
- * @param newChildren the collection with the new children (may be null)
+ * @param newChildren the collection with the new children (may be null)
* @return the new node with replaced children
*/
public ImmutableNode replaceChildren(final Collection newChildren) {
@@ -524,7 +524,7 @@ public ImmutableNode setAttribute(final String name, final Object value) {
/**
* Returns a new {@code ImmutableNode} instance which is a copy of this object, but with all attributes added defined by
* the given map. This method is analogous to {@link #setAttribute(String, Object)}, but all attributes in the given map
- * are added. If the map is null or empty, this method has no effect.
+ * are added. If the map is null or empty, this method has no effect.
*
* @param newAttributes the map with attributes to be added
* @return the new node with these attributes
diff --git a/src/main/java/org/apache/commons/configuration2/tree/InMemoryNodeModel.java b/src/main/java/org/apache/commons/configuration2/tree/InMemoryNodeModel.java
index 373ad9451e..51b392d0ae 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/InMemoryNodeModel.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/InMemoryNodeModel.java
@@ -54,7 +54,7 @@ public class InMemoryNodeModel implements NodeModel {
private interface TransactionInitializer {
/**
* Initializes the specified transaction for an update operation. The return value indicates whether the transaction
- * should be executed. A result of false means that the update is to be aborted (maybe another update method was
+ * should be executed. A result of false means that the update is to be aborted (maybe another update method was
* called).
*
* @param tx the transaction to be initialized
@@ -131,10 +131,10 @@ private static IllegalArgumentException attributeKeyException(final String key)
}
/**
- * Checks if the passed in node is defined. Result is true if the node contains any data.
+ * Checks if the passed in node is defined. Result is true if the node contains any data.
*
* @param node the node in question
- * @return true if the node is defined, false otherwise
+ * @return true if the node is defined, false otherwise
*/
static boolean checkIfNodeDefined(final ImmutableNode node) {
return node.getValue() != null || !node.getChildren().isEmpty() || !node.getAttributes().isEmpty();
@@ -233,7 +233,7 @@ private static TreeData createSelectorsForTrackedNodes(final Mutablenull means that no node
+ * current root node has no name, the name of the node to be merged is used. A result of null means that no node
* name has to be set.
*
* @param rootNode the current root node
@@ -339,7 +339,7 @@ public void visitBeforeChildren(final ImmutableNode node, final NodeHandlertrue if values are provided, false otherwise
+ * @return true if values are provided, false otherwise
*/
private static boolean valuesNotEmpty(final Iterable values) {
return values.iterator().hasNext();
@@ -357,7 +357,7 @@ public InMemoryNodeModel() {
/**
* Creates a new instance of {@code InMemoryNodeModel} and initializes it from the given root node. If the passed in
- * node is null, a new, empty root node is created.
+ * node is null, a new, empty root node is created.
*
* @param root the new root node for this model
*/
@@ -373,10 +373,10 @@ public void addNodes(final String key, final Collection
/**
* Adds new nodes using a tracked node as root node. This method works like the normal {@code addNodes()} method, but
* the origin of the operation (also for the interpretation of the passed in key) is a tracked node identified by the
- * passed in {@code NodeSelector}. The selector can be null, then the root node is assumed.
+ * passed in {@code NodeSelector}. The selector can be null, then the root node is assumed.
*
* @param key the key
- * @param selector the {@code NodeSelector} defining the root node (or null)
+ * @param selector the {@code NodeSelector} defining the root node (or null)
* @param nodes the collection of new nodes to be added
* @param resolver the {@code NodeKeyResolver}
* @throws ConfigurationRuntimeException if the selector cannot be resolved
@@ -412,10 +412,10 @@ public void addProperty(final String key, final Iterable values, final NodeKe
/**
* Adds new property values using a tracked node as root node. This method works like the normal {@code addProperty()}
* method, but the origin of the operation (also for the interpretation of the passed in key) is a tracked node
- * identified by the passed in {@code NodeSelector}. The selector can be null, then the root node is assumed.
+ * identified by the passed in {@code NodeSelector}. The selector can be null, then the root node is assumed.
*
* @param key the key
- * @param selector the {@code NodeSelector} defining the root node (or null)
+ * @param selector the {@code NodeSelector} defining the root node (or null)
* @param values the values to be added
* @param resolver the {@code NodeKeyResolver}
* @throws ConfigurationRuntimeException if the selector cannot be resolved
@@ -452,10 +452,10 @@ public void clearProperty(final String key, final NodeKeyResolver
/**
* Clears a property using a tracked node as root node. This method works like the normal {@code clearProperty()}
* method, but the origin of the operation (also for the interpretation of the passed in key) is a tracked node
- * identified by the passed in {@code NodeSelector}. The selector can be null, then the root node is assumed.
+ * identified by the passed in {@code NodeSelector}. The selector can be null, then the root node is assumed.
*
* @param key the key
- * @param selector the {@code NodeSelector} defining the root node (or null)
+ * @param selector the {@code NodeSelector} defining the root node (or null)
* @param resolver the {@code NodeKeyResolver}
* @throws ConfigurationRuntimeException if the selector cannot be resolved
*/
@@ -479,10 +479,10 @@ public List> clearTree(final String key, final NodeKe
/**
* Clears a whole sub tree using a tracked node as root node. This method works like the normal {@code clearTree()}
* method, but the origin of the operation (also for the interpretation of the passed in key) is a tracked node
- * identified by the passed in {@code NodeSelector}. The selector can be null, then the root node is assumed.
+ * identified by the passed in {@code NodeSelector}. The selector can be null, then the root node is assumed.
*
* @param key the key
- * @param selector the {@code NodeSelector} defining the root node (or null)
+ * @param selector the {@code NodeSelector} defining the root node (or null)
* @param resolver the {@code NodeKeyResolver}
* @return a list with the results to be removed
* @throws ConfigurationRuntimeException if the selector cannot be resolved
@@ -532,7 +532,7 @@ private Map createParentMapping(final ImmutableNod
* Creates a {@code TreeData} object for the specified root node.
*
* @param root the root node of the current tree
- * @param current the current {@code TreeData} object (may be null)
+ * @param current the current {@code TreeData} object (may be null)
* @return the {@code TreeData} describing the current tree
*/
private TreeData createTreeData(final ImmutableNode root, final TreeData current) {
@@ -718,8 +718,8 @@ public boolean isTrackedNodeDetached(final NodeSelector selector) {
* define the new name of the root node and to pass in a map with reference objects.
*
* @param node the node to be merged with the root node
- * @param rootName the new name of the root node; can be null, then the name of the root node is not changed
- * unless it is null
+ * @param rootName the new name of the root node; can be null, then the name of the root node is not changed
+ * unless it is null
* @param references an optional map with reference objects
* @param rootRef an optional reference object for the new root node
* @param resolver the {@code NodeKeyResolver}
@@ -785,9 +785,9 @@ private boolean replaceDetachedTrackedNode(final TreeData currentData, final Nod
* operation is useful if the new nodes hierarchy to be set is known to be similar to the old one. Note that reference
* objects are lost; there is no way to automatically match nodes between the old and the new nodes hierarchy.
*
- * @param newRoot the new root node to be set (must not be null)
+ * @param newRoot the new root node to be set (must not be null)
* @param resolver the {@code NodeKeyResolver}
- * @throws IllegalArgumentException if the new root node is null
+ * @throws IllegalArgumentException if the new root node is null
*/
public void replaceRoot(final ImmutableNode newRoot, final NodeKeyResolver resolver) {
if (newRoot == null) {
@@ -802,13 +802,13 @@ public void replaceRoot(final ImmutableNode newRoot, final NodeKeyResolvernull) becomes the new root node of an independent model for this tracked node.
+ * in node (which must not be null) becomes the new root node of an independent model for this tracked node.
* Further updates of this model do not affect the tracked node's model and vice versa.
*
* @param selector the {@code NodeSelector} defining the tracked node
- * @param newNode the node replacing the tracked node (must not be null)
+ * @param newNode the node replacing the tracked node (must not be null)
* @throws ConfigurationRuntimeException if the selector cannot be resolved
- * @throws IllegalArgumentException if the replacement node is null
+ * @throws IllegalArgumentException if the replacement node is null
*/
public void replaceTrackedNode(final NodeSelector selector, final ImmutableNode newNode) {
if (newNode == null) {
@@ -848,11 +848,11 @@ public Collection selectAndTrackNodes(final String key, final Node
/**
* Sets the value of a property using a tracked node as root node. This method works like the normal
* {@code setProperty()} method, but the origin of the operation (also for the interpretation of the passed in key) is a
- * tracked node identified by the passed in {@code NodeSelector}. The selector can be null, then the root node is
+ * tracked node identified by the passed in {@code NodeSelector}. The selector can be null, then the root node is
* assumed.
*
* @param key the key
- * @param selector the {@code NodeSelector} defining the root node (or null)
+ * @param selector the {@code NodeSelector} defining the root node (or null)
* @param value the new value for this property
* @param resolver the {@code NodeKeyResolver}
* @throws ConfigurationRuntimeException if the selector cannot be resolved
@@ -881,7 +881,7 @@ public void setProperty(final String key, final Object value, final NodeKeyResol
* this method is used and the model is accessed by multiple threads. It is not deterministic which concurrent
* operations see the old root and which see the new root node.
*
- * @param newRoot the new root node to be set (can be null, then an empty root node is set)
+ * @param newRoot the new root node to be set (can be null, then an empty root node is set)
*/
@Override
public void setRootNode(final ImmutableNode newRoot) {
diff --git a/src/main/java/org/apache/commons/configuration2/tree/NodeAddData.java b/src/main/java/org/apache/commons/configuration2/tree/NodeAddData.java
index a52843e92a..7fa838c1b9 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/NodeAddData.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/NodeAddData.java
@@ -113,7 +113,7 @@ public T getParent() {
* Then {@code username} is the name of the new node, but the nodes {@code connection} and {@code settings} must be
* added to the parent node first. In this example these names would be returned by this method.
*
- * @return a list with the names of nodes that must be added as parents of the new node (never null)
+ * @return a list with the names of nodes that must be added as parents of the new node (never null)
*/
public List getPathNodes() {
return pathNodes;
@@ -122,7 +122,7 @@ public List getPathNodes() {
/**
* Returns a flag if the new node to be added is an attribute.
*
- * @return true for an attribute node, false for a child node
+ * @return true for an attribute node, false for a child node
*/
public boolean isAttribute() {
return attribute;
diff --git a/src/main/java/org/apache/commons/configuration2/tree/NodeHandler.java b/src/main/java/org/apache/commons/configuration2/tree/NodeHandler.java
index 7398d0c5ba..18ec5a2a13 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/NodeHandler.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/NodeHandler.java
@@ -81,10 +81,10 @@ public interface NodeHandler {
* for some node implementations it may be by far more efficient to count the children than to query a list of all
* children and determine its size. A concrete implementation can choose the most efficient way to determine the number
* of children. If a child name is passed in, only the children with this name are taken into account. If the name
- * null is passed, the total number of children must be returned.
+ * null is passed, the total number of children must be returned.
*
* @param node the node
- * @param name the name of the children in question (can be null for all children)
+ * @param name the name of the children in question (can be null for all children)
* @return the number of the selected children
*/
int getChildrenCount(T node, String name);
diff --git a/src/main/java/org/apache/commons/configuration2/tree/NodeMatcher.java b/src/main/java/org/apache/commons/configuration2/tree/NodeMatcher.java
index 22283a2e62..d94c3e9f9b 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/NodeMatcher.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/NodeMatcher.java
@@ -44,7 +44,7 @@ public interface NodeMatcher {
* @param handler the corresponding {@code NodeHandler}
* @param criterion the criterion to match against
* @param the type of the node
- * @return true if this node matches the criterion, false otherwise
+ * @return true if this node matches the criterion, false otherwise
*/
boolean matches(T node, NodeHandler handler, C criterion);
}
diff --git a/src/main/java/org/apache/commons/configuration2/tree/NodeModel.java b/src/main/java/org/apache/commons/configuration2/tree/NodeModel.java
index 6dce72235f..29de96ad87 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/NodeModel.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/NodeModel.java
@@ -46,7 +46,7 @@ public interface NodeModel {
* given key.
*
* @param key the key
- * @param nodes the collection of nodes to be added (may be null)
+ * @param nodes the collection of nodes to be added (may be null)
* @param resolver the {@code NodeKeyResolver}
* @throws IllegalArgumentException if the key references an attribute (of course, it is not possible to add something
* to an attribute)
@@ -73,7 +73,7 @@ public interface NodeModel {
/**
* Clears the value of a property. This method is similar to {@link #clearTree(String, NodeKeyResolver)}: However, the
- * nodes referenced by the passed in key are not removed completely, but only their value is set to null.
+ * nodes referenced by the passed in key are not removed completely, but only their value is set to null.
*
* @param key the key selecting the properties to be cleared
* @param resolver the {@code NodeKeyResolver}
@@ -124,7 +124,7 @@ public interface NodeModel {
/**
* Sets a new root node for this model. The whole structure is replaced by the new node and its children.
*
- * @param newRoot the new root node to be set (can be null, then an empty root node is set)
+ * @param newRoot the new root node to be set (can be null, then an empty root node is set)
*/
void setRootNode(T newRoot);
}
diff --git a/src/main/java/org/apache/commons/configuration2/tree/NodeNameMatchers.java b/src/main/java/org/apache/commons/configuration2/tree/NodeNameMatchers.java
index 28a70e9330..bffe8e8fd2 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/NodeNameMatchers.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/NodeNameMatchers.java
@@ -32,7 +32,7 @@
*/
public enum NodeNameMatchers implements NodeMatcher {
/**
- * A matcher for exact node name matches. This matcher returns true if and only if the name of the passed in node
+ * A matcher for exact node name matches. This matcher returns true if and only if the name of the passed in node
* equals exactly the given criterion string.
*/
EQUALS {
diff --git a/src/main/java/org/apache/commons/configuration2/tree/NodeSelector.java b/src/main/java/org/apache/commons/configuration2/tree/NodeSelector.java
index 21b95153b7..2283148f9b 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/NodeSelector.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/NodeSelector.java
@@ -33,7 +33,7 @@
* e.g. if a sub key is to be constructed from another sub key. {@code NodeSelector} provides the {@code select()}
* method which evaluates the wrapped keys on a specified root node and returns the resulting unique target node. The
* class expects that the key(s) stored in an instance select exactly one target node. If this is not the case, result
- * is null indicating that the selection criteria are not sufficient.
+ * is null indicating that the selection criteria are not sufficient.
*
*
* Implementation node: Instances of this class are immutable. They can be shared between arbitrary components.
@@ -116,12 +116,12 @@ public int hashCode() {
/**
* Applies this {@code NodeSelector} on the specified root node. This method applies the selection criteria stored in
* this object and tries to determine a single target node. If this is successful, the target node is returned.
- * Otherwise, result is null.
+ * Otherwise, result is null.
*
* @param root the root node on which to apply this selector
* @param resolver the {@code NodeKeyResolver}
* @param handler the {@code NodeHandler}
- * @return the selected target node or null
+ * @return the selected target node or null
*/
public ImmutableNode select(final ImmutableNode root, final NodeKeyResolver resolver, final NodeHandler handler) {
List nodes = new LinkedList<>();
diff --git a/src/main/java/org/apache/commons/configuration2/tree/NodeTracker.java b/src/main/java/org/apache/commons/configuration2/tree/NodeTracker.java
index 72f2eded0c..db52ffd1e2 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/NodeTracker.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/NodeTracker.java
@@ -92,9 +92,9 @@ private TrackedNodeData(final ImmutableNode nd, final int obsCount, final InMemo
/**
* Returns an instance with the detached flag set to true. This method is called if the selector of a tracked node does
* not match a single node any more. It is possible to pass in a new node instance which becomes the current tracked
- * node. If this is null, the previous node instance is used.
+ * node. If this is null, the previous node instance is used.
*
- * @param newNode the new tracked node instance (may be null)
+ * @param newNode the new tracked node instance (may be null)
* @return the updated instance
*/
public TrackedNodeData detach(final ImmutableNode newNode) {
@@ -103,7 +103,7 @@ public TrackedNodeData detach(final ImmutableNode newNode) {
}
/**
- * Gets the node model to be used in detached mode. This is null if the represented tracked node is not
+ * Gets the node model to be used in detached mode. This is null if the represented tracked node is not
* detached.
*
* @return the node model in detached mode
@@ -141,10 +141,10 @@ public TrackedNodeData observerAdded() {
/**
* An observer for this tracked node was removed. This method returns a new instance with an adjusted observer count. If
- * there are no more observers, result is null. This means that this node is no longer tracked and can be
+ * there are no more observers, result is null. This means that this node is no longer tracked and can be
* released.
*
- * @return the updated instance or null
+ * @return the updated instance or null
*/
public TrackedNodeData observerRemoved() {
return observerCount <= 1 ? null : new TrackedNodeData(node, observerCount - 1, getDetachedModel());
@@ -178,7 +178,7 @@ private static ImmutableNode createEmptyTrackedNode(final TrackedNodeData data)
* transaction. This method checks whether the affected node is the root node of the current transaction. If so, it is
* cleared.
*
- * @param txTarget the {@code NodeSelector} referencing the target node of the current transaction (may be null)
+ * @param txTarget the {@code NodeSelector} referencing the target node of the current transaction (may be null)
* @param e the current selector and {@code TrackedNodeData}
* @return the new {@code TrackedNodeData} object to be used for this tracked node
*/
@@ -192,7 +192,7 @@ private static TrackedNodeData detachedTrackedNodeData(final NodeSelector txTarg
* applied to the current root node. It may become detached if there is no match.
*
* @param root the root node
- * @param txTarget the {@code NodeSelector} referencing the target node of the current transaction (may be null)
+ * @param txTarget the {@code NodeSelector} referencing the target node of the current transaction (may be null)
* @param resolver the {@code NodeKeyResolver}
* @param handler the {@code NodeHandler}
* @param e the current selector and {@code TrackedNodeData}
@@ -281,10 +281,10 @@ public NodeTracker detachAllTrackedNodes() {
/**
* Gets the detached node model for the specified tracked node. When a node becomes detached, operations on it are
* independent from the original model. To implement this, a separate node model is created wrapping this tracked node.
- * This model can be queried by this method. If the node affected is not detached, result is null.
+ * This model can be queried by this method. If the node affected is not detached, result is null.
*
* @param selector the {@code NodeSelector}
- * @return the detached node model for this node or null
+ * @return the detached node model for this node or null
* @throws ConfigurationRuntimeException if no data for this selector is available
*/
public InMemoryNodeModel getDetachedNodeModel(final NodeSelector selector) {
@@ -412,13 +412,13 @@ public NodeTracker untrackNode(final NodeSelector selector) {
* Updates tracking information after the node structure has been changed. This method iterates over all tracked nodes.
* The selectors are evaluated again to update the node reference. If this fails for a selector, the previous node is
* reused; this tracked node is then detached. The passed in {@code NodeSelector} is the selector of the tracked node
- * which is the target of the current transaction. (It is null if the transaction is not executed on a tracked
+ * which is the target of the current transaction. (It is null if the transaction is not executed on a tracked
* node.) This is used to handle a special case: if the tracked node becomes detached by an operation targeting itself,
* this means that the node has been cleared by this operation. In this case, the previous node instance is not used,
* but an empty node is created.
*
* @param root the root node
- * @param txTarget the {@code NodeSelector} referencing the target node of the current transaction (may be null)
+ * @param txTarget the {@code NodeSelector} referencing the target node of the current transaction (may be null)
* @param resolver the {@code NodeKeyResolver}
* @param handler the {@code NodeHandler}
* @return the updated instance
diff --git a/src/main/java/org/apache/commons/configuration2/tree/NodeTreeWalker.java b/src/main/java/org/apache/commons/configuration2/tree/NodeTreeWalker.java
index ec304abac5..e518ada82a 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/NodeTreeWalker.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/NodeTreeWalker.java
@@ -72,7 +72,7 @@ private static void bfs(final T root, final ConfigurationNodeVisitor visi
* @param visitor the visitor
* @param handler the handler
* @param the type of the nodes involved
- * @return true if a walk operation can be performed, false otherwise
+ * @return true if a walk operation can be performed, false otherwise
* @throws IllegalArgumentException if a required parameter is missing
*/
private static boolean checkParameters(final T root, final ConfigurationNodeVisitor visitor, final NodeHandler handler) {
@@ -110,11 +110,11 @@ private static void dfs(final T node, final ConfigurationNodeVisitor visi
* etc. In this mode of traversal, there is no direct connection between the encounter of a node and its children.
* Therefore, on the visitor object only the {@code visitBeforeChildren()} method gets called!.
*
- * @param root the root node of the hierarchy to be processed (may be null, then this call has no effect)
- * @param visitor the {@code ConfigurationNodeVisitor} (must not be null)
- * @param handler the {@code NodeHandler} (must not be null)
+ * @param root the root node of the hierarchy to be processed (may be null, then this call has no effect)
+ * @param visitor the {@code ConfigurationNodeVisitor} (must not be null)
+ * @param handler the {@code NodeHandler} (must not be null)
* @param the type of the nodes involved
- * @throws IllegalArgumentException if a required parameter is null
+ * @throws IllegalArgumentException if a required parameter is null
*/
public void walkBFS(final T root, final ConfigurationNodeVisitor visitor, final NodeHandler handler) {
if (checkParameters(root, visitor, handler)) {
@@ -128,11 +128,11 @@ public void walkBFS(final T root, final ConfigurationNodeVisitor visitor,
* recursively all of its children are processed, and eventually
* {@link ConfigurationNodeVisitor#visitAfterChildren(Object, NodeHandler)} gets invoked.
*
- * @param root the root node of the hierarchy to be processed (may be null, then this call has no effect)
- * @param visitor the {@code ConfigurationNodeVisitor} (must not be null)
- * @param handler the {@code NodeHandler} (must not be null)
+ * @param root the root node of the hierarchy to be processed (may be null, then this call has no effect)
+ * @param visitor the {@code ConfigurationNodeVisitor} (must not be null)
+ * @param handler the {@code NodeHandler} (must not be null)
* @param the type of the nodes involved
- * @throws IllegalArgumentException if a required parameter is null
+ * @throws IllegalArgumentException if a required parameter is null
*/
public void walkDFS(final T root, final ConfigurationNodeVisitor visitor, final NodeHandler handler) {
if (checkParameters(root, visitor, handler)) {
diff --git a/src/main/java/org/apache/commons/configuration2/tree/NodeUpdateData.java b/src/main/java/org/apache/commons/configuration2/tree/NodeUpdateData.java
index 304b0e1e10..90ca0fdba9 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/NodeUpdateData.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/NodeUpdateData.java
@@ -83,7 +83,7 @@ private static Map copyMap(final Map map)
/**
* Creates a new instance of {@code NodeUpdateData} and initializes all its properties. All passed in collections are
- * optional and can be null.
+ * optional and can be null.
*
* @param changedValues the map defining the changed values
* @param newValues the collection with the new values
diff --git a/src/main/java/org/apache/commons/configuration2/tree/OverrideCombiner.java b/src/main/java/org/apache/commons/configuration2/tree/OverrideCombiner.java
index 5a45f19383..34120519bc 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/OverrideCombiner.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/OverrideCombiner.java
@@ -59,7 +59,7 @@ protected void addAttributes(final ImmutableNode.Builder result, final Immutable
/**
* Tests if a child node of the second node can be combined with the given child node of the first node. If this is the
- * case, the corresponding node will be returned, otherwise null. This implementation checks whether the child
+ * case, the corresponding node will be returned, otherwise null. This implementation checks whether the child
* node occurs only once in both hierarchies and is no known list node.
*
* @param node1 the first node
diff --git a/src/main/java/org/apache/commons/configuration2/tree/QueryResult.java b/src/main/java/org/apache/commons/configuration2/tree/QueryResult.java
index ac3c45d8dc..641f8111a9 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/QueryResult.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/QueryResult.java
@@ -139,10 +139,10 @@ public int hashCode() {
}
/**
- * Returns a flag whether this is a result of type attribute. If result is true, the attribute name and value can
+ * Returns a flag whether this is a result of type attribute. If result is true, the attribute name and value can
* be queried. Otherwise, only the result node is available.
*
- * @return true for an attribute result, false otherwise
+ * @return true for an attribute result, false otherwise
*/
public boolean isAttributeResult() {
return StringUtils.isNotEmpty(getAttributeName());
diff --git a/src/main/java/org/apache/commons/configuration2/tree/ReferenceNodeHandler.java b/src/main/java/org/apache/commons/configuration2/tree/ReferenceNodeHandler.java
index a4621eaa18..2f1d89a696 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/ReferenceNodeHandler.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/ReferenceNodeHandler.java
@@ -38,10 +38,10 @@
public interface ReferenceNodeHandler extends NodeHandler {
/**
* Gets the reference object associated with the specified node. If no reference data is associated with this node,
- * result is null.
+ * result is null.
*
* @param node the node in question
- * @return the reference object for this node or null
+ * @return the reference object for this node or null
*/
Object getReference(ImmutableNode node);
diff --git a/src/main/java/org/apache/commons/configuration2/tree/ReferenceTracker.java b/src/main/java/org/apache/commons/configuration2/tree/ReferenceTracker.java
index d118812699..eb913058c8 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/ReferenceTracker.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/ReferenceTracker.java
@@ -88,7 +88,7 @@ public ReferenceTracker addReferences(final Map refs) {
* Gets the reference object associated with the given node.
*
* @param node the node
- * @return the reference object for this node or null
+ * @return the reference object for this node or null
*/
public Object getReference(final ImmutableNode node) {
return references.get(node);
diff --git a/src/main/java/org/apache/commons/configuration2/tree/TrackedNodeModel.java b/src/main/java/org/apache/commons/configuration2/tree/TrackedNodeModel.java
index e249e5357e..2367dce786 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/TrackedNodeModel.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/TrackedNodeModel.java
@@ -74,8 +74,8 @@ public class TrackedNodeModel implements NodeModel {
* {@code SubnodeConfiguration}, there is typically no way to discard the model explicitly. Therefore, it makes sense to
* do this automatically on finalization.
*
- * @param modelSupport the underlying {@code InMemoryNodeModelSupport} (must not be null)
- * @param sel the selector to the root node of this model (must not be null)
+ * @param modelSupport the underlying {@code InMemoryNodeModelSupport} (must not be null)
+ * @param sel the selector to the root node of this model (must not be null)
* @param untrackOnFinalize a flag whether the tracked node should be released on finalization
* @throws IllegalArgumentException if a required parameter is missing
*/
diff --git a/src/main/java/org/apache/commons/configuration2/tree/TreeData.java b/src/main/java/org/apache/commons/configuration2/tree/TreeData.java
index dfb2ce4cd6..8f8990d93b 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/TreeData.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/TreeData.java
@@ -130,7 +130,7 @@ public NodeTracker getNodeTracker() {
}
/**
- * Gets the parent node of the specified node. Result is null for the root node. If the passed in node cannot
+ * Gets the parent node of the specified node. Result is null for the root node. If the passed in node cannot
* be resolved, an exception is thrown.
*
* @param node the node in question
diff --git a/src/main/java/org/apache/commons/configuration2/tree/UnionCombiner.java b/src/main/java/org/apache/commons/configuration2/tree/UnionCombiner.java
index e427aac5f4..520a1f38ab 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/UnionCombiner.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/UnionCombiner.java
@@ -156,13 +156,13 @@ public ImmutableNode combine(final ImmutableNode node1, final ImmutableNode node
*
*
* If all of these tests are successful, the matching child node of the second source node is returned. Otherwise the
- * result is null.
+ * result is null.
*
*
* @param node1 the first source node
* @param node2 the second source node
* @param child the child node of the first source node to be checked
- * @return the matching child node of the second source node or null if there is none
+ * @return the matching child node of the second source node or null if there is none
*/
protected ImmutableNode findCombineNode(final ImmutableNode node1, final ImmutableNode node2, final ImmutableNode child) {
if (child.getValue() == null && !isListNode(child) && HANDLER.getChildrenCount(node1, child.getNodeName()) == 1
diff --git a/src/main/java/org/apache/commons/configuration2/tree/xpath/AbstractConfigurationNodeIterator.java b/src/main/java/org/apache/commons/configuration2/tree/xpath/AbstractConfigurationNodeIterator.java
index 6b205f7924..d907e595a4 100644
--- a/src/main/java/org/apache/commons/configuration2/tree/xpath/AbstractConfigurationNodeIterator.java
+++ b/src/main/java/org/apache/commons/configuration2/tree/xpath/AbstractConfigurationNodeIterator.java
@@ -45,7 +45,7 @@ abstract class AbstractConfigurationNodeIterator implements NodeIterator {
* Generates a qualified name with a namespace prefix.
*
* @param prefix the prefix
- * @param name the name (may be null)
+ * @param name the name (may be null)
* @return the qualified name
*/
protected static String prefixName(final String prefix, final String name) {
diff --git a/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java b/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
index 9ac3c285c0..11d863cc72 100644
--- a/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
+++ b/src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java
@@ -220,7 +220,7 @@ public DatabaseConfiguration setUpMultiConfig() throws ConfigurationException {
*
* @param the type of the result configuration
* @param configCls the configuration class
- * @param configName the name of the configuration instance or null for the default name
+ * @param configName the name of the configuration instance or null for the default name
* @return the newly created configuration instance
* @throws ConfigurationException if an error occurs
*/
@@ -231,7 +231,7 @@ public T setUpMultiConfig(final Class confi
/**
* Returns a parameters object with settings for a configuration table containing the data of multiple configurations.
*
- * @param configName the name of the configuration instance or null for the default name
+ * @param configName the name of the configuration instance or null for the default name
* @return the parameters object
*/
public DatabaseBuilderParameters setUpMultiParameters(final String configName) {
diff --git a/src/test/java/org/apache/commons/configuration2/TestConfigurationUtils.java b/src/test/java/org/apache/commons/configuration2/TestConfigurationUtils.java
index 6147ebb246..eb64307677 100644
--- a/src/test/java/org/apache/commons/configuration2/TestConfigurationUtils.java
+++ b/src/test/java/org/apache/commons/configuration2/TestConfigurationUtils.java
@@ -183,7 +183,7 @@ public void testCloneConfigurationNotSupported() {
}
/**
- * Tests cloning a null configuration.
+ * Tests cloning a null configuration.
*/
@Test
public void testCloneConfigurationNull() {
diff --git a/src/test/java/org/apache/commons/configuration2/TestPropertiesConfigurationLayout.java b/src/test/java/org/apache/commons/configuration2/TestPropertiesConfigurationLayout.java
index 780a6a714a..18c40d4867 100644
--- a/src/test/java/org/apache/commons/configuration2/TestPropertiesConfigurationLayout.java
+++ b/src/test/java/org/apache/commons/configuration2/TestPropertiesConfigurationLayout.java
@@ -82,7 +82,7 @@ static class PropertiesBuilder {
/**
* Adds a comment line.
*
- * @param s the comment (can be null, then a blank line is added)
+ * @param s the comment (can be null, then a blank line is added)
*/
public void addComment(final String s) {
if (s != null) {
diff --git a/src/test/java/org/apache/commons/configuration2/builder/combined/TestConfigurationDeclaration.java b/src/test/java/org/apache/commons/configuration2/builder/combined/TestConfigurationDeclaration.java
index af7cd7ffcb..572285c053 100644
--- a/src/test/java/org/apache/commons/configuration2/builder/combined/TestConfigurationDeclaration.java
+++ b/src/test/java/org/apache/commons/configuration2/builder/combined/TestConfigurationDeclaration.java
@@ -34,7 +34,7 @@ public class TestConfigurationDeclaration {
/**
* Creates a default test instance.
*
- * @param conf the configuration to be used (may be null for a default one)
+ * @param conf the configuration to be used (may be null for a default one)
* @return the test object
*/
private static ConfigurationDeclaration createDeclaration(final HierarchicalConfiguration conf) {
diff --git a/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java b/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
index 47e276064a..1dad981125 100644
--- a/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
+++ b/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
@@ -306,7 +306,7 @@ private void writeDefinitionFile(final File defFile, final File src) throws Conf
/**
* Writes a file for testing reload operations.
*
- * @param f the file to be written or null for creating a new one
+ * @param f the file to be written or null for creating a new one
* @param tagIdx the index of the tag
* @param value the value of the reload test property
* @return the file that was written
@@ -320,7 +320,7 @@ private File writeReloadFile(final File f, final int tagIdx, final int value) th
* Helper method for writing a test file for reloading. The file will be created in the test directory. It is also
* scheduled for automatic deletion after the test.
*
- * @param f the file to be written or null for creating a new one
+ * @param f the file to be written or null for creating a new one
* @param content the content of the file
* @return the {@code File} object for the test file
* @throws IOException if an error occurs
diff --git a/src/test/java/org/apache/commons/configuration2/event/AbstractEventListenerTestImpl.java b/src/test/java/org/apache/commons/configuration2/event/AbstractEventListenerTestImpl.java
index 58e8bb12e6..506c72c076 100644
--- a/src/test/java/org/apache/commons/configuration2/event/AbstractEventListenerTestImpl.java
+++ b/src/test/java/org/apache/commons/configuration2/event/AbstractEventListenerTestImpl.java
@@ -40,7 +40,7 @@ public abstract class AbstractEventListenerTestImpl implements
/**
* Creates a new instance of {@code AbstractEventListenerTestImpl} and sets the expected event source.
*
- * @param source the event source (null if the source need not to be checked)
+ * @param source the event source (null if the source need not to be checked)
*/
protected AbstractEventListenerTestImpl(final Object source) {
expectedSource = source;
diff --git a/src/test/java/org/apache/commons/configuration2/event/ErrorListenerTestImpl.java b/src/test/java/org/apache/commons/configuration2/event/ErrorListenerTestImpl.java
index 60b03222b7..b2bcec7d43 100644
--- a/src/test/java/org/apache/commons/configuration2/event/ErrorListenerTestImpl.java
+++ b/src/test/java/org/apache/commons/configuration2/event/ErrorListenerTestImpl.java
@@ -25,7 +25,7 @@ public class ErrorListenerTestImpl extends AbstractEventListenerTestImplnull if the source need not to be checked)
+ * @param source the event source (null if the source need not to be checked)
*/
public ErrorListenerTestImpl(final Object source) {
super(source);
diff --git a/src/test/java/org/apache/commons/configuration2/event/EventListenerTestImpl.java b/src/test/java/org/apache/commons/configuration2/event/EventListenerTestImpl.java
index 501de238a2..c6dd90fa67 100644
--- a/src/test/java/org/apache/commons/configuration2/event/EventListenerTestImpl.java
+++ b/src/test/java/org/apache/commons/configuration2/event/EventListenerTestImpl.java
@@ -25,7 +25,7 @@ public class EventListenerTestImpl extends AbstractEventListenerTestImplnull if the source need not to be checked)
+ * @param source the event source (null if the source need not to be checked)
*/
public EventListenerTestImpl(final Object source) {
super(source);
diff --git a/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java b/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
index 1fb1ee56a8..1a0b5ca5f1 100644
--- a/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
+++ b/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
@@ -284,7 +284,7 @@ private File createTestFile() {
/**
* Creates a test file with test content and allows specifying a file name.
*
- * @param f the file to be created (may be null)
+ * @param f the file to be created (may be null)
* @return the File object pointing to the test file
*/
private File createTestFile(final File f) {
diff --git a/src/test/java/org/apache/commons/configuration2/reloading/AlwaysReloadingDetector.java b/src/test/java/org/apache/commons/configuration2/reloading/AlwaysReloadingDetector.java
index a968f62beb..e940598915 100644
--- a/src/test/java/org/apache/commons/configuration2/reloading/AlwaysReloadingDetector.java
+++ b/src/test/java/org/apache/commons/configuration2/reloading/AlwaysReloadingDetector.java
@@ -22,7 +22,7 @@
*/
public class AlwaysReloadingDetector implements ReloadingDetector {
/**
- * {@inheritDoc} This implementation always returns true.
+ * {@inheritDoc} This implementation always returns true.
*/
@Override
public boolean isReloadingRequired() {