This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 20bb5a1d Javadoc
20bb5a1d is described below
commit 20bb5a1df9a5925490f902697e8b39114ba43405
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:44:58 2026 -0400
Javadoc
---
.../commons/digester3/AbstractMethodRule.java | 6 +-
.../org/apache/commons/digester3/Digester.java | 88 +++++++++++-----------
.../commons/digester3/ObjectCreationFactory.java | 4 +-
.../org/apache/commons/digester3/RegexRules.java | 2 +-
.../java/org/apache/commons/digester3/Rule.java | 4 +-
.../java/org/apache/commons/digester3/RuleSet.java | 2 +-
.../java/org/apache/commons/digester3/Rules.java | 4 +-
.../commons/digester3/SimpleRegexMatcher.java | 2 +-
.../org/apache/commons/digester3/StackAction.java | 4 +-
.../org/apache/commons/digester3/Substitutor.java | 2 +-
.../annotations/reflect/MethodArgument.java | 4 +-
.../annotations/utils/AnnotationUtils.java | 8 +-
.../binder/AbstractBackToLinkedRuleBuilder.java | 2 +-
.../commons/digester3/binder/AddAliasBuilder.java | 2 +-
.../commons/digester3/binder/DigesterLoader.java | 8 +-
.../digester3/binder/FromBinderRuleSet.java | 2 +-
.../digester3/binder/NestedPropertiesBuilder.java | 2 +-
.../digester3/binder/SetPropertiesBuilder.java | 2 +-
.../commons/digester3/plugins/PluginContext.java | 10 +--
.../commons/digester3/plugins/PluginException.java | 2 +-
.../commons/digester3/plugins/PluginRules.java | 18 ++---
.../digester3/substitution/VariableExpander.java | 2 +-
.../digester3/xmlrules/WithMemoryRulesBinder.java | 4 +-
.../digester3/ExtendedBaseRulesTestCase.java | 2 +-
.../commons/digester3/RulesBaseTestCase.java | 2 +-
.../apache/commons/digester3/binder/Entity.java | 2 +-
26 files changed, 95 insertions(+), 95 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 c6949cc5..8a9c26b0 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
@@ -123,14 +123,14 @@ public abstract class AbstractMethodRule
/**
* Returns the argument object of method has to be invoked.
*
- * @return the argument object of method has to be invoked.
+ * @return The argument object of method has to be invoked.
*/
protected abstract Object getChild();
/**
* Returns the target object of method has to be invoked.
*
- * @return the target object of method has to be invoked.
+ * @return The target object of method has to be invoked.
*/
protected abstract Object getParent();
@@ -218,7 +218,7 @@ public abstract class AbstractMethodRule
* Returns the flag this rule be invoked when {@link #begin(String,
String, Attributes)} (true)
* or {@link #end(String, String)} (false) methods are invoked, false by
default.
*
- * @return the flag this rule be invoked when {@link #begin(String,
String, Attributes)} (true)
+ * @return The flag this rule be invoked when {@link #begin(String,
String, Attributes)} (true)
* or {@link #end(String, String)} (false) methods are invoked, false by
default.
*/
public boolean isFireOnBegin()
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 a27251c3..d54c89d7 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
@@ -1158,7 +1158,7 @@ public class Digester
* Create a SAX exception which also understands about the location in the
digester file where the exception occurs
*
* @param e the exception cause
- * @return the new SAX exception
+ * @return The new SAX exception
*/
public SAXException createSAXException( Exception e )
{
@@ -1177,7 +1177,7 @@ public class Digester
* Create a SAX exception which also understands about the location in the
digester file where the exception occurs
*
* @param message the custom SAX exception message
- * @return the new SAX exception
+ * @return The new SAX exception
*/
public SAXException createSAXException( final String message )
{
@@ -1189,7 +1189,7 @@ public class Digester
*
* @param message the custom SAX exception message
* @param e the exception cause
- * @return the new SAX exception
+ * @return The new SAX exception
*/
public SAXException createSAXException( final String message, Exception e )
{
@@ -1423,7 +1423,7 @@ public class Digester
* These mappings come and go dynamically as the document is parsed.
*
* @param prefix Prefix to look up
- * @return the currently mapped namespace URI for the specified prefix
+ * @return The currently mapped namespace URI for the specified prefix
*/
public String findNamespaceURI( final String prefix )
{
@@ -1452,7 +1452,7 @@ public class Digester
* <li>The class loader used to load the Digester class itself.</li>
* </ul>
*
- * @return the class loader to be used for instantiating application
objects.
+ * @return The class loader to be used for instantiating application
objects.
*/
public ClassLoader getClassLoader()
{
@@ -1474,7 +1474,7 @@ public class Digester
/**
* Gets the current depth of the element stack.
*
- * @return the current depth of the element stack.
+ * @return The current depth of the element stack.
*/
public int getCount()
{
@@ -1484,7 +1484,7 @@ public class Digester
/**
* Gets the name of the XML element that is currently being processed.
*
- * @return the name of the XML element that is currently being processed.
+ * @return The name of the XML element that is currently being processed.
*/
public String getCurrentElementName()
{
@@ -1530,7 +1530,7 @@ public class Digester
/**
* returns the custom SAX ContentHandler where events are redirected.
*
- * @return the custom SAX ContentHandler where events are redirected.
+ * @return The custom SAX ContentHandler where events are redirected.
* @see #setCustomContentHandler(ContentHandler)
* @since 1.7
*/
@@ -1542,7 +1542,7 @@ public class Digester
/**
* Gets the document locator associated with our parser.
*
- * @return the Locator supplied by the document parser
+ * @return The Locator supplied by the document parser
*/
public Locator getDocumentLocator()
{
@@ -1552,7 +1552,7 @@ public class Digester
/**
* Gets the Entity Resolver used by the SAX parser.
*
- * @return the Entity Resolver used by the SAX parser.
+ * @return The Entity Resolver used by the SAX parser.
*/
public EntityResolver getEntityResolver()
{
@@ -1562,7 +1562,7 @@ public class Digester
/**
* Gets the error handler for this Digester.
*
- * @return the error handler for this Digester.
+ * @return The error handler for this Digester.
*/
public ErrorHandler getErrorHandler()
{
@@ -1572,7 +1572,7 @@ public class Digester
/**
* Returns the executor service used to run asynchronous parse method.
*
- * @return the executor service used to run asynchronous parse method
+ * @return The executor service used to run asynchronous parse method
* @since 3.1
*/
public ExecutorService getExecutorService()
@@ -1583,7 +1583,7 @@ public class Digester
/**
* Gets the SAXParserFactory we will use, creating one if necessary.
*
- * @return the SAXParserFactory we will use, creating one if necessary.
+ * @return The SAXParserFactory we will use, creating one if necessary.
*/
public SAXParserFactory getFactory()
{
@@ -1619,7 +1619,7 @@ public class Digester
/**
* Gets the current Logger associated with this instance of the Digester
*
- * @return the current Logger associated with this instance of the Digester
+ * @return The current Logger associated with this instance of the Digester
*/
public Log getLogger()
{
@@ -1629,7 +1629,7 @@ public class Digester
/**
* Gets the current rule match path
*
- * @return the current rule match path
+ * @return The current rule match path
*/
public String getMatch()
{
@@ -1652,7 +1652,7 @@ public class Digester
/**
* Gets the "namespace aware" flag for parsers we create.
*
- * @return the "namespace aware" flag for parsers we create.
+ * @return The "namespace aware" flag for parsers we create.
*/
public boolean getNamespaceAware()
{
@@ -1664,7 +1664,7 @@ public class Digester
*
* If there is a problem creating the parser, return {@code null}.
*
- * @return the SAXParser we will use to parse the input stream
+ * @return The SAXParser we will use to parse the input stream
*/
public SAXParser getParser()
{
@@ -1695,7 +1695,7 @@ public class Digester
* properties.
*
* @param property Property name to be retrieved
- * @return the current value of the specified property for the underlying
{@code XMLReader} implementation.
+ * @return The current value of the specified property for the underlying
{@code XMLReader} implementation.
* @throws SAXNotRecognizedException if the property name is not recognized
* @throws SAXNotSupportedException if the property name is recognized but
not supported
*/
@@ -1708,7 +1708,7 @@ public class Digester
/**
* Gets the public identifier of the DTD we are currently parsing under,
if any.
*
- * @return the public identifier of the DTD we are currently parsing
under, if any.
+ * @return The public identifier of the DTD we are currently parsing
under, if any.
*/
public String getPublicId()
{
@@ -1718,7 +1718,7 @@ public class Digester
/**
* Gets the set of DTD URL registrations, keyed by public identifier.
NOTE: the returned map is in read-only mode.
*
- * @return the read-only Map of DTD URL registrations.
+ * @return The read-only Map of DTD URL registrations.
*/
Map<String, URL> getRegistrations()
{
@@ -1744,7 +1744,7 @@ public class Digester
* created after parsing has completed.
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
- * @return the root object that has been created after parsing or null if
the digester has not parsed any XML yet.
+ * @return The root object that has been created after parsing or null if
the digester has not parsed any XML yet.
*/
public <T> T getRoot()
{
@@ -1754,7 +1754,7 @@ public class Digester
/**
* Gets the namespace URI that will be applied to all subsequently added
{@code Rule} objects.
*
- * @return the namespace URI that will be applied to all subsequently
added {@code Rule} objects.
+ * @return The namespace URI that will be applied to all subsequently
added {@code Rule} objects.
*/
public String getRuleNamespaceURI()
{
@@ -1765,7 +1765,7 @@ public class Digester
* Gets the {@code Rules} implementation object containing our rules
collection and associated matching
* policy. If none has been established, a default implementation will be
created and returned.
*
- * @return the {@code Rules} implementation object.
+ * @return The {@code Rules} implementation object.
*/
public Rules getRules()
{
@@ -1780,7 +1780,7 @@ public class Digester
/**
* Gets the logger used for logging SAX-related information.
<strong>Note</strong> the output is finely grained.
*
- * @return the logger used for logging SAX-related information
+ * @return The logger used for logging SAX-related information
* @since 1.6
*/
public Log getSAXLogger()
@@ -1792,7 +1792,7 @@ public class Digester
* Gets the callback object which is invoked whenever an object is pushed
onto a digester object stack,
* or popped off one.
*
- * @return the callback object which is invoked whenever an object is
pushed onto a digester object stack,
+ * @return The callback object which is invoked whenever an object is
pushed onto a digester object stack,
* or popped off one.
* @see #setStackAction(StackAction)
* @since 1.8
@@ -1805,7 +1805,7 @@ public class Digester
/**
* Gets the {@code Substitutor} used to convert attributes and body text.
*
- * @return the {@code Substitutor} used to convert attributes and body
text,
+ * @return The {@code Substitutor} used to convert attributes and body
text,
* null if not substitutions are to be performed.
*/
public Substitutor getSubstitutor()
@@ -1826,7 +1826,7 @@ public class Digester
/**
* Gets the validating parser flag.
*
- * @return the validating parser flag.
+ * @return The validating parser flag.
*/
public boolean getValidating()
{
@@ -1851,7 +1851,7 @@ public class Digester
*
* FIXME: there is a bug in JAXP/XERCES that prevent the use of a parser
that contains a schema with a DTD.
*
- * @return the XMLReader to be used for parsing the input document.
+ * @return The XMLReader to be used for parsing the input document.
* @throws SAXException if no XMLReader can be instantiated
*/
public XMLReader getXMLReader()
@@ -1976,7 +1976,7 @@ public class Digester
*
* @param <T> The type the input object has to be cast.
* @param obj the object has to be cast.
- * @return the casted object, if input object is not null, null otherwise.
+ * @return The casted object, if input object is not null, null otherwise.
* @since 3.0
*/
private <T> T npeSafeCast( final Object obj )
@@ -1998,7 +1998,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param file File containing the XML data to be parsed
- * @return the root element from the object stack (if any)
+ * @return The root element from the object stack (if any)
* @throws IOException if an input/output error occurs
* @throws SAXException if a parsing exception occurs
*/
@@ -2022,7 +2022,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param input Input source containing the XML data to be parsed
- * @return the root element from the object stack (if any)
+ * @return The root element from the object stack (if any)
* @throws IOException if an input/output error occurs
* @throws SAXException if a parsing exception occurs
*/
@@ -2062,7 +2062,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param input Input stream containing the XML data to be parsed
- * @return the root element from the object stack (if any)
+ * @return The root element from the object stack (if any)
* @throws IOException if an input/output error occurs
* @throws SAXException if a parsing exception occurs
*/
@@ -2083,7 +2083,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param reader Reader containing the XML data to be parsed
- * @return the root element from the object stack (if any)
+ * @return The root element from the object stack (if any)
* @throws IOException if an input/output error occurs
* @throws SAXException if a parsing exception occurs
*/
@@ -2104,7 +2104,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param uri URI containing the XML data to be parsed
- * @return the root element from the object stack (if any)
+ * @return The root element from the object stack (if any)
* @throws IOException if an input/output error occurs
* @throws SAXException if a parsing exception occurs
*/
@@ -2125,7 +2125,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param url URL containing the XML data to be parsed
- * @return the root element from the object stack (if any)
+ * @return The root element from the object stack (if any)
* @throws IOException if an input/output error occurs
* @throws SAXException if a parsing exception occurs
* @since 1.8
@@ -2147,7 +2147,7 @@ public class Digester
* If there are no objects on the stack, return {@code null}.
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
- * @return the top object on the stack without removing it.
+ * @return The top object on the stack without removing it.
*/
public <T> T peek()
{
@@ -2168,7 +2168,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param n Index of the desired element, where 0 is the top of the stack,
1 is the next element down, and so on.
- * @return the n'th object down the stack
+ * @return The n'th object down the stack
*/
public <T> T peek( final int n )
{
@@ -2199,7 +2199,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param stackName the name of the stack to be peeked
- * @return the top {@code Object} on the stack or null if the stack is
either empty or has not been created yet
+ * @return The top {@code Object} on the stack or null if the stack is
either empty or has not been created yet
* @since 1.6
*/
public <T> T peek( final String stackName )
@@ -2218,7 +2218,7 @@ public class Digester
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param stackName the name of the stack to be peeked
* @param n Index of the desired element, where 0 is the top of the stack,
1 is the next element down, and so on.
- * @return the specified {@code Object} on the stack.
+ * @return The specified {@code Object} on the stack.
* @since 1.6
*/
public <T> T peek( final String stackName, final int n )
@@ -2253,7 +2253,7 @@ public class Digester
* The parameters stack is used to store {@code CallMethodRule}
parameters. See {@link #params}.
* </p>
*
- * @return the top object on the parameters stack without removing it.
+ * @return The top object on the parameters stack without removing it.
*/
public Object[] peekParams()
{
@@ -2278,7 +2278,7 @@ public class Digester
* </p>
*
* @param n Index of the desired element, where 0 is the top of the stack,
1 is the next element down, and so on.
- * @return the n'th object down the parameters stack
+ * @return The n'th object down the parameters stack
*/
public Object[] peekParams( final int n )
{
@@ -2304,7 +2304,7 @@ public class Digester
* {@code null}.
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
- * @return the top object popped off of the stack
+ * @return The top object popped off of the stack
*/
public <T> T pop()
{
@@ -2334,7 +2334,7 @@ public class Digester
*
* @param <T> The type used to auto-cast the returned object to the
assigned variable type
* @param stackName the name of the stack from which the top value is to
be popped.
- * @return the top {@code Object} on the stack or throws {@code
EmptyStackException}
+ * @return The top {@code Object} on the stack or throws {@code
EmptyStackException}
* if the stack is either empty or has not been created yet
* @since 1.6
*/
@@ -2369,7 +2369,7 @@ public class Digester
* The parameters stack is used to store {@code CallMethodRule}
parameters. See {@link #params}.
* </p>
*
- * @return the top object popped off of the parameters stack
+ * @return The top object popped off of the parameters stack
*/
public Object[] popParams()
{
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 6b2ee370..8c4d8fa6 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
@@ -40,7 +40,7 @@ public interface ObjectCreationFactory<T>
* Factory method called by {@link FactoryCreateRule} to supply an object
based on the element's attributes.
*
* @param attributes the element's attributes
- * @return the object to be pushed onto the {@code Digester} stack
+ * @return The object to be pushed onto the {@code Digester} stack
* @throws Exception any exception thrown will be propagated upwards
*/
T createObject( Attributes attributes )
@@ -49,7 +49,7 @@ public interface ObjectCreationFactory<T>
/**
* Returns the {@link Digester} that was set by the {@link
FactoryCreateRule} upon initialization.
*
- * @return the {@link Digester} that was set by the {@link
FactoryCreateRule} upon initialization
+ * @return The {@link Digester} that was set by the {@link
FactoryCreateRule} upon initialization
*/
default Digester getDigester()
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexRules.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexRules.java
index b3d97b55..cdba9df2 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexRules.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RegexRules.java
@@ -79,7 +79,7 @@ public class RegexRules
/**
* Gets the current regex matching strategy.
*
- * @return the current regex matching strategy.
+ * @return The current regex matching strategy.
*/
public RegexMatcher getRegexMatcher()
{
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 16f82c51..0b4fb723 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
@@ -124,7 +124,7 @@ import org.xml.sax.Attributes;
/**
* Gets the Digester with which this Rule is associated.
*
- * @return the Digester with which this Rule is associated
+ * @return The Digester with which this Rule is associated
*/
public Digester getDigester()
{
@@ -134,7 +134,7 @@ import org.xml.sax.Attributes;
/**
* Gets the namespace URI for which this Rule is relevant, if any.
*
- * @return the namespace URI for which this Rule is relevant, if any
+ * @return The namespace URI for which this Rule is relevant, if any
*/
public String getNamespaceURI()
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RuleSet.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RuleSet.java
index 62daa245..b4f09a64 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/RuleSet.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/RuleSet.java
@@ -49,7 +49,7 @@ public interface RuleSet
/**
* Gets the namespace URI that will be applied to all Rule instances
created from this RuleSet.
*
- * @return the namespace URI that will be applied to all Rule instances
created from this RuleSet
+ * @return The namespace URI that will be applied to all Rule instances
created from this RuleSet
*/
String getNamespaceURI();
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 82c91000..af362f36 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
@@ -47,14 +47,14 @@ public interface Rules
/**
* Gets the Digester instance with which this Rules instance is associated.
*
- * @return the Digester instance with which this Rules instance is
associated
+ * @return The Digester instance with which this Rules instance is
associated
*/
Digester getDigester();
/**
* Gets the namespace URI that will be applied to all subsequently added
{@code Rule} objects.
*
- * @return the namespace URI that will be applied to all subsequently
added {@code Rule} objects.
+ * @return The namespace URI that will be applied to all subsequently
added {@code Rule} objects.
*/
String getNamespaceURI();
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
index c9fbb83e..fef8c376 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
@@ -52,7 +52,7 @@ public class SimpleRegexMatcher
/**
* Gets the {@code Log} implementation.
*
- * @return the {@code Log} implementation.
+ * @return The {@code Log} implementation.
*/
public Log getLog()
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/StackAction.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/StackAction.java
index 88d8b691..df8711f4 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/StackAction.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/StackAction.java
@@ -50,7 +50,7 @@ public interface StackAction
* @param stackName is the name of the stack from which the object has
been popped. Null is passed to indicate the
* default stack.
* @param o is the object that has just been popped.
- * @return the object to be returned to the called. Normally, parameter o
is returned but this method could return
+ * @return The object to be returned to the called. Normally, parameter o
is returned but this method could return
* an alternate object.
*/
<T> T onPop( Digester d, String stackName, T o );
@@ -64,7 +64,7 @@ public interface StackAction
* default stack.
* @param o is the object that has just been pushed. Calling peek on the
specified stack will return
* the same object.
- * @return the object to be pushed. Normally, parameter o is returned but
this method could return an alternate
+ * @return The object to be pushed. Normally, parameter o is returned but
this method could return an alternate
* object to be pushed instead (eg a proxy for the provided
object).
*/
<T> T onPush( Digester d, String stackName, T o );
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Substitutor.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Substitutor.java
index fc9a32a7..f6fd98f2 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/Substitutor.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/Substitutor.java
@@ -62,7 +62,7 @@ public abstract class Substitutor
* parses.
*
* @param bodyText the body text (as passed to {@code Digester})
- * @return the body text to be passed to the {@code Rule} implementations
+ * @return The body text to be passed to the {@code Rule} implementations
*/
public abstract String substitute( String bodyText );
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/reflect/MethodArgument.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/reflect/MethodArgument.java
index f975b054..8507cc00 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/reflect/MethodArgument.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/reflect/MethodArgument.java
@@ -107,7 +107,7 @@ public final class MethodArgument
/**
* Returns the method argument index.
*
- * @return the method argument index.
+ * @return The method argument index.
*/
public int getIndex()
{
@@ -117,7 +117,7 @@ public final class MethodArgument
/**
* Returns the method argument type.
*
- * @return the method argument type.
+ * @return The method argument type.
*/
public Class<?> getParameterType()
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/utils/AnnotationUtils.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/utils/AnnotationUtils.java
index f52713df..b2c16fc1 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/utils/AnnotationUtils.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/annotations/utils/AnnotationUtils.java
@@ -71,7 +71,7 @@ public class AnnotationUtils
* Extract the {@code pattern()} from annotation.
*
* @param annotation the annotation has to be introspected.
- * @return the annotation {@code pattern()}.
+ * @return The annotation {@code pattern()}.
*/
public static String getAnnotationPattern( final Annotation annotation )
{
@@ -87,7 +87,7 @@ public class AnnotationUtils
* Extract the Annotations array {@code value()} from annotation if
present, nul otherwise.
*
* @param annotation the annotation has to be introspected.
- * @return the annotation {@code value()} as Annotations array.
+ * @return The annotation {@code value()} as Annotations array.
*/
public static Annotation[] getAnnotationsArrayValue( final Annotation
annotation )
{
@@ -104,7 +104,7 @@ public class AnnotationUtils
* Extract the {@code value()} from annotation.
*
* @param annotation the annotation has to be introspected.
- * @return the annotation {@code value()}.
+ * @return The annotation {@code value()}.
*/
public static Object getAnnotationValue( final Annotation annotation )
{
@@ -132,7 +132,7 @@ public class AnnotationUtils
*
* @param annotation the annotation has to be introspected.
* @param method the method name to execute.
- * @return the annotation method value, null if any error occurs.
+ * @return The annotation method value, null if any error occurs.
*/
private static Object invokeAnnotationMethod( final Annotation annotation,
final String method )
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AbstractBackToLinkedRuleBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AbstractBackToLinkedRuleBuilder.java
index 4d3a6331..af0382a8 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AbstractBackToLinkedRuleBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AbstractBackToLinkedRuleBuilder.java
@@ -94,7 +94,7 @@ abstract class AbstractBackToLinkedRuleBuilder<R extends Rule>
/**
* Come back to the main {@link LinkedRuleBuilder}.
*
- * @return the main {@link LinkedRuleBuilder}
+ * @return The main {@link LinkedRuleBuilder}
*/
public final LinkedRuleBuilder then()
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AddAliasBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AddAliasBuilder.java
index fa1fea80..46fb9598 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AddAliasBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/AddAliasBuilder.java
@@ -45,7 +45,7 @@ public final class AddAliasBuilder<B>
* Allows expressing the input property name alias.
*
* @param propertyName The Java bean property to be assigned the value
- * @return the parent builder to chain.
+ * @return The parent builder to chain.
*/
public B forProperty( /*@Nullable*/ final String propertyName )
{
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 6e520406..862f2f61 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
@@ -220,7 +220,7 @@ public final class DigesterLoader
/**
* Gets the document locator associated with our parser.
*
- * @return the Locator supplied by the document parser
+ * @return The Locator supplied by the document parser
* @since 3.2
*/
public Locator getDocumentLocator()
@@ -231,7 +231,7 @@ public final class DigesterLoader
/**
* Gets the error handler for this Digester.
*
- * @return the error handler for this Digester.
+ * @return The error handler for this Digester.
* @since 3.2
*/
public ErrorHandler getErrorHandler()
@@ -242,7 +242,7 @@ public final class DigesterLoader
/**
* Returns the executor service used to run asynchronous parse method.
*
- * @return the executor service used to run asynchronous parse method
+ * @return The executor service used to run asynchronous parse method
* @since 3.1
*/
public ExecutorService getExecutorService()
@@ -253,7 +253,7 @@ public final class DigesterLoader
/**
* Gets the set of DTD URL registrations, keyed by public identifier.
*
- * @return the set of DTD URL registrations.
+ * @return The set of DTD URL registrations.
*/
public Map<String, URL> getRegistrations()
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/FromBinderRuleSet.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/FromBinderRuleSet.java
index 79668945..a920ba12 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/FromBinderRuleSet.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/FromBinderRuleSet.java
@@ -160,7 +160,7 @@ final class FromBinderRuleSet
* @param keyPattern the rule pattern
* @param namespaceURI the namespace URI (can be null)
* @param type the rule builder type the client is looking for
- * @return the rule builder of input type, if any
+ * @return The rule builder of input type, if any
*/
public <R extends Rule, RB extends AbstractBackToLinkedRuleBuilder<R>> RB
getProvider( final String keyPattern,
/* @Nullable */final String namespaceURI, final Class<RB> type )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/NestedPropertiesBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/NestedPropertiesBuilder.java
index 28f77b5e..edeab5f7 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/NestedPropertiesBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/NestedPropertiesBuilder.java
@@ -49,7 +49,7 @@ public final class NestedPropertiesBuilder
* Allows element2property mapping to be overridden.
*
* @param elementName The child XML element to match
- * @return the property alias builder
+ * @return The property alias builder
* @since 3.2
*/
public AddAliasBuilder<NestedPropertiesBuilder> addAlias( final String
elementName )
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/SetPropertiesBuilder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/SetPropertiesBuilder.java
index deadd8b6..51e4ad14 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/SetPropertiesBuilder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/binder/SetPropertiesBuilder.java
@@ -45,7 +45,7 @@ public final class SetPropertiesBuilder
* Add an additional attribute name to property name mapping.
*
* @param attributeName The attribute to match
- * @return the property alias builder
+ * @return The property alias builder
* @since 3.2
*/
public AddAliasBuilder<SetPropertiesBuilder> addAlias( final String
attributeName )
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 6fe98e80..5a652938 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
@@ -81,7 +81,7 @@ public class PluginContext
* <p>
* The return value is never null.
*
- * @return the namespace for the XML attribute which indicates which class
is to be plugged in.
+ * @return The namespace for the XML attribute which indicates which class
is to be plugged in.
*/
public String getPluginClassAttr()
{
@@ -93,7 +93,7 @@ public class PluginContext
* <p>
* May be null (in fact, normally will be).
*
- * @return the namespace for the XML attribute which indicates which class
is to be plugged in.
+ * @return The namespace for the XML attribute which indicates which class
is to be plugged in.
*/
public String getPluginClassAttrNs()
{
@@ -106,7 +106,7 @@ public class PluginContext
* <p>
* The return value is never null.
*
- * @return the namespace for the XML attribute which indicates which
previous plugin declaration should be used.
+ * @return The namespace for the XML attribute which indicates which
previous plugin declaration should be used.
*/
public String getPluginIdAttr()
{
@@ -119,7 +119,7 @@ public class PluginContext
* <p>
* May be null (in fact, normally will be).
*
- * @return the namespace for the XML attribute which indicates which
previous plugin declaration should be used.
+ * @return The namespace for the XML attribute which indicates which
previous plugin declaration should be used.
*/
public String getPluginIdAttrNs()
{
@@ -133,7 +133,7 @@ public class PluginContext
* <p>
* It is explicitly permitted for the caller to modify this list by
inserting or removing RuleFinder objects.
*
- * @return the list of RuleFinder objects
+ * @return The list of RuleFinder objects
*/
public List<RuleFinder> getRuleFinders()
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginException.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginException.java
index 745cea65..a0c03206 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginException.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/plugins/PluginException.java
@@ -60,7 +60,7 @@ public class PluginException
}
/**
- * @return the underlying exception that caused this to be thrown
+ * @return The underlying exception that caused this to be thrown
*/
@Override
public Throwable getCause()
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 1f1f5280..ac5af452 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
@@ -238,7 +238,7 @@ public class PluginRules
/**
* Gets the Digester instance with which this instance is associated.
*
- * @return the Digester instance with which this instance is associated.
+ * @return The Digester instance with which this instance is associated.
*/
@Override
public Digester getDigester()
@@ -249,7 +249,7 @@ public class PluginRules
/**
* Gets the namespace URI that will be applied to all subsequently added
{@code Rule} objects.
*
- * @return the namespace URI that will be applied to all subsequently
added {@code Rule} objects.
+ * @return The namespace URI that will be applied to all subsequently
added {@code Rule} objects.
*/
@Override
public String getNamespaceURI()
@@ -260,7 +260,7 @@ public class PluginRules
/**
* Gets the parent Rules object.
*
- * @return the parent Rules object.
+ * @return The parent Rules object.
*/
public Rules getParent()
{
@@ -270,7 +270,7 @@ public class PluginRules
/**
* See {@link PluginContext#getPluginClassAttr}.
*
- * @return the namespace for the XML attribute which indicates which class
is to be plugged in.
+ * @return The namespace for the XML attribute which indicates which class
is to be plugged in.
*/
public String getPluginClassAttr()
{
@@ -280,7 +280,7 @@ public class PluginRules
/**
* See {@link PluginContext#getPluginClassAttrNs}.
*
- * @return the namespace for the XML attribute which indicates which class
is to be plugged in.
+ * @return The namespace for the XML attribute which indicates which class
is to be plugged in.
*/
public String getPluginClassAttrNs()
{
@@ -290,7 +290,7 @@ public class PluginRules
/**
* See {@link PluginContext#getPluginIdAttr}.
*
- * @return the namespace for the XML attribute which indicates which
previous plugin declaration should be used.
+ * @return The namespace for the XML attribute which indicates which
previous plugin declaration should be used.
*/
public String getPluginIdAttr()
{
@@ -300,7 +300,7 @@ public class PluginRules
/**
* See {@link PluginContext#getPluginIdAttrNs}.
*
- * @return the namespace for the XML attribute which indicates which
previous plugin declaration should be used.
+ * @return The namespace for the XML attribute which indicates which
previous plugin declaration should be used.
*/
public String getPluginIdAttrNs()
{
@@ -320,7 +320,7 @@ public class PluginRules
/**
* See {@link PluginContext#getRuleFinders}.
*
- * @return the list of RuleFinder objects
+ * @return The list of RuleFinder objects
*/
public List<RuleFinder> getRuleFinders()
{
@@ -330,7 +330,7 @@ public class PluginRules
/**
* Gets the rules factory object (or null if one has not been specified).
*
- * @return the rules factory object.
+ * @return The rules factory object.
*/
public RulesFactory getRulesFactory()
{
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/substitution/VariableExpander.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/substitution/VariableExpander.java
index 1c4d29a3..6d53b879 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/substitution/VariableExpander.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/substitution/VariableExpander.java
@@ -36,7 +36,7 @@ public interface VariableExpander
* the string, then the input parameter is returned unaltered.
*
* @param param the string containing variables to be replaced.
- * @return the input string with any variables replaced by their
corresponding value.
+ * @return The input string with any variables replaced by their
corresponding value.
*/
String expand( String param );
diff --git
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/xmlrules/WithMemoryRulesBinder.java
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/xmlrules/WithMemoryRulesBinder.java
index 63307054..98381c26 100644
---
a/commons-digester3-core/src/main/java/org/apache/commons/digester3/xmlrules/WithMemoryRulesBinder.java
+++
b/commons-digester3-core/src/main/java/org/apache/commons/digester3/xmlrules/WithMemoryRulesBinder.java
@@ -76,7 +76,7 @@ final class WithMemoryRulesBinder
}
/**
- * @return the set of included files
+ * @return The set of included files
*/
public Set<String> getIncludedFiles()
{
@@ -84,7 +84,7 @@ final class WithMemoryRulesBinder
}
/**
- * @return the pattern stack
+ * @return The pattern stack
*/
public PatternStack getPatternStack()
{
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/ExtendedBaseRulesTestCase.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/ExtendedBaseRulesTestCase.java
index 62e68295..2bd0c936 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/ExtendedBaseRulesTestCase.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/ExtendedBaseRulesTestCase.java
@@ -37,7 +37,7 @@ public class ExtendedBaseRulesTestCase
* <p>
* This should be overridden by subclasses.
*
- * @return the matching rules to be tested.
+ * @return The matching rules to be tested.
*/
@Override
protected Rules createMatchingRulesForTest()
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 e55c4ecf..01ba9d2e 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
@@ -45,7 +45,7 @@ public class RulesBaseTestCase
* <p>
* This should be overridden by subclasses.
*
- * @return the matching rules to be tested.
+ * @return The matching rules to be tested.
*/
protected Rules createMatchingRulesForTest()
{
diff --git
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/binder/Entity.java
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/binder/Entity.java
index d2fb2f20..b315bbd3 100644
---
a/commons-digester3-core/src/test/java/org/apache/commons/digester3/binder/Entity.java
+++
b/commons-digester3-core/src/test/java/org/apache/commons/digester3/binder/Entity.java
@@ -28,7 +28,7 @@ public class Entity
private String author;
/**
- * @return the author.
+ * @return The author.
*/
public String getAuthor()
{
