This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push: new de6a67d2 Javadoc de6a67d2 is described below commit de6a67d237124120afe5f099d900517ab03611ae Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Tue May 24 10:46:57 2022 -0400 Javadoc --- .../beanutils/BeanCreationContext.java | 7 +-- .../configuration2/beanutils/BeanDeclaration.java | 13 +++--- .../configuration2/beanutils/BeanFactory.java | 5 ++- .../configuration2/beanutils/BeanHelper.java | 23 +++++----- .../beanutils/CombinedBeanDeclaration.java | 3 +- .../beanutils/ConfigurationDynaBean.java | 5 ++- .../beanutils/ConfigurationDynaClass.java | 3 +- .../configuration2/beanutils/ConstructorArg.java | 11 ++--- .../beanutils/DefaultBeanFactory.java | 15 ++++--- .../beanutils/XMLBeanDeclaration.java | 52 +++++++++++----------- 10 files changed, 74 insertions(+), 63 deletions(-) diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/BeanCreationContext.java b/src/main/java/org/apache/commons/configuration2/beanutils/BeanCreationContext.java index 52e6a0f9..b58a35d6 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/BeanCreationContext.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/BeanCreationContext.java @@ -29,15 +29,16 @@ package org.apache.commons.configuration2.beanutils; * @since 2.0 */ public interface BeanCreationContext { + /** - * Returns the class of the bean to be created. + * Gets the class of the bean to be created. * * @return the bean class */ Class<?> getBeanClass(); /** - * Returns the {@code BeanDeclaration} with the data for the new bean. This data is used to initialize the bean's + * Gets the {@code BeanDeclaration} with the data for the new bean. This data is used to initialize the bean's * properties. * * @return the {@code BeanDeclaration} defining the bean to be created @@ -45,7 +46,7 @@ public interface BeanCreationContext { BeanDeclaration getBeanDeclaration(); /** - * Returns the (optional) parameter object for the bean factory. This is a mechanism which can be used to pass custom + * Gets the (optional) parameter object for the bean factory. This is a mechanism which can be used to pass custom * parameters to a {@link BeanFactory}. * * @return the parameter for the bean factory diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/BeanDeclaration.java b/src/main/java/org/apache/commons/configuration2/beanutils/BeanDeclaration.java index ac7b904c..6218b09d 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/BeanDeclaration.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/BeanDeclaration.java @@ -40,8 +40,9 @@ import java.util.Map; * @since 1.3 */ public interface BeanDeclaration { + /** - * Returns the name of the {@code BeanFactory} that should be used for creating the bean instance. This can be + * Gets the name of the {@code BeanFactory} that should be used for creating the bean instance. This can be * <b>null</b>, then a default factory will be used. * * @return the name of the bean factory @@ -49,7 +50,7 @@ public interface BeanDeclaration { String getBeanFactoryName(); /** - * Here an arbitrary object can be returned that will be passed to the bean factory. Its meaning is not further + * Gets an arbitrary object that will be passed to the bean factory. Its meaning is not further * specified. The purpose of this additional parameter is to support a further configuration of the bean factory that * can be placed directly at the bean declaration. * @@ -58,7 +59,7 @@ public interface BeanDeclaration { Object getBeanFactoryParameter(); /** - * Returns the name of the bean class, from which an instance is to be created. This value must be defined unless a + * Gets the name of the bean class, from which an instance is to be created. This value must be defined unless a * default class is provided for the bean creation operation. * * @return the name of the bean class @@ -66,7 +67,7 @@ public interface BeanDeclaration { String getBeanClassName(); /** - * Returns a map with properties that should be initialized on the newly created bean. The map's keys are the names of + * Gets a map with properties that should be initialized on the newly created bean. The map's keys are the names of * the properties; the corresponding values are the properties' values. The return value can be <b>null</b> if no * properties should be set. * @@ -75,7 +76,7 @@ public interface BeanDeclaration { Map<String, Object> getBeanProperties(); /** - * Returns a map with declarations for beans that should be set as properties of the newly created bean. This allows for + * Gets a map with declarations for beans that should be set as properties of the newly created bean. This allows for * complex initialization scenarios: a bean for a bean that contains complex properties (e.g. other beans) can have * nested declarations for defining these complex properties. The returned map's key are the names of the properties to * initialize. The values are either {@code BeanDeclaration} implementations or collections thereof. They will be @@ -87,7 +88,7 @@ public interface BeanDeclaration { Map<String, Object> getNestedBeanDeclarations(); /** - * Returns a collection with constructor arguments. This data is used to determine the constructor of the bean class to + * Gets a collection with constructor arguments. This data is used to determine the constructor of the bean class to * be invoked. The values of the arguments are passed to the constructor. An implementation can return <b>null</b> or an * empty collection; then the standard constructor of the bean class is called. * diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/BeanFactory.java b/src/main/java/org/apache/commons/configuration2/beanutils/BeanFactory.java index df99c617..295e0de2 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/BeanFactory.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/BeanFactory.java @@ -37,8 +37,9 @@ package org.apache.commons.configuration2.beanutils; * @since 1.3 */ public interface BeanFactory { + /** - * Returns a bean instance for the given context object. All information about the bean to be created are contained in + * Creates a bean instance for the given context object. All information about the bean to be created are contained in * the provided {@code BeanCreationContext} object. This includes a {@link BeanDeclaration} defining the properties of * the bean. It is up to a concrete implementation how the bean is created and initialized. * @@ -50,7 +51,7 @@ public interface BeanFactory { Object createBean(BeanCreationContext bcc) throws Exception; /** - * Returns the default bean class of this bean factory. If an implementation here returns a non <b>null</b> value, bean + * Gets the default bean class of this bean factory. If an implementation here returns a non <b>null</b> value, bean * declarations using this factory do not need to provide the name of the bean class. In such a case an instance of the * default class will be created. * diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/BeanHelper.java b/src/main/java/org/apache/commons/configuration2/beanutils/BeanHelper.java index 7d18e7eb..d3b85389 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/BeanHelper.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/BeanHelper.java @@ -62,6 +62,7 @@ import org.apache.commons.lang3.ClassUtils; * @since 1.3 */ public final class BeanHelper { + /** * A default instance of {@code BeanHelper} which can be shared between arbitrary components. If no special * configuration is needed, this instance can be used throughout an application. Otherwise, new instances can be created @@ -85,7 +86,7 @@ public final class BeanHelper { private final BeanFactory defaultBeanFactory; /** - * Creates a new instance of {@code BeanHelper} with the default instance of {@link DefaultBeanFactory} as default + * Constructs a new instance of {@code BeanHelper} with the default instance of {@link DefaultBeanFactory} as default * {@link BeanFactory}. */ public BeanHelper() { @@ -93,7 +94,7 @@ public final class BeanHelper { } /** - * Creates a new instance of {@code BeanHelper} and sets the specified default {@code BeanFactory}. + * Constructs a new instance of {@code BeanHelper} and sets the specified default {@code BeanFactory}. * * @param defFactory the default {@code BeanFactory} (can be <b>null</b>, then a default instance is used) */ @@ -102,7 +103,7 @@ public final class BeanHelper { } /** - * Register a bean factory under a symbolic name. This factory object can then be specified in bean declarations with + * Registers a bean factory under a symbolic name. This factory object can then be specified in bean declarations with * the effect that this factory will be used to obtain an instance for the corresponding bean declaration. * * @param name the name of the factory @@ -130,7 +131,7 @@ public final class BeanHelper { } /** - * Returns a set with the names of all currently registered bean factories. + * Gets a set with the names of all currently registered bean factories. * * @return a set with the names of the registered bean factories */ @@ -139,7 +140,7 @@ public final class BeanHelper { } /** - * Returns the default bean factory. + * Gets the default bean factory. * * @return the default bean factory */ @@ -255,7 +256,7 @@ public final class BeanHelper { } /** - * Return the Class of the property if it can be determined. + * Gets the Class of the property if it can be determined. * * @param bean The bean containing the property. * @param propName The name of the property. @@ -316,7 +317,7 @@ public final class BeanHelper { } /** - * Set a property on the bean only if the property exists + * Sets a property on the bean only if the property exists * * @param bean the bean * @param propName the name of the property @@ -358,7 +359,7 @@ public final class BeanHelper { } /** - * Returns a bean instance for the specified declaration. This method is a short cut for + * Creates a bean instance for the specified declaration. This method is a short cut for * {@code createBean(data, null, null);}. * * @param data the bean declaration @@ -371,7 +372,7 @@ public final class BeanHelper { } /** - * Returns a bean instance for the specified declaration. This method is a short cut for + * Creates a bean instance for the specified declaration. This method is a short cut for * {@code createBean(data, null);}. * * @param data the bean declaration @@ -383,7 +384,7 @@ public final class BeanHelper { } /** - * Returns a {@code java.lang.Class} object for the specified name. Because class loading can be tricky in some + * Loads a {@code java.lang.Class} object for the specified name. Because class loading can be tricky in some * environments the code for retrieving a class by its name was extracted into this helper method. So if changes are * necessary, they can be made at a single place. * @@ -396,7 +397,7 @@ public final class BeanHelper { } /** - * Checks whether the specified property of the given bean instance supports write access. + * Tests whether the specified property of the given bean instance supports write access. * * @param bean the bean instance * @param propName the name of the property in question diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/CombinedBeanDeclaration.java b/src/main/java/org/apache/commons/configuration2/beanutils/CombinedBeanDeclaration.java index d0d3dcae..c18bb06b 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/CombinedBeanDeclaration.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/CombinedBeanDeclaration.java @@ -44,11 +44,12 @@ import java.util.Map; * @since 2.0 */ public class CombinedBeanDeclaration implements BeanDeclaration { + /** A list with the child declarations. */ private final List<BeanDeclaration> childDeclarations; /** - * Creates a new instance of {@code CombinedBeanDeclaration} and initializes it with the given child declarations. + * Constructs a new instance of {@code CombinedBeanDeclaration} and initializes it with the given child declarations. * * @param decl the child declarations * @throws NullPointerException if the array with child declarations is <b>null</b> diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/ConfigurationDynaBean.java b/src/main/java/org/apache/commons/configuration2/beanutils/ConfigurationDynaBean.java index ac3d35ba..e87db0dc 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/ConfigurationDynaBean.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/ConfigurationDynaBean.java @@ -52,6 +52,7 @@ import org.apache.commons.logging.LogFactory; * @since 1.0-rc1 */ public class ConfigurationDynaBean extends ConfigurationMap implements DynaBean { + /** Constant for the property delimiter. */ private static final String PROPERTY_DELIMITER = "."; @@ -59,7 +60,7 @@ public class ConfigurationDynaBean extends ConfigurationMap implements DynaBean private static final Log LOG = LogFactory.getLog(ConfigurationDynaBean.class); /** - * Creates a new instance of {@code ConfigurationDynaBean} and sets the configuration this bean is associated with. + * Constructs a new instance of {@code ConfigurationDynaBean} and sets the configuration this bean is associated with. * * @param configuration the configuration */ @@ -187,7 +188,7 @@ public class ConfigurationDynaBean extends ConfigurationMap implements DynaBean } /** - * Tests whether the given name references an indexed property. This implementation tests for properties of type list or + * Checks whether the given name references an indexed property. This implementation tests for properties of type list or * array. If the property does not exist, an exception is thrown. * * @param name the name of the property to check diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/ConfigurationDynaClass.java b/src/main/java/org/apache/commons/configuration2/beanutils/ConfigurationDynaClass.java index a95d4dc4..aeae16c0 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/ConfigurationDynaClass.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/ConfigurationDynaClass.java @@ -35,6 +35,7 @@ import org.apache.commons.logging.LogFactory; * @since 1.0-rc1 */ public class ConfigurationDynaClass implements DynaClass { + /** The logger. */ private static final Log LOG = LogFactory.getLog(ConfigurationDynaClass.class); @@ -42,7 +43,7 @@ public class ConfigurationDynaClass implements DynaClass { private final Configuration configuration; /** - * Construct an instance of a {@code ConfigurationDynaClass} wrapping the specified {@code Configuration} instance. + * Constructs an instance of a {@code ConfigurationDynaClass} wrapping the specified {@code Configuration} instance. * * @param configuration {@code Configuration} instance. */ diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/ConstructorArg.java b/src/main/java/org/apache/commons/configuration2/beanutils/ConstructorArg.java index 5fa40954..d1a41bc1 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/ConstructorArg.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/ConstructorArg.java @@ -35,6 +35,7 @@ import java.util.Objects; * @since 2.0 */ public final class ConstructorArg { + /** The bean declaration referenced by this constructor argument. */ private final BeanDeclaration beanDeclaration; @@ -45,7 +46,7 @@ public final class ConstructorArg { private final String typeName; /** - * Creates a new instance of {@code ConstructorArg}. + * Constructs a new instance of {@code ConstructorArg}. * * @param decl the associated bean declaration * @param val the value of the argument @@ -119,19 +120,19 @@ public final class ConstructorArg { } /** - * Returns a flag whether this constructor argument represents a {@code BeanDeclaration}. If this method returns + * Tests whether this constructor argument represents a {@code BeanDeclaration}. If this method returns * <b>true</b>, the actual value of this argument can be obtained by resolving the bean declaration returned by * {@link #getBeanDeclaration()}. Otherwise, this argument has a simple value which can be queried using * {@link #getValue()}. * - * @return a flag whether this constructor argument references a bean declaration + * @return whether this constructor argument references a bean declaration */ public boolean isNestedBeanDeclaration() { return getBeanDeclaration() != null; } /** - * Returns the value of this constructor argument. This method can be queried if {@link #isNestedBeanDeclaration()} + * Gets the value of this constructor argument. This method can be queried if {@link #isNestedBeanDeclaration()} * returns <b>false</b>. Note that a return value of <b>null</b> is legal (to pass <b>null</b> to a constructor * argument). * @@ -142,7 +143,7 @@ public final class ConstructorArg { } /** - * Returns the optional data type name of this constructor argument. The type name can be specified as a hint to select + * Gets the optional data type name of this constructor argument. The type name can be specified as a hint to select * a specific constructor if there are ambiguities. Note that it does not necessarily has to match the data type of this * argument's value because a type conversion may be performed before invoking the constructor. * diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/DefaultBeanFactory.java b/src/main/java/org/apache/commons/configuration2/beanutils/DefaultBeanFactory.java index 595a8fa5..c0a64f3e 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/DefaultBeanFactory.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/DefaultBeanFactory.java @@ -47,6 +47,7 @@ import org.apache.commons.configuration2.ex.ConfigurationRuntimeException; * @since 1.3 */ public class DefaultBeanFactory implements BeanFactory { + /** Stores the default instance of this class. */ public static final DefaultBeanFactory INSTANCE = new DefaultBeanFactory(); @@ -57,14 +58,14 @@ public class DefaultBeanFactory implements BeanFactory { private final ConversionHandler conversionHandler; /** - * Creates a new instance of {@code DefaultBeanFactory} using a default {@code ConversionHandler}. + * Constructs a new instance of {@code DefaultBeanFactory} using a default {@code ConversionHandler}. */ public DefaultBeanFactory() { this(null); } /** - * Creates a new instance of {@code DefaultBeanFactory} using the specified {@code ConversionHandler} for data type + * Constructs a new instance of {@code DefaultBeanFactory} using the specified {@code ConversionHandler} for data type * conversions. * * @param convHandler the {@code ConversionHandler}; can be <b>null</b>, then a default handler is used @@ -75,7 +76,7 @@ public class DefaultBeanFactory implements BeanFactory { } /** - * Returns the {@code ConversionHandler} used by this object. + * Gets the {@code ConversionHandler} used by this object. * * @return the {@code ConversionHandler} * @since 2.0 @@ -101,7 +102,7 @@ public class DefaultBeanFactory implements BeanFactory { } /** - * Returns the default bean class used by this factory. This is always <b>null</b> for this implementation. + * Gets the default bean class used by this factory. This is always <b>null</b> for this implementation. * * @return the default bean class */ @@ -238,7 +239,7 @@ public class DefaultBeanFactory implements BeanFactory { } /** - * Helper method for extracting constructor arguments from a bean declaration. Deals with <b>null</b> values. + * Gets constructor arguments from a bean declaration. Deals with <b>null</b> values. * * @param data the bean declaration * @return the collection with constructor arguments (never <b>null</b>) @@ -252,7 +253,7 @@ public class DefaultBeanFactory implements BeanFactory { } /** - * Helper method for testing whether exactly one matching constructor was found. Throws a meaningful exception if there + * Checks whether exactly one matching constructor was found. Throws a meaningful exception if there * is not a single matching constructor. * * @param beanClass the bean class @@ -271,7 +272,7 @@ public class DefaultBeanFactory implements BeanFactory { } /** - * Creates an exception if no single matching constructor was found with a meaningful error message. + * Constructs an exception if no single matching constructor was found with a meaningful error message. * * @param beanClass the affected bean class * @param data the bean declaration diff --git a/src/main/java/org/apache/commons/configuration2/beanutils/XMLBeanDeclaration.java b/src/main/java/org/apache/commons/configuration2/beanutils/XMLBeanDeclaration.java index 74d77668..610a991f 100644 --- a/src/main/java/org/apache/commons/configuration2/beanutils/XMLBeanDeclaration.java +++ b/src/main/java/org/apache/commons/configuration2/beanutils/XMLBeanDeclaration.java @@ -98,6 +98,7 @@ import org.apache.commons.lang3.StringUtils; * @since 1.3 */ public class XMLBeanDeclaration implements BeanDeclaration { + /** Constant for the prefix of reserved attributes. */ public static final String RESERVED_PREFIX = "config-"; @@ -139,7 +140,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { private final String defaultBeanClassName; /** - * Creates a new instance of {@code XMLBeanDeclaration} and initializes it from the given configuration. The passed in + * Constructs a new instance of {@code XMLBeanDeclaration} and initializes it from the given configuration. The passed in * key points to the bean declaration. * * @param config the configuration (must not be <b>null</b>) @@ -153,7 +154,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Creates a new instance of {@code XMLBeanDeclaration} and initializes it from the given configuration supporting + * Constructs a new instance of {@code XMLBeanDeclaration} and initializes it from the given configuration supporting * optional declarations. * * @param config the configuration (must not be <b>null</b>) @@ -168,7 +169,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Creates a new instance of {@code XMLBeanDeclaration} and initializes it from the given configuration supporting + * Constructs a new instance of {@code XMLBeanDeclaration} and initializes it from the given configuration supporting * optional declarations and a default bean class name. The passed in key points to the bean declaration. If the key * does not exist and the boolean argument is <b>true</b>, the declaration is initialized with an empty configuration. * It is possible to create objects from such an empty declaration if a default class is provided. If the key on the @@ -207,7 +208,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Creates a new instance of {@code XMLBeanDeclaration} and initializes it from the given configuration. The + * Constructs a new instance of {@code XMLBeanDeclaration} and initializes it from the given configuration. The * configuration's root node must contain the bean declaration. * * @param config the configuration with the bean declaration @@ -218,7 +219,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Creates a new instance of {@code XMLBeanDeclaration} and initializes it with the configuration node that contains the + * Constructs a new instance of {@code XMLBeanDeclaration} and initializes it with the configuration node that contains the * bean declaration. This constructor is used internally. * * @param config the configuration @@ -232,7 +233,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns the configuration object this bean declaration is based on. + * Gets the configuration object this bean declaration is based on. * * @return the associated configuration */ @@ -241,7 +242,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns the name of the default bean class. This class is used if no bean class is specified in the configuration. It + * Gets the name of the default bean class. This class is used if no bean class is specified in the configuration. It * may be <b>null</b> if no default class was set. * * @return the default bean class name @@ -252,7 +253,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns the name of the bean factory. This information is fetched from the {@code config-factory} attribute. + * Gets the name of the bean factory. This information is fetched from the {@code config-factory} attribute. * * @return the name of the bean factory */ @@ -262,7 +263,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns a parameter for the bean factory. This information is fetched from the {@code config-factoryParam} attribute. + * Gets a parameter for the bean factory. This information is fetched from the {@code config-factoryParam} attribute. * * @return the parameter for the bean factory */ @@ -272,7 +273,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns the name of the class of the bean to be created. This information is obtained from the {@code config-class} + * Gets the name of the class of the bean to be created. This information is obtained from the {@code config-class} * attribute. * * @return the name of the bean's class @@ -283,7 +284,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns a map with the bean's (simple) properties. The properties are collected from all attribute nodes, which are + * Gets a map with the bean's (simple) properties. The properties are collected from all attribute nodes, which are * not reserved. * * @return a map with the bean's properties @@ -301,7 +302,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns a map with bean declarations for the complex properties of the bean to be created. These declarations are + * Gets a map with bean declarations for the complex properties of the bean to be created. These declarations are * obtained from the child nodes of this declaration's root node. * * @return a map with bean declarations for complex properties @@ -361,7 +362,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Checks if the specified child node name is reserved and thus should be ignored. This method is called when processing + * Tests if the specified child node name is reserved and thus should be ignored. This method is called when processing * child nodes of this bean declaration. It is then possible to ignore some nodes with a specific meaning. This * implementation delegates to {@link #isReservedName(String)} . * @@ -374,7 +375,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Checks if the specified attribute name is reserved and thus does not point to a property of the bean to be created. + * Tests if the specified attribute name is reserved and thus does not point to a property of the bean to be created. * This method is called when processing the attributes of this bean declaration. It is then possible to ignore some * attributes with a specific meaning. This implementation delegates to {@link #isReservedName(String)}. * @@ -387,7 +388,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Checks if the specified name of a node or attribute is reserved and thus should be ignored. This method is called per + * Tests if the specified name of a node or attribute is reserved and thus should be ignored. This method is called per * default by the methods for checking attribute and child node names. It checks whether the passed in name starts with * the reserved prefix. * @@ -399,7 +400,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns a set with the names of the attributes of the configuration node holding the data of this bean declaration. + * Gets a set with the names of the attributes of the configuration node holding the data of this bean declaration. * * @return the attribute names of the underlying configuration node */ @@ -408,7 +409,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns the data about the associated node. + * Gets the data about the associated node. * * @return the node with the bean declaration */ @@ -458,7 +459,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Helper method for obtaining an attribute of a configuration node. This method also takes interpolation into account. + * Gets an attribute of a configuration node. This method also takes interpolation into account. * * @param nd the node * @param attr the name of the attribute @@ -470,7 +471,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Checks whether the constructor argument represented by the given configuration node is a bean declaration. + * Tests whether the constructor argument represented by the given configuration node is a bean declaration. * * @param nd the configuration node in question * @return a flag whether this constructor argument is a bean declaration @@ -492,11 +493,12 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * An internally used helper class which wraps the node with the bean declaration and the corresponding node handler. + * An internal helper class which wraps the node with the bean declaration and the corresponding node handler. * * @param <T> the type of the node */ static class NodeData<T> { + /** The wrapped node. */ private final T node; @@ -504,7 +506,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { private final NodeHandler<T> handler; /** - * Creates a new instance of {@code NodeData}. + * Constructs a new instance of {@code NodeData}. * * @param nd the node * @param hndlr the handler @@ -536,7 +538,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns a list with the children of the wrapped node, again wrapped into {@code NodeData} objects. + * Gets a list with the children of the wrapped node, again wrapped into {@code NodeData} objects. * * @return a list with the children */ @@ -545,7 +547,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns a list with the children of the wrapped node with the given name, again wrapped into {@code NodeData} + * Gets a list with the children of the wrapped node with the given name, again wrapped into {@code NodeData} * objects. * * @param name the name of the desired child nodes @@ -556,7 +558,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns a set with the names of the attributes of the wrapped node. + * Gets a set with the names of the attributes of the wrapped node. * * @return the attribute names of this node */ @@ -565,7 +567,7 @@ public class XMLBeanDeclaration implements BeanDeclaration { } /** - * Returns the value of the attribute with the given name of the wrapped node. + * Gets the value of the attribute with the given name of the wrapped node. * * @param key the key of the attribute * @return the value of this attribute