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-digester.git
The following commit(s) were added to refs/heads/master by this push:
new 0931ac5d Normalize setter Javadoc
0931ac5d is described below
commit 0931ac5d5fd4f131e154c946fe2e0a50a94a490f
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 07:05:23 2023 -0400
Normalize setter Javadoc
---
.../commons/digester3/AbstractMethodRule.java | 2 +-
.../commons/digester3/BeanPropertySetterRule.java | 2 +-
.../apache/commons/digester3/CallMethodRule.java | 2 +-
.../apache/commons/digester3/CallParamRule.java | 2 +-
.../org/apache/commons/digester3/Digester.java | 24 +++++++++++-----------
.../commons/digester3/ObjectCreationFactory.java | 2 +-
.../java/org/apache/commons/digester3/Rule.java | 4 ++--
.../java/org/apache/commons/digester3/Rules.java | 4 ++--
.../commons/digester3/binder/DigesterLoader.java | 14 ++++++-------
.../digester3/binder/PluginCreateRuleBuilder.java | 6 +++---
.../digester3/binder/SetPropertyBuilder.java | 2 +-
.../commons/digester3/plugins/PluginContext.java | 2 +-
.../commons/digester3/plugins/PluginRules.java | 6 +++---
.../digester3/xmlrules/FromXmlRulesModule.java | 2 +-
.../apache/commons/digester3/DigesterTestCase.java | 2 +-
.../org/apache/commons/digester3/RuleTestCase.java | 2 +-
.../commons/digester3/RulesBaseTestCase.java | 2 +-
.../commons/digester3/SetPropertyRuleTestCase.java | 2 +-
.../org/apache/commons/digester3/TestRule.java | 2 +-
.../org/apache/commons/digester3/URLTestCase.java | 2 +-
.../commons/digester3/XMLSchemaTestCase.java | 2 +-
21 files changed, 44 insertions(+), 44 deletions(-)
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/AbstractMethodRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/AbstractMethodRule.java
index 0346e771..ad5948be 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/AbstractMethodRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/AbstractMethodRule.java
@@ -153,7 +153,7 @@ public abstract class AbstractMethodRule
/**
* <p>
- * Set whether exact matching is enabled.
+ * Sets whether exact matching is enabled.
* </p>
* <p>
* See {@link #isExactMatch()}.
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/BeanPropertySetterRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/BeanPropertySetterRule.java
index 1ffdf6b3..8f060a5f 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/BeanPropertySetterRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/BeanPropertySetterRule.java
@@ -77,7 +77,7 @@ public class BeanPropertySetterRule
// ----------------------------------------------------- Instance Variables
/**
- * Set this property on the top object.
+ * Sets this property on the top object.
*/
private String propertyName;
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
index a8b98020..138440bb 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
@@ -299,7 +299,7 @@ public class CallMethodRule
}
/**
- * Set whether {@code MethodUtils.invokeExactMethod} should be used for
the reflection.
+ * Sets whether {@code MethodUtils.invokeExactMethod} should be used for
the reflection.
*
* @param useExactMatch The {@code MethodUtils.invokeExactMethod} flag
*/
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallParamRule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallParamRule.java
index ca6582eb..0314d938 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallParamRule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/CallParamRule.java
@@ -128,7 +128,7 @@ public class CallParamRule
// --------------------------------------------------------- Public Methods
/**
- * Set the attribute from which to save the parameter value.
+ * Sets the attribute from which to save the parameter value.
*
* @param attributeName The attribute from which to save the parameter
value
* @since 3.0
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Digester.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Digester.java
index 05c556b5..2fc14117 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Digester.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Digester.java
@@ -367,7 +367,7 @@ public class Digester
}
/**
- * Set the class loader to be used for instantiating application objects
when required.
+ * Sets the class loader to be used for instantiating application objects
when required.
*
* @param classLoader The new class loader to use, or {@code null} to
revert to the standard rules
*/
@@ -413,7 +413,7 @@ public class Digester
}
/**
- * Set the error handler for this Digester.
+ * Sets the error handler for this Digester.
*
* @param errorHandler The new error handler
*/
@@ -488,7 +488,7 @@ public class Digester
}
/**
- * Set the current logger for this Digester.
+ * Sets the current logger for this Digester.
*
* @param log the current logger for this Digester.
*/
@@ -553,7 +553,7 @@ public class Digester
}
/**
- * Set the "namespace aware" flag for parsers we create.
+ * Sets the "namespace aware" flag for parsers we create.
*
* @param namespaceAware The new "namespace aware" flag
*/
@@ -576,7 +576,7 @@ public class Digester
}
/**
- * Set the XInclude-aware flag for parsers we create. This additionally
requires namespace-awareness.
+ * Sets the XInclude-aware flag for parsers we create. This additionally
requires namespace-awareness.
*
* @param xincludeAware The new XInclude-aware flag
* @see #setNamespaceAware(boolean)
@@ -588,7 +588,7 @@ public class Digester
}
/**
- * Set the public id of the current file being parse.
+ * Sets the public id of the current file being parse.
*
* @param publicId the DTD/Schema public's id.
*/
@@ -618,7 +618,7 @@ public class Digester
}
/**
- * Set the namespace URI that will be applied to all subsequently added
{@code Rule} objects.
+ * Sets the namespace URI that will be applied to all subsequently added
{@code Rule} objects.
*
* @param ruleNamespaceURI Namespace URI that must match on all
subsequently added rules, or {@code null} for
* matching regardless of the current namespace URI
@@ -675,7 +675,7 @@ public class Digester
}
/**
- * Set the current value of the specified property for the underlying
{@code XMLReader} implementation. See <a
+ * Sets the current value of the specified property for the underlying
{@code XMLReader} implementation. See <a
* href="http://www.saxproject.org";>the saxproject website</a> for
information about the standard SAX2 properties.
*
* @param property Property name to be set
@@ -706,7 +706,7 @@ public class Digester
}
/**
- * Set the {@code Rules} implementation object containing our rules
collection and associated matching policy.
+ * Sets the {@code Rules} implementation object containing our rules
collection and associated matching policy.
*
* @param rules New Rules implementation
*/
@@ -728,7 +728,7 @@ public class Digester
}
/**
- * Set the XML Schema to be used when parsing.
+ * Sets the XML Schema to be used when parsing.
*
* @param schema The {@link Schema} instance to use.
* @since 2.0
@@ -771,7 +771,7 @@ public class Digester
}
/**
- * Set the validating parser flag. This must be called before {@code
parse()} is called the first time.
+ * Sets the validating parser flag. This must be called before {@code
parse()} is called the first time.
* By default the value of this is set to false.
*
* It essentially just controls the DTD validation. To use modern schema
languages use the
@@ -1427,7 +1427,7 @@ public class Digester
// ----------------------------------------------- EntityResolver Methods
/**
- * Set the {@code EntityResolver} used by SAX when resolving public id and
system id. This must be called
+ * Sets the {@code EntityResolver} used by SAX when resolving public id
and system id. This must be called
* before the first call to {@code parse()}.
*
* @param entityResolver a class that implement the {@code EntityResolver}
interface.
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
index d13816ac..f2b12090 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
@@ -53,7 +53,7 @@ public interface ObjectCreationFactory<T>
Digester getDigester();
/**
- * Set the {@link Digester} to allow the implementation to do logging,
classloading based on the digester's
+ * Sets the {@link Digester} to allow the implementation to do logging,
classloading based on the digester's
* classloader, etc.
*
* @param digester parent Digester object
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rule.java
index 14fffabf..05c96d69 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rule.java
@@ -77,7 +77,7 @@ import org.xml.sax.Attributes;
}
/**
- * Set the {@code Digester} with which this {@code Rule} is associated.
+ * Sets the {@code Digester} with which this {@code Rule} is associated.
*
* @param digester the {@code Digester} with which this {@code Rule} is
associated
*/
@@ -97,7 +97,7 @@ import org.xml.sax.Attributes;
}
/**
- * Set the namespace URI for which this Rule is relevant, if any.
+ * Sets the namespace URI for which this Rule is relevant, if any.
*
* @param namespaceURI Namespace URI for which this Rule is relevant, or
{@code null} to match independent of
* namespace.
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rules.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rules.java
index bb7490bf..e6827a7d 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rules.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Rules.java
@@ -41,7 +41,7 @@ public interface Rules
Digester getDigester();
/**
- * Set the Digester instance with which this Rules instance is associated.
+ * Sets the Digester instance with which this Rules instance is associated.
*
* @param digester The newly associated Digester instance
*/
@@ -55,7 +55,7 @@ public interface Rules
String getNamespaceURI();
/**
- * Set the namespace URI that will be applied to all subsequently added
{@code Rule} objects.
+ * Sets the namespace URI that will be applied to all subsequently added
{@code Rule} objects.
*
* @param namespaceURI Namespace URI that must match on all subsequently
added rules, or {@code null} for
* matching regardless of the current namespace URI
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
index 97d986c6..e10670d6 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
@@ -188,7 +188,7 @@ public final class DigesterLoader
}
/**
- * Set the class loader to be used for instantiating application objects
when required.
+ * Sets the class loader to be used for instantiating application objects
when required.
*
* @param classLoader the class loader to be used for instantiating
application objects when required.
* @return This loader instance, useful to chain methods.
@@ -225,7 +225,7 @@ public final class DigesterLoader
}
/**
- * Set the "namespace aware" flag for parsers we create.
+ * Sets the "namespace aware" flag for parsers we create.
*
* @param namespaceAware The new "namespace aware" flag
* @return This loader instance, useful to chain methods.
@@ -247,7 +247,7 @@ public final class DigesterLoader
}
/**
- * Set the XInclude-aware flag for parsers we create. This additionally
+ * Sets the XInclude-aware flag for parsers we create. This additionally
* requires namespace-awareness.
*
* @param xIncludeAware The new XInclude-aware flag
@@ -272,7 +272,7 @@ public final class DigesterLoader
}
/**
- * Set the {@code DOCTYPE} validation parser flag and should not be used
when using schemas.
+ * Sets the {@code DOCTYPE} validation parser flag and should not be used
when using schemas.
*
* @param validating The new validating parser flag.
* @return This loader instance, useful to chain methods.
@@ -295,7 +295,7 @@ public final class DigesterLoader
}
/**
- * Set the XML Schema to be used when parsing.
+ * Sets the XML Schema to be used when parsing.
*
* @param schema The {@link Schema} instance to use.
* @return This loader instance, useful to chain methods.
@@ -385,7 +385,7 @@ public final class DigesterLoader
}
/**
- * Set the {@code EntityResolver} used by SAX when resolving public id and
system id. This must be called
+ * Sets the {@code EntityResolver} used by SAX when resolving public id
and system id. This must be called
* before the first call to {@code parse()}.
*
* @param entityResolver a class that implement the {@code EntityResolver}
interface.
@@ -446,7 +446,7 @@ public final class DigesterLoader
}
/**
- * Set the error handler for this Digester.
+ * Sets the error handler for this Digester.
*
* @param errorHandler The new error handler
* @return This loader instance, useful to chain methods.
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/PluginCreateRuleBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/PluginCreateRuleBuilder.java
index a177f19c..74b2f82d 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/PluginCreateRuleBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/PluginCreateRuleBuilder.java
@@ -52,7 +52,7 @@ public final class PluginCreateRuleBuilder
}
/**
- * Set the class which any specified plugin <i>must</i> be descended from.
+ * Sets the class which any specified plugin <i>must</i> be descended from.
*
* @param <T> Any Java type
* @param type the class which any specified plugin <i>must</i> be
descended from
@@ -72,7 +72,7 @@ public final class PluginCreateRuleBuilder
}
/**
- * Set the class which will be used if the user doesn't specify any
plugin-class or plugin-id.
+ * Sets the class which will be used if the user doesn't specify any
plugin-class or plugin-id.
*
* @param <T> Any Java type
* @param type the class which will be used if the user doesn't specify
any plugin-class or plugin-id.
@@ -85,7 +85,7 @@ public final class PluginCreateRuleBuilder
}
/**
- * Set RuleLoader instance which knows how to load the custom rules
associated with the default plugin.
+ * Sets RuleLoader instance which knows how to load the custom rules
associated with the default plugin.
*
* @param <RL> Any {@link RuleLoader} extension.
* @param ruleLoader the RuleLoader instance which knows how to load the
custom rules associated with
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/SetPropertyBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/SetPropertyBuilder.java
index 032c3a90..f7cab06b 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/SetPropertyBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/SetPropertyBuilder.java
@@ -44,7 +44,7 @@ public final class SetPropertyBuilder
}
/**
- * Set the name of the attribute that will contain the value to which the
property should be set.
+ * Sets the name of the attribute that will contain the value to which the
property should be set.
*
* @param valueAttributeName Name of the attribute that will contain the
value to which the property should be set.
* @return this builder instance
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginContext.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginContext.java
index 0c338b73..123e497b 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginContext.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginContext.java
@@ -109,7 +109,7 @@ public class PluginContext
}
/**
- * Set the list of RuleFinder objects. This may be useful if working in a
non-english language, allowing the
+ * Sets the list of RuleFinder objects. This may be useful if working in a
non-english language, allowing the
* application developer to replace the standard list with a list of
objects which look for xml attributes in the
* local language.
* <p>
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
index 86d6a78c..06d273cd 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
@@ -170,7 +170,7 @@ public class PluginRules
}
/**
- * Set the Digester instance with which this Rules instance is associated.
+ * Sets the Digester instance with which this Rules instance is associated.
*
* @param digester The newly associated Digester instance
*/
@@ -193,7 +193,7 @@ public class PluginRules
}
/**
- * Set the namespace URI that will be applied to all subsequently added
{@code Rule} objects.
+ * Sets the namespace URI that will be applied to all subsequently added
{@code Rule} objects.
*
* @param namespaceURI Namespace URI that must match on all subsequently
added rules, or {@code null} for
* matching regardless of the current namespace URI
@@ -245,7 +245,7 @@ public class PluginRules
}
/**
- * Set the object which is used to generate the new Rules instances
created to hold and process the rules associated
+ * Sets the object which is used to generate the new Rules instances
created to hold and process the rules associated
* with each plugged-in class.
*
* @param factory the rules factory object
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/xmlrules/FromXmlRulesModule.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/xmlrules/FromXmlRulesModule.java
index b6fb4bfd..a1a12924 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/xmlrules/FromXmlRulesModule.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/xmlrules/FromXmlRulesModule.java
@@ -237,7 +237,7 @@ public abstract class FromXmlRulesModule
}
/**
- * Set the root path (will be used when composing modules).
+ * Sets the root path (will be used when composing modules).
*
* @param rootPath The root path
*/
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/DigesterTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/DigesterTestCase.java
index 6cb383e0..1ba854df 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/DigesterTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/DigesterTestCase.java
@@ -71,7 +71,7 @@ public class DigesterTestCase
// -------------------------------------------------- Overall Test Methods
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Before
public void setUp()
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/RuleTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/RuleTestCase.java
index e63936b4..79eefb60 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/RuleTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/RuleTestCase.java
@@ -51,7 +51,7 @@ public class RuleTestCase
// --------------------------------------------------- Overall Test Methods
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Before
public void setUp()
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/RulesBaseTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/RulesBaseTestCase.java
index eb5e902f..5b52fdb4 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/RulesBaseTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/RulesBaseTestCase.java
@@ -46,7 +46,7 @@ public class RulesBaseTestCase
// -------------------------------------------------- Overall Test Methods
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Before
public void setUp()
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/SetPropertyRuleTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/SetPropertyRuleTestCase.java
index c17bdfbe..0e964f41 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/SetPropertyRuleTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/SetPropertyRuleTestCase.java
@@ -78,7 +78,7 @@ public class SetPropertyRuleTestCase
// --------------------------------------------------- Overall Test Methods
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Before
public void setUp()
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/TestRule.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/TestRule.java
index c6496739..781623cb 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/TestRule.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/TestRule.java
@@ -142,7 +142,7 @@ public class TestRule
}
/**
- * Set call order list
+ * Sets call order list
*/
public void setOrder( final List<Rule> order )
{
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/URLTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/URLTestCase.java
index 1cd0f6d5..6325647d 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/URLTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/URLTestCase.java
@@ -37,7 +37,7 @@ public class URLTestCase
// ----------------------------------------------------- Overall Test
Methods
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Before
public void setUp()
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/XMLSchemaTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/XMLSchemaTestCase.java
index a742bd5b..45dff012 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/XMLSchemaTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/XMLSchemaTestCase.java
@@ -55,7 +55,7 @@ public class XMLSchemaTestCase
// --------------------------------------------------- Overall Test Methods
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Before
public void setUp()
