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 452b3e7 Use Javadoc tags instead of HTML.
452b3e7 is described below
commit 452b3e796d6ddbfa1825ceffd0cb955b69289d7f
Author: Gary Gregory <ggreg...@rocketsoftware.com>
AuthorDate: Sun Oct 17 11:02:30 2021 -0400
Use Javadoc tags instead of HTML.
---
.../commons/digester3/AbstractMethodRule.java | 14 +-
.../digester3/AbstractObjectCreationFactory.java | 4 +-
.../commons/digester3/AbstractRulesImpl.java | 18 +--
.../apache/commons/digester3/CallMethodRule.java | 46 +++---
.../apache/commons/digester3/CallParamRule.java | 2 +-
.../org/apache/commons/digester3/Digester.java | 162 ++++++++++-----------
.../commons/digester3/ExtendedBaseRules.java | 22 +--
.../apache/commons/digester3/NodeCreateRule.java | 16 +-
.../commons/digester3/ObjectCreationFactory.java | 6 +-
.../commons/digester3/PathCallParamRule.java | 4 +-
.../commons/digester3/RecordedInvocation.java | 2 +-
.../org/apache/commons/digester3/RegexRules.java | 2 +-
.../java/org/apache/commons/digester3/Rule.java | 6 +-
.../java/org/apache/commons/digester3/RuleSet.java | 12 +-
.../org/apache/commons/digester3/RuleSetBase.java | 2 +-
.../java/org/apache/commons/digester3/Rules.java | 14 +-
.../org/apache/commons/digester3/RulesBase.java | 16 +-
.../commons/digester3/SetNestedPropertiesRule.java | 14 +-
.../org/apache/commons/digester3/SetNextRule.java | 8 +-
.../commons/digester3/SetPropertiesRule.java | 12 +-
.../org/apache/commons/digester3/SetRootRule.java | 10 +-
.../org/apache/commons/digester3/SetTopRule.java | 8 +-
.../commons/digester3/SimpleRegexMatcher.java | 12 +-
.../org/apache/commons/digester3/Substitutor.java | 16 +-
.../digester3/WithDefaultsRulesWrapper.java | 10 +-
.../annotations/handlers/package-info.java | 2 +-
.../digester3/annotations/package-info.java | 4 +-
.../annotations/reflect/package-info.java | 2 +-
.../AbstractNamespaceURIBasedRulesModule.java | 2 +-
.../digester3/binder/CallMethodBuilder.java | 2 +-
.../commons/digester3/binder/DigesterLoader.java | 26 ++--
.../digester3/binder/NodeCreateRuleProvider.java | 6 +-
.../org/apache/commons/digester3/package-info.java | 6 +-
.../commons/digester3/plugins/PluginRules.java | 8 +-
.../commons/digester3/plugins/package-info.java | 2 +-
.../plugins/strategies/FinderFromClass.java | 2 +-
.../plugins/strategies/FinderFromDfltClass.java | 2 +-
.../plugins/strategies/FinderFromDfltMethod.java | 2 +-
.../plugins/strategies/FinderFromMethod.java | 2 +-
.../plugins/strategies/LoaderFromClass.java | 2 +-
.../digester3/plugins/strategies/package-info.java | 2 +-
.../substitution/CompoundSubstitutor.java | 10 +-
.../digester3/substitution/package-info.java | 2 +-
.../digester3/BeanPropertySetterRuleTestCase.java | 2 +-
.../commons/digester3/CallMethodRuleTestCase.java | 2 +-
.../apache/commons/digester3/DigesterTestCase.java | 2 +-
.../commons/digester3/NodeCreateRuleTestCase.java | 2 +-
.../commons/digester3/ObjectParamRuleTestCase.java | 2 +-
.../org/apache/commons/digester3/RuleTestCase.java | 10 +-
.../digester3/SetNestedPropertiesRuleTestCase.java | 2 +-
.../digester3/SetPropertiesRuleTestCase.java | 2 +-
.../commons/digester3/SetPropertyRuleTestCase.java | 2 +-
.../org/apache/commons/digester3/TestRule.java | 2 +-
.../org/apache/commons/digester3/URLTestCase.java | 4 +-
.../examples/plugins/pipeline/Pipeline.java | 2 +-
.../org/apache/commons/digester3/rss/Channel.java | 6 +-
.../apache/commons/digester3/rss/RSSDigester.java | 16 +-
57 files changed, 289 insertions(+), 289 deletions(-)
diff --git
a/core/src/main/java/org/apache/commons/digester3/AbstractMethodRule.java
b/core/src/main/java/org/apache/commons/digester3/AbstractMethodRule.java
index 26b1c48..6a41c29 100644
--- a/core/src/main/java/org/apache/commons/digester3/AbstractMethodRule.java
+++ b/core/src/main/java/org/apache/commons/digester3/AbstractMethodRule.java
@@ -77,8 +77,8 @@ public abstract class AbstractMethodRule
*
* @param methodName Method name of the parent method to call
* @param paramType Java class of the parent method's argument (if you
wish to use a primitive type, specify the
- * corresonding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresonding Java wrapper class instead, such as {@code
java.lang.Boolean} for a
+ * {@code boolean} parameter)
*/
public AbstractMethodRule( final String methodName, final Class<?>
paramType )
{
@@ -91,8 +91,8 @@ public abstract class AbstractMethodRule
*
* @param methodName Method name of the parent method to call
* @param paramTypeName Java class of the parent method's argument (if you
wish to use a primitive type, specify the
- * corresonding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresonding Java wrapper class instead, such as {@code
java.lang.Boolean} for a
+ * {@code boolean} parameter)
*/
public AbstractMethodRule( final String methodName, final String
paramTypeName )
{
@@ -105,13 +105,13 @@ public abstract class AbstractMethodRule
* Is exact matching being used.
* </p>
* <p>
- * This rule uses <code>org.apache.commons.beanutils.MethodUtils</code> to
introspect the relevent objects so that
- * the right method can be called. Originally,
<code>MethodUtils.invokeExactMethod</code> was used. This matches
+ * This rule uses {@code org.apache.commons.beanutils.MethodUtils} to
introspect the relevent objects so that
+ * the right method can be called. Originally, {@code
MethodUtils.invokeExactMethod} was used. This matches
* methods very strictly and so may not find a matching method when one
exists. This is still the behavior when
* exact matching is enabled.
* </p>
* <p>
- * When exact matching is disabled, <code>MethodUtils.invokeMethod</code>
is used. This method finds more methods
+ * When exact matching is disabled, {@code MethodUtils.invokeMethod} is
used. This method finds more methods
* but is less precise when there are several methods with correct
signatures. So, if you want to choose an exact
* signature you might need to enable this property.
* </p>
diff --git
a/core/src/main/java/org/apache/commons/digester3/AbstractObjectCreationFactory.java
b/core/src/main/java/org/apache/commons/digester3/AbstractObjectCreationFactory.java
index f903318..f64aa73 100644
---
a/core/src/main/java/org/apache/commons/digester3/AbstractObjectCreationFactory.java
+++
b/core/src/main/java/org/apache/commons/digester3/AbstractObjectCreationFactory.java
@@ -22,7 +22,7 @@ package org.apache.commons.digester3;
import org.xml.sax.Attributes;
/**
- * Abstract base class for <code>ObjectCreationFactory</code> implementations.
+ * Abstract base class for {@code ObjectCreationFactory} implementations.
*
* @param <T> The object type will be instantiate by this factory.
*/
@@ -33,7 +33,7 @@ public abstract class AbstractObjectCreationFactory<T>
// ----------------------------------------------------- Instance Variables
/**
- * The associated <code>Digester</code> instance that was set up by {@link
FactoryCreateRule} upon initialization.
+ * The associated {@code Digester} instance that was set up by {@link
FactoryCreateRule} upon initialization.
*/
private Digester digester = null;
diff --git
a/core/src/main/java/org/apache/commons/digester3/AbstractRulesImpl.java
b/core/src/main/java/org/apache/commons/digester3/AbstractRulesImpl.java
index 4f7b154..543115e 100644
--- a/core/src/main/java/org/apache/commons/digester3/AbstractRulesImpl.java
+++ b/core/src/main/java/org/apache/commons/digester3/AbstractRulesImpl.java
@@ -22,14 +22,14 @@ package org.apache.commons.digester3;
/**
* <p>
- * <code>AbstractRuleImpl</code> provides basic services for
<code>Rules</code> implementations. Extending this class
- * should make it easier to create a <code>Rules</code> implementation.
+ * {@code AbstractRuleImpl} provides basic services for {@code Rules}
implementations. Extending this class
+ * should make it easier to create a {@code Rules} implementation.
* </p>
* <p>
- * <code>AbstractRuleImpl</code> manages the <code>Digester</code> and
<code>namespaceUri</code> properties. If the
- * subclass overrides {@link #registerRule} (rather than {@link #add}), then
the <code>Digester</code> and
- * <code>namespaceURI</code> of the <code>Rule</code> will be set correctly
before it is passed to
- * <code>registerRule</code>. The subclass can then perform whatever it needs
to do to register the rule.
+ * {@code AbstractRuleImpl} manages the {@code Digester} and {@code
namespaceUri} properties. If the
+ * subclass overrides {@link #registerRule} (rather than {@link #add}), then
the {@code Digester} and
+ * {@code namespaceURI} of the {@code Rule} will be set correctly before it is
passed to
+ * {@code registerRule}. The subclass can then perform whatever it needs to do
to register the rule.
* </p>
*
* @since 1.5
@@ -40,10 +40,10 @@ public abstract class AbstractRulesImpl
// ------------------------------------------------------------- Fields
- /** Digester using this <code>Rules</code> implementation */
+ /** Digester using this {@code Rules} implementation */
private Digester digester;
- /** Namespace uri to assoicate with subsequent <code>Rule</code>'s */
+ /** Namespace uri to assoicate with subsequent {@code Rule}'s */
private String namespaceURI;
// ------------------------------------------------------------- Properties
@@ -107,7 +107,7 @@ public abstract class AbstractRulesImpl
}
/**
- * Register rule at given pattern. The the Digester and namespaceURI
properties of the given <code>Rule</code> can
+ * Register rule at given pattern. The the Digester and namespaceURI
properties of the given {@code Rule} can
* be assumed to have been set properly before this method is called.
*
* @param pattern Nesting pattern to be matched for this Rule
diff --git
a/core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
b/core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
index 0eee07f..4534d40 100644
--- a/core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
+++ b/core/src/main/java/org/apache/commons/digester3/CallMethodRule.java
@@ -33,20 +33,20 @@ import org.xml.sax.SAXException;
/**
* <p>
* Rule implementation that calls a method on an object on the stack (normally
the top/parent object), passing arguments
- * collected from subsequent <code>CallParamRule</code> rules or from the body
of this element.
+ * collected from subsequent {@code CallParamRule} rules or from the body of
this element.
* </p>
* <p>
* By using {@link #CallMethodRule(String methodName)} a method call can be
made to a method which accepts no arguments.
* </p>
* <p>
- * Incompatible method parameter types are converted using
<code>org.apache.commons.beanutils.ConvertUtils</code>.
+ * Incompatible method parameter types are converted using {@code
org.apache.commons.beanutils.ConvertUtils}.
* </p>
* <p>
* This rule now uses {@link
org.apache.commons.beanutils.MethodUtils#invokeMethod} by default.
* This increases the kinds of methods successfully and allows primitives to
be matched by passing in wrapper classes.
* There are rare cases when {@link
org.apache.commons.beanutils.MethodUtils#invokeExactMethod} (the old default) is
* required. This method is much stricter in it's reflection.
- * Setting the <code>UseExactMatch</code> to true reverts to the use of this
method.
+ * Setting the {@code UseExactMatch} to true reverts to the use of this method.
* </p>
* <p>
* Note that the target method is invoked when the <i>end</i> of the tag the
CallMethodRule fired on is encountered,
@@ -152,15 +152,15 @@ public class CallMethodRule
}
/**
- * Construct a "call method" rule with the specified method name and
parameter types. If <code>paramCount</code> is
+ * Construct a "call method" rule with the specified method name and
parameter types. If {@code paramCount} is
* set to zero the rule will use the body of this element as the single
argument of the method, unless
- * <code>paramTypes</code> is null or empty, in this case the rule will
call the specified method with no arguments.
+ * {@code paramTypes} is null or empty, in this case the rule will call
the specified method with no arguments.
*
* @param methodName Method name of the parent method to call
* @param paramCount The number of parameters to collect, or zero for a
single argument from the body of ths element
* @param paramTypes The Java class names of the arguments (if you wish to
use a primitive type, specify the
- * corresonding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresonding Java wrapper class instead, such as {@code
java.lang.Boolean} for a
+ * {@code boolean} parameter)
*/
public CallMethodRule( final String methodName, final int paramCount,
final String[] paramTypes )
{
@@ -168,9 +168,9 @@ public class CallMethodRule
}
/**
- * Construct a "call method" rule with the specified method name and
parameter types. If <code>paramCount</code> is
+ * Construct a "call method" rule with the specified method name and
parameter types. If {@code paramCount} is
* set to zero the rule will use the body of this element as the single
argument of the method, unless
- * <code>paramTypes</code> is null or empty, in this case the rule will
call the specified method with no arguments.
+ * {@code paramTypes} is null or empty, in this case the rule will call
the specified method with no arguments.
*
* @param targetOffset location of the target object. Positive numbers are
relative to the top of the digester
* object stack. Negative numbers are relative to the bottom of
the stack. Zero implies the top object on
@@ -178,8 +178,8 @@ public class CallMethodRule
* @param methodName Method name of the parent method to call
* @param paramCount The number of parameters to collect, or zero for a
single argument from the body of the element
* @param paramTypes The Java class names of the arguments (if you wish to
use a primitive type, specify the
- * corresponding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresponding Java wrapper class instead, such as {@code
java.lang.Boolean} for a
+ * {@code boolean} parameter)
*/
public CallMethodRule( final int targetOffset, final String methodName,
final int paramCount, final String[] paramTypes )
{
@@ -200,15 +200,15 @@ public class CallMethodRule
}
/**
- * Construct a "call method" rule with the specified method name and
parameter types. If <code>paramCount</code> is
+ * Construct a "call method" rule with the specified method name and
parameter types. If {@code paramCount} is
* set to zero the rule will use the body of this element as the single
argument of the method, unless
- * <code>paramTypes</code> is null or empty, in this case the rule will
call the specified method with no arguments.
+ * {@code paramTypes} is null or empty, in this case the rule will call
the specified method with no arguments.
*
* @param methodName Method name of the parent method to call
* @param paramCount The number of parameters to collect, or zero for a
single argument from the body of the element
* @param paramTypes The Java classes that represent the parameter types
of the method arguments (if you wish to use
* a primitive type, specify the corresponding Java wrapper
class instead, such as
- * <code>java.lang.Boolean.TYPE</code> for a
<code>boolean</code> parameter)
+ * {@code java.lang.Boolean.TYPE} for a {@code boolean}
parameter)
*/
public CallMethodRule( final String methodName, final int paramCount,
final Class<?> paramTypes[] )
{
@@ -216,9 +216,9 @@ public class CallMethodRule
}
/**
- * Construct a "call method" rule with the specified method name and
parameter types. If <code>paramCount</code> is
+ * Construct a "call method" rule with the specified method name and
parameter types. If {@code paramCount} is
* set to zero the rule will use the body of this element as the single
argument of the method, unless
- * <code>paramTypes</code> is null or empty, in this case the rule will
call the specified method with no arguments.
+ * {@code paramTypes} is null or empty, in this case the rule will call
the specified method with no arguments.
*
* @param targetOffset location of the target object. Positive numbers are
relative to the top of the digester
* object stack. Negative numbers are relative to the bottom of
the stack. Zero implies the top object on
@@ -227,7 +227,7 @@ public class CallMethodRule
* @param paramCount The number of parameters to collect, or zero for a
single argument from the body of the element
* @param paramTypes The Java classes that represent the parameter types
of the method arguments (if you wish to use
* a primitive type, specify the corresponding Java wrapper
class instead, such as
- * <code>java.lang.Boolean.TYPE</code> for a
<code>boolean</code> parameter)
+ * {@code java.lang.Boolean.TYPE} for a {@code boolean}
parameter)
*/
public CallMethodRule( final int targetOffset, final String methodName,
final int paramCount, final Class<?>[] paramTypes )
{
@@ -264,7 +264,7 @@ public class CallMethodRule
protected String methodName = null;
/**
- * The number of parameters to collect from <code>MethodParam</code>
rules. If this value is zero, a single
+ * The number of parameters to collect from {@code MethodParam} rules. If
this value is zero, a single
* parameter will be collected from the body of this element.
*/
protected int paramCount = 0;
@@ -281,16 +281,16 @@ public class CallMethodRule
private String[] paramClassNames = null;
/**
- * Should <code>MethodUtils.invokeExactMethod</code> be used for
reflection.
+ * Should {@code MethodUtils.invokeExactMethod} be used for reflection.
*/
private boolean useExactMatch = false;
// --------------------------------------------------------- Public Methods
/**
- * Should <code>MethodUtils.invokeExactMethod</code> be used for the
reflection.
+ * Should {@code MethodUtils.invokeExactMethod} be used for the reflection.
*
- * @return true, if <code>MethodUtils.invokeExactMethod</code> Should be
used for the reflection,
+ * @return true, if {@code MethodUtils.invokeExactMethod} Should be used
for the reflection,
* false otherwise
*/
public boolean getUseExactMatch()
@@ -299,9 +299,9 @@ public class CallMethodRule
}
/**
- * Set whether <code>MethodUtils.invokeExactMethod</code> should be used
for the reflection.
+ * Set whether {@code MethodUtils.invokeExactMethod} should be used for
the reflection.
*
- * @param useExactMatch The <code>MethodUtils.invokeExactMethod</code> flag
+ * @param useExactMatch The {@code MethodUtils.invokeExactMethod} flag
*/
public void setUseExactMatch( final boolean useExactMatch )
{
diff --git a/core/src/main/java/org/apache/commons/digester3/CallParamRule.java
b/core/src/main/java/org/apache/commons/digester3/CallParamRule.java
index b358352..eb19063 100644
--- a/core/src/main/java/org/apache/commons/digester3/CallParamRule.java
+++ b/core/src/main/java/org/apache/commons/digester3/CallParamRule.java
@@ -34,7 +34,7 @@ import org.xml.sax.Attributes;
* <li>from an attribute of the current element See {@link #CallParamRule(int
paramIndex, String attributeName)}
* <li>from current the element body See {@link #CallParamRule(int paramIndex)}
* <li>from the top object on the stack. See {@link #CallParamRule(int
paramIndex, boolean fromStack)}
- * <li>the current path being processed (separate <code>Rule</code>). See
{@link PathCallParamRule}
+ * <li>the current path being processed (separate {@code Rule}). See {@link
PathCallParamRule}
* </ul>
* </p>
*/
diff --git a/core/src/main/java/org/apache/commons/digester3/Digester.java
b/core/src/main/java/org/apache/commons/digester3/Digester.java
index d8c6fd3..fa097e6 100644
--- a/core/src/main/java/org/apache/commons/digester3/Digester.java
+++ b/core/src/main/java/org/apache/commons/digester3/Digester.java
@@ -71,7 +71,7 @@ import org.xml.sax.helpers.DefaultHandler;
* </p>
* <p>
* <strong>IMPLEMENTATION NOTE</strong> - A single Digester instance may only
be used within the context of a single
- * thread at a time, and a call to <code>parse()</code> must be completed
before another can be initiated even from the
+ * thread at a time, and a call to {@code parse()} must be completed before
another can be initiated even from the
* same thread.
* </p>
* <p>
@@ -88,7 +88,7 @@ import org.xml.sax.helpers.DefaultHandler;
* make this class work with the legacy XML schema support.
* </p>
* <p>
- * This package was inspired by the <code>XmlMapper</code> class that was part
of Tomcat 3.0 and 3.1, but is organized
+ * This package was inspired by the {@code XmlMapper} class that was part of
Tomcat 3.0 and 3.1, but is organized
* somewhat differently.
* </p>
*/
@@ -153,7 +153,7 @@ public class Digester
/**
* The class loader to use for instantiating application objects. If not
specified, the context class loader, or the
- * class loader used to load Digester itself, is used, based on the value
of the <code>useContextClassLoader</code>
+ * class loader used to load Digester itself, is used, based on the value
of the {@code useContextClassLoader}
* variable.
*/
private ClassLoader classLoader = null;
@@ -245,7 +245,7 @@ public class Digester
private Object root = null;
/**
- * The <code>Rules</code> implementation containing our collection of
<code>Rule</code> instances and associated
+ * The {@code Rules} implementation containing our collection of {@code
Rule} instances and associated
* matching policy. If not established before the first rule is added, a
default implementation will be provided.
*/
private Rules rules = null;
@@ -264,7 +264,7 @@ public class Digester
/**
* Do we want to use the Context ClassLoader when loading classes for
instantiating new objects. Default is
- * <code>true</code>.
+ * {@code true}.
*/
private boolean useContextClassLoader = true;
@@ -314,7 +314,7 @@ public class Digester
// ------------------------------------------------------------- Properties
/**
- * Return the currently mapped namespace URI for the specified prefix, if
any; otherwise return <code>null</code>.
+ * Return the currently mapped namespace URI for the specified prefix, if
any; otherwise return {@code null}.
* These mappings come and go dynamically as the document is parsed.
*
* @param prefix Prefix to look up
@@ -341,8 +341,8 @@ public class Digester
* Return the class loader to be used for instantiating application
objects when required. This is determined based
* upon the following rules:
* <ul>
- * <li>The class loader set by <code>setClassLoader()</code>, if any</li>
- * <li>The thread context class loader, if it exists and the
<code>useContextClassLoader</code> property is set to
+ * <li>The class loader set by {@code setClassLoader()}, if any</li>
+ * <li>The thread context class loader, if it exists and the {@code
useContextClassLoader} property is set to
* true</li>
* <li>The class loader used to load the Digester class itself.
* </ul>
@@ -369,7 +369,7 @@ public class Digester
/**
* Set the class loader to be used for instantiating application objects
when required.
*
- * @param classLoader The new class loader to use, or <code>null</code> to
revert to the standard rules
+ * @param classLoader The new class loader to use, or {@code null} to
revert to the standard rules
*/
public void setClassLoader( final ClassLoader classLoader )
{
@@ -442,12 +442,12 @@ public class Digester
/**
* Returns a flag indicating whether the requested feature is supported by
the underlying implementation of
- * <code>org.xml.sax.XMLReader</code>. See <a
href="http://www.saxproject.org";>the saxproject website</a> for
+ * {@code org.xml.sax.XMLReader}. See <a
href="http://www.saxproject.org";>the saxproject website</a> for
* information about the standard SAX2 feature flags.
*
* @param feature Name of the feature to inquire about
* @return true, if the requested feature is supported by the underlying
implementation of
- * <code>org.xml.sax.XMLReader</code>, false otherwise
+ * {@code org.xml.sax.XMLReader}, false otherwise
* @throws ParserConfigurationException if a parser configuration error
occurs
* @throws SAXNotRecognizedException if the property name is not recognized
* @throws SAXNotSupportedException if the property name is recognized but
not supported
@@ -460,9 +460,9 @@ public class Digester
/**
* Sets a flag indicating whether the requested feature is supported by
the underlying implementation of
- * <code>org.xml.sax.XMLReader</code>. See <a
href="http://www.saxproject.org";>the saxproject website</a> for
+ * {@code org.xml.sax.XMLReader}. See <a
href="http://www.saxproject.org";>the saxproject website</a> for
* information about the standard SAX2 feature flags. In order to be
effective, this method must be called
- * <strong>before</strong> the <code>getParser()</code> method is called
for the first time, either directly or
+ * <strong>before</strong> the {@code getParser()} method is called for
the first time, either directly or
* indirectly.
*
* @param feature Name of the feature to set the status for
@@ -608,9 +608,9 @@ public class Digester
}
/**
- * Return the namespace URI that will be applied to all subsequently added
<code>Rule</code> 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</code> objects.
+ * @return the namespace URI that will be applied to all subsequently
added {@code Rule} objects.
*/
public String getRuleNamespaceURI()
{
@@ -618,9 +618,9 @@ public class Digester
}
/**
- * Set the namespace URI that will be applied to all subsequently added
<code>Rule</code> objects.
+ * Set 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</code> for
+ * @param ruleNamespaceURI Namespace URI that must match on all
subsequently added rules, or {@code null} for
* matching regardless of the current namespace URI
*/
public void setRuleNamespaceURI( final String ruleNamespaceURI )
@@ -631,7 +631,7 @@ public class Digester
/**
* Return the SAXParser we will use to parse the input stream.
*
- * If there is a problem creating the parser, return <code>null</code>.
+ * If there is a problem creating the parser, return {@code null}.
*
* @return the SAXParser we will use to parse the input stream
*/
@@ -658,13 +658,13 @@ public class Digester
}
/**
- * Return the current value of the specified property for the underlying
<code>XMLReader</code> implementation.
+ * Return 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 retrieved
- * @return the current value of the specified property for the underlying
<code>XMLReader</code> 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
*/
@@ -675,7 +675,7 @@ public class Digester
}
/**
- * Set the current value of the specified property for the underlying
<code>XMLReader</code> implementation. See <a
+ * Set 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
@@ -690,10 +690,10 @@ public class Digester
}
/**
- * Return the <code>Rules</code> implementation object containing our
rules collection and associated matching
+ * Return 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</code> implementation object.
+ * @return the {@code Rules} implementation object.
*/
public Rules getRules()
{
@@ -706,7 +706,7 @@ public class Digester
}
/**
- * Set the <code>Rules</code> implementation object containing our rules
collection and associated matching policy.
+ * Set the {@code Rules} implementation object containing our rules
collection and associated matching policy.
*
* @param rules New Rules implementation
*/
@@ -750,7 +750,7 @@ public class Digester
/**
* Determine whether to use the Context ClassLoader (the one found by
calling
- * <code>Thread.currentThread().getContextClassLoader()</code>) to
resolve/load classes that are defined in various
+ * {@code Thread.currentThread().getContextClassLoader()}) to resolve/load
classes that are defined in various
* rules. If not using Context ClassLoader, then the class-loading
defaults to using the calling-class' ClassLoader.
*
* @param use determines whether to use Context ClassLoader.
@@ -771,7 +771,7 @@ public class Digester
}
/**
- * Set the validating parser flag. This must be called before
<code>parse()</code> is called the first time.
+ * Set 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
@@ -826,9 +826,9 @@ public class Digester
}
/**
- * Gets the <code>Substitutor</code> used to convert attributes and body
text.
+ * Gets the {@code Substitutor} used to convert attributes and body text.
*
- * @return the <code>Substitutor</code> 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()
@@ -837,7 +837,7 @@ public class Digester
}
/**
- * Sets the <code>Substitutor</code> to be used to convert attributes and
body text.
+ * Sets the {@code Substitutor} to be used to convert attributes and body
text.
*
* @param substitutor the Substitutor to be used to convert attributes and
body text or null if not substitution of
* these values is to be performed.
@@ -1427,10 +1427,10 @@ public class Digester
// ----------------------------------------------- EntityResolver Methods
/**
- * Set the <code>EntityResolver</code> used by SAX when resolving public
id and system id. This must be called
- * before the first call to <code>parse()</code>.
+ * Set 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</code> interface.
+ * @param entityResolver a class that implement the {@code EntityResolver}
interface.
*/
public void setEntityResolver( final EntityResolver entityResolver )
{
@@ -1871,19 +1871,19 @@ public class Digester
/**
* <p>
* Register the specified DTD URL for the specified public identifier.
This must be called before the first call to
- * <code>parse()</code>.
+ * {@code parse()}.
* </p>
* <p>
- * <code>Digester</code> contains an internal <code>EntityResolver</code>
implementation. This maps
- * <code>PUBLICID</code>'s to URLs (from which the resource will be
loaded). A common use case for this method is to
+ * {@code Digester} contains an internal {@code EntityResolver}
implementation. This maps
+ * {@code PUBLICID}'s to URLs (from which the resource will be loaded). A
common use case for this method is to
* register local URLs (possibly computed at runtime by a classloader) for
DTDs. This allows the performance
- * advantage of using a local version without having to ensure every
<code>SYSTEM</code> URI on every processed xml
+ * advantage of using a local version without having to ensure every
{@code SYSTEM} URI on every processed xml
* document is local. This implementation provides only basic
functionality. If more sophisticated features are
* required, using {@link #setEntityResolver} to set a custom resolver is
recommended.
* </p>
* <p>
- * <strong>Note:</strong> This method will have no effect when a custom
<code>EntityResolver</code> has been set.
- * (Setting a custom <code>EntityResolver</code> overrides the internal
implementation.)
+ * <strong>Note:</strong> This method will have no effect when a custom
{@code EntityResolver} has been set.
+ * (Setting a custom {@code EntityResolver} overrides the internal
implementation.)
* </p>
*
* @param publicId Public identifier of the DTD to be resolved
@@ -1937,7 +1937,7 @@ public class Digester
/**
* <p>
- * <code>List</code> of <code>InputSource</code> instances created by a
<code>createInputSourceFromURL()</code>
+ * {@code List} of {@code InputSource} instances created by a {@code
createInputSourceFromURL()}
* method call. These represent open input streams that need to be closed
to avoid resource leaks, as well as
* potentially locked JAR files on Windows.
* </p>
@@ -1947,7 +1947,7 @@ public class Digester
/**
* Given a URL, return an InputSource that reads from that URL.
* <p>
- * Ideally this function would not be needed and code could just use
<code>new InputSource(entityURL)</code>.
+ * Ideally this function would not be needed and code could just use
{@code new InputSource(entityURL)}.
* Unfortunately it appears that when the entityURL points to a file
within a jar archive a caching mechanism inside
* the InputSource implementation causes a file-handle to the jar file to
remain open. On Windows systems this then
* causes the jar archive file to be locked on disk ("in use") which makes
it impossible to delete the jar file -
@@ -1991,10 +1991,10 @@ public class Digester
/**
* <p>
- * Convenience method that creates an <code>InputSource</code> from the
string version of a URL.
+ * Convenience method that creates an {@code InputSource} from the string
version of a URL.
* </p>
*
- * @param url URL for which to create an <code>InputSource</code>
+ * @param url URL for which to create an {@code InputSource}
* @return The InputSource that reads from the input URL
* @throws IOException if any error occurs while reading the input URL
* @since 1.8
@@ -2009,7 +2009,7 @@ public class Digester
/**
* <p>
- * Register a new Rule matching the specified pattern. This method sets
the <code>Digester</code> property on the
+ * Register a new Rule matching the specified pattern. This method sets
the {@code Digester} property on the
* rule.
* </p>
*
@@ -2096,8 +2096,8 @@ public class Digester
}
/**
- * Add an "call method" rule for the specified parameters. If
<code>paramCount</code> is set to zero the rule will
- * use the body of the matched element as the single argument of the
method, unless <code>paramTypes</code> is null
+ * Add an "call method" rule for the specified parameters. If {@code
paramCount} is set to zero the rule will
+ * use the body of the matched element as the single argument of the
method, unless {@code paramTypes} is null
* or empty, in this case the rule will call the specified method with no
arguments.
*
* @param pattern Element matching pattern
@@ -2105,7 +2105,7 @@ public class Digester
* @param paramCount Number of expected parameters (or zero for a single
parameter from the body of this element)
* @param paramTypes Set of Java class names for the types of the expected
parameters (if you wish to use a
* primitive type, specify the corresonding Java wrapper class
instead, such as
- * <code>java.lang.Boolean</code> for a <code>boolean</code>
parameter)
+ * {@code java.lang.Boolean} for a {@code boolean} parameter)
* @see CallMethodRule
*/
public void addCallMethod( final String pattern, final String methodName,
final int paramCount, final String paramTypes[] )
@@ -2114,16 +2114,16 @@ public class Digester
}
/**
- * Add an "call method" rule for the specified parameters. If
<code>paramCount</code> is set to zero the rule will
- * use the body of the matched element as the single argument of the
method, unless <code>paramTypes</code> is null
+ * Add an "call method" rule for the specified parameters. If {@code
paramCount} is set to zero the rule will
+ * use the body of the matched element as the single argument of the
method, unless {@code paramTypes} is null
* or empty, in this case the rule will call the specified method with no
arguments.
*
* @param pattern Element matching pattern
* @param methodName Method name to be called
* @param paramCount Number of expected parameters (or zero for a single
parameter from the body of this element)
* @param paramTypes The Java class names of the arguments (if you wish to
use a primitive type, specify the
- * corresonding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresonding Java wrapper class instead, such as {@code
java.lang.Boolean} for a
+ * {@code boolean} parameter)
* @see CallMethodRule
*/
public void addCallMethod( final String pattern, final String methodName,
final int paramCount, final Class<?> paramTypes[] )
@@ -2186,7 +2186,7 @@ public class Digester
}
/**
- * Add a "call parameter" rule that sets a parameter from the current
<code>Digester</code> matching path. This is
+ * Add a "call parameter" rule that sets a parameter from the current
{@code Digester} matching path. This is
* sometimes useful when using rules that support wildcards.
*
* @param pattern the pattern that this rule should match
@@ -2250,7 +2250,7 @@ public class Digester
*
* @param pattern Element matching pattern
* @param className Java class name of the object creation factory class
- * @param attributeName Attribute name which, if present, overrides the
value specified by <code>className</code>
+ * @param attributeName Attribute name which, if present, overrides the
value specified by {@code className}
* @see FactoryCreateRule
*/
public void addFactoryCreate( final String pattern, final String
className, final String attributeName )
@@ -2264,7 +2264,7 @@ public class Digester
*
* @param pattern Element matching pattern
* @param clazz Java class of the object creation factory class
- * @param attributeName Attribute name which, if present, overrides the
value specified by <code>className</code>
+ * @param attributeName Attribute name which, if present, overrides the
value specified by {@code className}
* @see FactoryCreateRule
*/
public void addFactoryCreate( final String pattern, final Class<? extends
ObjectCreationFactory<?>> clazz,
@@ -2291,7 +2291,7 @@ public class Digester
*
* @param pattern Element matching pattern
* @param className Java class name of the object creation factory class
- * @param ignoreCreateExceptions when <code>true</code> any exceptions
thrown during object creation will be
+ * @param ignoreCreateExceptions when {@code true} any exceptions thrown
during object creation will be
* ignored.
* @see FactoryCreateRule
*/
@@ -2305,7 +2305,7 @@ public class Digester
*
* @param pattern Element matching pattern
* @param clazz Java class of the object creation factory class
- * @param ignoreCreateExceptions when <code>true</code> any exceptions
thrown during object creation will be
+ * @param ignoreCreateExceptions when {@code true} any exceptions thrown
during object creation will be
* ignored.
* @see FactoryCreateRule
*/
@@ -2320,8 +2320,8 @@ public class Digester
*
* @param pattern Element matching pattern
* @param className Java class name of the object creation factory class
- * @param attributeName Attribute name which, if present, overrides the
value specified by <code>className</code>
- * @param ignoreCreateExceptions when <code>true</code> any exceptions
thrown during object creation will be
+ * @param attributeName Attribute name which, if present, overrides the
value specified by {@code className}
+ * @param ignoreCreateExceptions when {@code true} any exceptions thrown
during object creation will be
* ignored.
* @see FactoryCreateRule
*/
@@ -2336,8 +2336,8 @@ public class Digester
*
* @param pattern Element matching pattern
* @param clazz Java class of the object creation factory class
- * @param attributeName Attribute name which, if present, overrides the
value specified by <code>className</code>
- * @param ignoreCreateExceptions when <code>true</code> any exceptions
thrown during object creation will be
+ * @param attributeName Attribute name which, if present, overrides the
value specified by {@code className}
+ * @param ignoreCreateExceptions when {@code true} any exceptions thrown
during object creation will be
* ignored.
* @see FactoryCreateRule
*/
@@ -2352,7 +2352,7 @@ public class Digester
*
* @param pattern Element matching pattern
* @param creationFactory Previously instantiated ObjectCreationFactory to
be utilized
- * @param ignoreCreateExceptions when <code>true</code> any exceptions
thrown during object creation will be
+ * @param ignoreCreateExceptions when {@code true} any exceptions thrown
during object creation will be
* ignored.
* @see FactoryCreateRule
*/
@@ -2468,8 +2468,8 @@ public class Digester
* @param pattern Element matching pattern
* @param methodName Method name to call on the parent element
* @param paramType Java class name of the expected parameter type (if you
wish to use a primitive type, specify the
- * corresonding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresonding Java wrapper class instead, such as {@code
java.lang.Boolean} for a
+ * {@code boolean} parameter)
* @see SetNextRule
*/
public void addSetNext( final String pattern, final String methodName,
final String paramType )
@@ -2572,8 +2572,8 @@ public class Digester
* @param pattern Element matching pattern
* @param methodName Method name to call on the parent element
* @param paramType Java class name of the expected parameter type (if you
wish to use a primitive type, specify the
- * corresonding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresonding Java wrapper class instead, such as {@code
java.lang.Boolean} for a
+ * {@code boolean} parameter)
* @see SetTopRule
*/
public void addSetTop( final String pattern, final String methodName,
final String paramType )
@@ -2609,7 +2609,7 @@ public class Digester
/**
* Return the top object on the stack without removing it.
*
- * If there are no objects on the stack, return <code>null</code>.
+ * 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.
@@ -2629,7 +2629,7 @@ public class Digester
/**
* Return the n'th object down the stack, where 0 is the top element and
[getCount()-1] is the bottom element. If
- * the specified index is out of range, return <code>null</code>.
+ * the specified index is out of range, return {@code null}.
*
* @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.
@@ -2656,7 +2656,7 @@ public class Digester
/**
* Pop the top object off of the stack, and return it. If there are no
objects on the stack, return
- * <code>null</code>.
+ * {@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
@@ -2734,7 +2734,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</code> 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
*/
@@ -2770,7 +2770,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</code> 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 )
@@ -2789,7 +2789,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</code> on the stack.
+ * @return the specified {@code Object} on the stack.
* @since 1.6
*/
public <T> T peek( final String stackName, final int n )
@@ -2885,7 +2885,7 @@ public class Digester
* <p>
* Clean up allocated resources after parsing is complete. The default
method closes input streams that have been
* created by Digester itself. If you override this method in a subclass,
be sure to call
- * <code>super.cleanup()</code> to invoke this logic.
+ * {@code super.cleanup()} to invoke this logic.
* </p>
*
* @since 1.8
@@ -2916,7 +2916,7 @@ public class Digester
/**
* <p>
- * Provide a hook for lazy configuration of this <code>Digester</code>
instance. The default implementation does
+ * Provide a hook for lazy configuration of this {@code Digester}
instance. The default implementation does
* nothing, but subclasses can override as needed.
* </p>
* <p>
@@ -2953,12 +2953,12 @@ public class Digester
/**
* <p>
- * Provides a hook for lazy initialization of this <code>Digester</code>
instance. The default implementation does
+ * Provides a hook for lazy initialization of this {@code Digester}
instance. The default implementation does
* nothing, but subclasses can override as needed. Digester (by default)
only calls this method once.
* </p>
* <p>
* <strong>Note</strong> This method will be called by {@link #configure}
only when the {@link #configured} flag is
- * false. Subclasses that override <code>configure</code> or who set
<code>configured</code> may find that this
+ * false. Subclasses that override {@code configure} or who set {@code
configured} may find that this
* method may be called more than once.
* </p>
*
@@ -2985,10 +2985,10 @@ public class Digester
/**
* <p>
* Return the top object on the parameters stack without removing it. If
there are no objects on the stack, return
- * <code>null</code>.
+ * {@code null}.
* </p>
* <p>
- * The parameters stack is used to store <code>CallMethodRule</code>
parameters. See {@link #params}.
+ * 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.
@@ -3009,10 +3009,10 @@ public class Digester
/**
* <p>
* Return the n'th object down the parameters stack, where 0 is the top
element and [getCount()-1] is the bottom
- * element. If the specified index is out of range, return
<code>null</code>.
+ * element. If the specified index is out of range, return {@code null}.
* </p>
* <p>
- * The parameters stack is used to store <code>CallMethodRule</code>
parameters. See {@link #params}.
+ * The parameters stack is used to store {@code CallMethodRule}
parameters. See {@link #params}.
* </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.
@@ -3040,10 +3040,10 @@ public class Digester
/**
* <p>
* Pop the top object off of the parameters stack, and return it. If there
are no objects on the stack, return
- * <code>null</code>.
+ * {@code null}.
* </p>
* <p>
- * The parameters stack is used to store <code>CallMethodRule</code>
parameters. See {@link #params}.
+ * The parameters stack is used to store {@code CallMethodRule}
parameters. See {@link #params}.
* </p>
*
* @return the top object popped off of the parameters stack
@@ -3070,7 +3070,7 @@ public class Digester
* Push a new object onto the top of the parameters stack.
* </p>
* <p>
- * The parameters stack is used to store <code>CallMethodRule</code>
parameters. See {@link #params}.
+ * The parameters stack is used to store {@code CallMethodRule}
parameters. See {@link #params}.
* </p>
*
* @param object The new object
diff --git
a/core/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java
b/core/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java
index d455ff7..86fb6df 100644
--- a/core/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java
+++ b/core/src/main/java/org/apache/commons/digester3/ExtendedBaseRules.java
@@ -71,14 +71,14 @@ import org.xml.sax.Attributes;
* so their associated Rule objects will be included in the set of rules to be
executed in the normal manner.
* </p>
* <ul>
- * <li>Pattern <code>"!*/a/b"</code> matches whenever an 'b' element is
inside an 'a'.</li>
- * <li>Pattern <code>"!a/b/?"</code> matches any child of a parent matching
<code>"a/b"</code> (see
+ * <li>Pattern {@code "!*/a/b"} matches whenever an 'b' element is inside
an 'a'.</li>
+ * <li>Pattern {@code "!a/b/?"} matches any child of a parent matching {@code
"a/b"} (see
* "Parent Match Patterns").</li>
- * <li>Pattern <code>"!*/a/b/?"</code> matches any child of a parent
matching <code>"!*/a/b"</code> (see
+ * <li>Pattern {@code "!*/a/b/?"} matches any child of a parent matching
{@code "!*/a/b"} (see
* "Parent Match Patterns").</li>
- * <li>Pattern <code>"!a/b/*"</code> matches any element whose path starts
with "a" then "b" (see
+ * <li>Pattern {@code "!a/b/*"} matches any element whose path starts with "a"
then "b" (see
* "Ancestor Match Patterns").</li>
- * <li>Pattern <code>"!*/a/b/*"</code> matches any elements whose path
contains 'a/b' (see
+ * <li>Pattern {@code "!*/a/b/*"} matches any elements whose path contains
'a/b' (see
* "Ancestor Match Patterns").</li>
* </ul>
* <h4>Parent Match Patterns</h4>
@@ -86,10 +86,10 @@ import org.xml.sax.Attributes;
* These will match direct child elements of a particular parent element.
* <ul>
* <li>
- * <code>"a/b/c/?"</code> matches any child whose parent matches
<code>"a/b/c"</code>. Exact parent rules take
+ * {@code "a/b/c/?"} matches any child whose parent matches {@code "a/b/c"}.
Exact parent rules take
* precedence over Ancestor Match patterns.</li>
* <li>
- * <code>"*/a/b/c/?"</code> matches any child whose parent matches
<code>"*/a/b/c"</code>. The longest
+ * {@code "*/a/b/c/?"} matches any child whose parent matches {@code
"*/a/b/c"}. The longest
* matching still applies to parent matches but the length excludes the '?',
which effectively means that standard
* wildcard matches with the same level of depth are chosen in preference.</li>
* </ul>
@@ -99,19 +99,19 @@ import org.xml.sax.Attributes;
* These will match elements whose parentage includes a particular sequence of
elements.
* <ul>
* <li>
- * <code>"a/b/*"</code> matches any element whose path starts with 'a' then
'b'. Exact parent and parent match rules
+ * {@code "a/b/*"} matches any element whose path starts with 'a' then 'b'.
Exact parent and parent match rules
* take precedence. The longest ancestor match will take precedence.</li>
* <li>
- * <code>"*/a/b/*"</code> matches any elements whose path contains an
element 'a' followed by an element 'b'.
+ * {@code "*/a/b/*"} matches any elements whose path contains an element
'a' followed by an element 'b'.
* The longest matching still applies but the length excludes the '*' at the
end.</li>
* </ul>
* </p>
* <h4>Completely Wild Patterns</h4>
* <p>
- * Pattern <code>"*"</code> matches every pattern that isn't matched by any
other basic rule.
+ * Pattern {@code "*"} matches every pattern that isn't matched by any other
basic rule.
* </p>
* <p>
- * Pattern <code>"!*"</code> matches every pattern.
+ * Pattern {@code "!*"} matches every pattern.
* </p>
* <h4>Using The Extended Rules</h4>
* <p>
diff --git
a/core/src/main/java/org/apache/commons/digester3/NodeCreateRule.java
b/core/src/main/java/org/apache/commons/digester3/NodeCreateRule.java
index fbef26e..37dbbb2 100644
--- a/core/src/main/java/org/apache/commons/digester3/NodeCreateRule.java
+++ b/core/src/main/java/org/apache/commons/digester3/NodeCreateRule.java
@@ -44,14 +44,14 @@ import org.xml.sax.helpers.DefaultHandler;
* </ul>
* The created node will be normalized, meaning it will not contain text nodes
that only contain white space characters.
* <p>
- * The created <code>Node</code> will be pushed on Digester's object stack
when done. To use it in the context of
+ * The created {@code Node} will be pushed on Digester's object stack when
done. To use it in the context of
* another DOM {@link org.w3c.dom.Document Document}, it must be imported
first, using the Document method
* {@link org.w3c.dom.Document#importNode(org.w3c.dom.Node, boolean)
importNode()}.
* </p>
* <p>
* <strong>Important Note:</strong> This is implemented by replacing the SAX
{@link org.xml.sax.ContentHandler
* ContentHandler} in the parser used by Digester, and resetting it when the
matched element is closed. As a side
- * effect, rules that would match XML nodes under the element that matches a
<code>NodeCreateRule</code> will never be
+ * effect, rules that would match XML nodes under the element that matches a
{@code NodeCreateRule} will never be
* triggered by Digester, which usually is the behavior one would expect.
* </p>
* <p>
@@ -312,9 +312,9 @@ public class NodeCreateRule
/**
* Constructor. Creates an instance of this rule that will create a DOM
{@link org.w3c.dom.Element Element}, but
- * lets you specify the JAXP <code>DocumentBuilder</code> that should be
used when constructing the node tree.
+ * lets you specify the JAXP {@code DocumentBuilder} that should be used
when constructing the node tree.
*
- * @param documentBuilder the JAXP <code>DocumentBuilder</code> to use
+ * @param documentBuilder the JAXP {@code DocumentBuilder} to use
*/
public NodeCreateRule( final DocumentBuilder documentBuilder )
{
@@ -324,7 +324,7 @@ public class NodeCreateRule
/**
* Constructor. Creates an instance of this rule that will create either a
DOM {@link org.w3c.dom.Element Element}
* or a DOM {@link org.w3c.dom.DocumentFragment DocumentFragment},
depending on the value of the
- * <code>nodeType</code> parameter.
+ * {@code nodeType} parameter.
*
* @param nodeType the type of node to create, which can be either {@link
org.w3c.dom.Node#ELEMENT_NODE
* Node.ELEMENT_NODE} or {@link
org.w3c.dom.Node#DOCUMENT_FRAGMENT_NODE Node.DOCUMENT_FRAGMENT_NODE}
@@ -341,12 +341,12 @@ public class NodeCreateRule
/**
* Constructor. Creates an instance of this rule that will create either a
DOM {@link org.w3c.dom.Element Element}
* or a DOM {@link org.w3c.dom.DocumentFragment DocumentFragment},
depending on the value of the
- * <code>nodeType</code> parameter. This constructor lets you specify the
JAXP <code>DocumentBuilder</code> that
+ * {@code nodeType} parameter. This constructor lets you specify the JAXP
{@code DocumentBuilder} that
* should be used when constructing the node tree.
*
* @param nodeType the type of node to create, which can be either {@link
org.w3c.dom.Node#ELEMENT_NODE
* Node.ELEMENT_NODE} or {@link
org.w3c.dom.Node#DOCUMENT_FRAGMENT_NODE Node.DOCUMENT_FRAGMENT_NODE}
- * @param documentBuilder the JAXP <code>DocumentBuilder</code> to use
+ * @param documentBuilder the JAXP {@code DocumentBuilder} to use
*/
public NodeCreateRule( final int nodeType, final DocumentBuilder
documentBuilder )
{
@@ -361,7 +361,7 @@ public class NodeCreateRule
// ----------------------------------------------------- Instance Variables
/**
- * The JAXP <code>DocumentBuilder</code> to use.
+ * The JAXP {@code DocumentBuilder} to use.
*/
private DocumentBuilder documentBuilder = null;
diff --git
a/core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
b/core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
index 5f12d7b..d13816a 100644
--- a/core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
+++ b/core/src/main/java/org/apache/commons/digester3/ObjectCreationFactory.java
@@ -24,11 +24,11 @@ import org.xml.sax.Attributes;
/**
* <p>
* Interface for use with {@link FactoryCreateRule}. The rule calls {@link
#createObject} to create an object to be
- * pushed onto the <code>Digester</code> stack whenever it is matched.
+ * pushed onto the {@code Digester} stack whenever it is matched.
* </p>
* <p>
* {@link AbstractObjectCreationFactory} is an abstract implementation
suitable for creating anonymous
- * <code>ObjectCreationFactory</code> implementations.
+ * {@code ObjectCreationFactory} implementations.
*
* @param <T> The object type created byt the factory.
*/
@@ -39,7 +39,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</code> 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 )
diff --git
a/core/src/main/java/org/apache/commons/digester3/PathCallParamRule.java
b/core/src/main/java/org/apache/commons/digester3/PathCallParamRule.java
index ddc73dd..e1994c1 100644
--- a/core/src/main/java/org/apache/commons/digester3/PathCallParamRule.java
+++ b/core/src/main/java/org/apache/commons/digester3/PathCallParamRule.java
@@ -25,8 +25,8 @@ import org.xml.sax.Attributes;
/**
* <p>
- * Rule implementation that saves a parameter containing the
<code>Digester</code> matching path for use by a
- * surrounding <code>CallMethodRule</code>. This Rule is most useful when
making extensive use of wildcards in rule
+ * Rule implementation that saves a parameter containing the {@code Digester}
matching path for use by a
+ * surrounding {@code CallMethodRule}. This Rule is most useful when making
extensive use of wildcards in rule
* patterns.
* </p>
*
diff --git
a/core/src/main/java/org/apache/commons/digester3/RecordedInvocation.java
b/core/src/main/java/org/apache/commons/digester3/RecordedInvocation.java
index 3b34e93..0b56a98 100644
--- a/core/src/main/java/org/apache/commons/digester3/RecordedInvocation.java
+++ b/core/src/main/java/org/apache/commons/digester3/RecordedInvocation.java
@@ -104,7 +104,7 @@ final class RecordedInvocation
}
/**
- * Add a string representation of <code>input</code> to
<code>buffer</code>.
+ * Add a string representation of {@code input} to {@code buffer}.
*
* @param buffer the buffer to append the string representation of the
input object.
* @param input the input object has to be serialized to string.
diff --git a/core/src/main/java/org/apache/commons/digester3/RegexRules.java
b/core/src/main/java/org/apache/commons/digester3/RegexRules.java
index 464ce4f..b3c9705 100644
--- a/core/src/main/java/org/apache/commons/digester3/RegexRules.java
+++ b/core/src/main/java/org/apache/commons/digester3/RegexRules.java
@@ -42,7 +42,7 @@ public class RegexRules
// --------------------------------------------------------- Fields
- /** All registered <code>Rule</code>'s */
+ /** All registered {@code Rule}'s */
private final ArrayList<RegisteredRule> registeredRules = new
ArrayList<RegisteredRule>();
/** The regex strategy used by this RegexRules */
diff --git a/core/src/main/java/org/apache/commons/digester3/Rule.java
b/core/src/main/java/org/apache/commons/digester3/Rule.java
index b4072ed..9dab9ca 100644
--- a/core/src/main/java/org/apache/commons/digester3/Rule.java
+++ b/core/src/main/java/org/apache/commons/digester3/Rule.java
@@ -77,9 +77,9 @@ import org.xml.sax.Attributes;
}
/**
- * Set the <code>Digester</code> with which this <code>Rule</code> is
associated.
+ * Set the {@code Digester} with which this {@code Rule} is associated.
*
- * @param digester the <code>Digester</code> with which this
<code>Rule</code> is associated
+ * @param digester the {@code Digester} with which this {@code Rule} is
associated
*/
public void setDigester( final Digester digester )
{
@@ -99,7 +99,7 @@ import org.xml.sax.Attributes;
/**
* Set the namespace URI for which this Rule is relevant, if any.
*
- * @param namespaceURI Namespace URI for which this Rule is relevant, or
<code>null</code> to match independent of
+ * @param namespaceURI Namespace URI for which this Rule is relevant, or
{@code null} to match independent of
* namespace.
*/
public void setNamespaceURI( final String namespaceURI )
diff --git a/core/src/main/java/org/apache/commons/digester3/RuleSet.java
b/core/src/main/java/org/apache/commons/digester3/RuleSet.java
index f2f47ca..dd7b2e6 100644
--- a/core/src/main/java/org/apache/commons/digester3/RuleSet.java
+++ b/core/src/main/java/org/apache/commons/digester3/RuleSet.java
@@ -21,17 +21,17 @@ package org.apache.commons.digester3;
/**
* <p>
- * Public interface defining a shorthand means of configuring a complete set
of related <code>Rule</code> definitions,
+ * Public interface defining a shorthand means of configuring a complete set
of related {@code Rule} definitions,
* possibly associated with a particular namespace URI, in one operation. To
use an instance of a class that imlements
* this interface:
* </p>
* <ul>
* <li>Create a concrete implementation of this interface.</li>
- * <li>Optionally, you can configure a <code>RuleSet</code> to be relevant
only for a particular namespace URI by
- * configuring the value to be returned by <code>getNamespaceURI()</code>.</li>
- * <li>As you are configuring your Digester instance, call
<code>digester.addRuleSet()</code> and pass the RuleSet
+ * <li>Optionally, you can configure a {@code RuleSet} to be relevant only for
a particular namespace URI by
+ * configuring the value to be returned by {@code getNamespaceURI()}.</li>
+ * <li>As you are configuring your Digester instance, call {@code
digester.addRuleSet()} and pass the RuleSet
* instance.</li>
- * <li>Digester will call the <code>addRuleInstances()</code> method of your
RuleSet to configure the
+ * <li>Digester will call the {@code addRuleInstances()} method of your
RuleSet to configure the
* necessary rules.</li>
* </ul>
*/
@@ -50,7 +50,7 @@ public interface RuleSet
// --------------------------------------------------------- Public Methods
/**
- * Add the set of Rule instances defined in this RuleSet to the specified
<code>Digester</code> instance,
+ * Add the set of Rule instances defined in this RuleSet to the specified
{@code Digester} instance,
* associating them with our namespace URI (if any). This method should
only be called by a Digester instance.
*
* @param digester Digester instance to which the new Rule instances
should be added.
diff --git a/core/src/main/java/org/apache/commons/digester3/RuleSetBase.java
b/core/src/main/java/org/apache/commons/digester3/RuleSetBase.java
index 8f070ff..ecd5787 100644
--- a/core/src/main/java/org/apache/commons/digester3/RuleSetBase.java
+++ b/core/src/main/java/org/apache/commons/digester3/RuleSetBase.java
@@ -22,7 +22,7 @@ package org.apache.commons.digester3;
/**
* <p>
* Convenience base class that implements the {@link RuleSet} interface.
Concrete implementations should list all of
- * their actual rule creation logic in the <code>addRuleSet()</code>
implementation.
+ * their actual rule creation logic in the {@code addRuleSet()} implementation.
* </p>
*/
public abstract class RuleSetBase
diff --git a/core/src/main/java/org/apache/commons/digester3/Rules.java
b/core/src/main/java/org/apache/commons/digester3/Rules.java
index fe129d3..bb7490b 100644
--- a/core/src/main/java/org/apache/commons/digester3/Rules.java
+++ b/core/src/main/java/org/apache/commons/digester3/Rules.java
@@ -48,16 +48,16 @@ public interface Rules
void setDigester( Digester digester );
/**
- * Return the namespace URI that will be applied to all subsequently added
<code>Rule</code> 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</code> objects.
+ * @return the namespace URI that will be applied to all subsequently
added {@code Rule} objects.
*/
String getNamespaceURI();
/**
- * Set the namespace URI that will be applied to all subsequently added
<code>Rule</code> objects.
+ * Set 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</code> for
+ * @param namespaceURI Namespace URI that must match on all subsequently
added rules, or {@code null} for
* matching regardless of the current namespace URI
*/
void setNamespaceURI( String namespaceURI );
@@ -80,9 +80,9 @@ public interface Rules
/**
* Return a List of all registered Rule instances that match the specified
nesting pattern, or a zero-length List if
* there are no matches. If more than one Rule instance matches, they
<strong>must</strong> be returned in the order
- * originally registered through the <code>add()</code> method.
+ * originally registered through the {@code add()} method.
*
- * @param namespaceURI Namespace URI for which to select matching rules,
or <code>null</code> to match regardless of
+ * @param namespaceURI Namespace URI for which to select matching rules,
or {@code null} to match regardless of
* namespace URI
* @param pattern Nesting pattern to be matched
* @param name the local name if the parser is namespace aware, or just
the element name otherwise
@@ -94,7 +94,7 @@ public interface Rules
/**
* Return a List of all registered Rule instances, or a zero-length List
if there are no registered Rule instances.
* If more than one Rule instance has been registered, they
<strong>must</strong> be returned in the order
- * originally registered through the <code>add()</code> method.
+ * originally registered through the {@code add()} method.
*
* @return a List of all registered Rule instances
*/
diff --git a/core/src/main/java/org/apache/commons/digester3/RulesBase.java
b/core/src/main/java/org/apache/commons/digester3/RulesBase.java
index c223230..cd19829 100644
--- a/core/src/main/java/org/apache/commons/digester3/RulesBase.java
+++ b/core/src/main/java/org/apache/commons/digester3/RulesBase.java
@@ -28,17 +28,17 @@ import org.xml.sax.Attributes;
/**
* <p>
- * Default implementation of the <code>Rules</code> interface that supports
the standard rule matching behavior. This
- * class can also be used as a base class for specialized <code>Rules</code>
implementations.
+ * Default implementation of the {@code Rules} interface that supports the
standard rule matching behavior. This
+ * class can also be used as a base class for specialized {@code Rules}
implementations.
* </p>
* <p>
* The matching policies implemented by this class support two different types
of pattern matching rules:
* </p>
* <ul>
- * <li><em>Exact Match</em> - A pattern "a/b/c" exactly matches a
<code><c></code> element, nested inside a
- * <code><b></code> element, which is nested inside an
<code><a></code> element.</li>
- * <li><em>Tail Match</em> - A pattern "*/a/b" matches a
<code><b></code> element, nested inside an
- * <code><a></code> element, no matter how deeply the pair is
nested.</li>
+ * <li><em>Exact Match</em> - A pattern "a/b/c" exactly matches a {@code
<c>} element, nested inside a
+ * {@code <b>} element, which is nested inside an {@code <a>}
element.</li>
+ * <li><em>Tail Match</em> - A pattern "*/a/b" matches a {@code <b>}
element, nested inside an
+ * {@code <a>} element, no matter how deeply the pair is nested.</li>
* </ul>
* <p>
* Note that wildcard patterns are ignored if an explicit match can be found
(and when multiple wildcard patterns match,
@@ -171,9 +171,9 @@ public class RulesBase
/**
* Return a List of Rule instances for the specified pattern that also
match the specified namespace URI (if any).
- * If there are no such rules, return <code>null</code>.
+ * If there are no such rules, return {@code null}.
*
- * @param namespaceURI Namespace URI to match, or <code>null</code> to
select matching rules regardless of namespace
+ * @param namespaceURI Namespace URI to match, or {@code null} to select
matching rules regardless of namespace
* URI
* @param pattern Pattern to be matched
* @return a List of Rule instances for the specified pattern that also
match the specified namespace URI (if any)
diff --git
a/core/src/main/java/org/apache/commons/digester3/SetNestedPropertiesRule.java
b/core/src/main/java/org/apache/commons/digester3/SetNestedPropertiesRule.java
index 4d88342..d1adf91 100644
---
a/core/src/main/java/org/apache/commons/digester3/SetNestedPropertiesRule.java
+++
b/core/src/main/java/org/apache/commons/digester3/SetNestedPropertiesRule.java
@@ -64,9 +64,9 @@ import org.xml.sax.Attributes;
* ignored.
* </p>
* <p>
- * A very similar effect can be achieved using a combination of the
<code>BeanPropertySetterRule</code> and the
- * <code>ExtendedBaseRules</code> rules manager; this <code>Rule</code>,
however, works fine with the default
- * <code>RulesBase</code> rules manager.
+ * A very similar effect can be achieved using a combination of the {@code
BeanPropertySetterRule} and the
+ * {@code ExtendedBaseRules} rules manager; this {@code Rule}, however, works
fine with the default
+ * {@code RulesBase} rules manager.
* </p>
* <p>
* Note that this rule is designed to be used to set only "primitive" bean
properties, eg String, int, boolean. If some
@@ -157,8 +157,8 @@ public class SetNestedPropertiesRule
* </p>
* <h5>Example One</h5>
* <p>
- * The following constructs a rule that maps the <code>alt-city</code>
element to the <code>city</code> property and
- * the <code>alt-state</code> to the <code>state</code> property. All
other child elements are mapped as usual using
+ * The following constructs a rule that maps the {@code alt-city} element
to the {@code city} property and
+ * the {@code alt-state} to the {@code state} property. All other child
elements are mapped as usual using
* exact name matching. <code><pre>
* SetNestedPropertiesRule(
* new String[] {"alt-city", "alt-state"},
@@ -167,8 +167,8 @@ public class SetNestedPropertiesRule
* </p>
* <h5>Example Two</h5>
* <p>
- * The following constructs a rule that maps the <code>class</code> xml
element to the <code>className</code>
- * property. The xml element <code>ignore-me</code> is not mapped, ie is
ignored. All other elements are mapped as
+ * The following constructs a rule that maps the {@code class} xml element
to the {@code className}
+ * property. The xml element {@code ignore-me} is not mapped, ie is
ignored. All other elements are mapped as
* usual using exact name matching. <code><pre>
* SetPropertiesRule(
* new String[] {"class", "ignore-me"},
diff --git a/core/src/main/java/org/apache/commons/digester3/SetNextRule.java
b/core/src/main/java/org/apache/commons/digester3/SetNextRule.java
index afe22f7..2d5d2fb 100644
--- a/core/src/main/java/org/apache/commons/digester3/SetNextRule.java
+++ b/core/src/main/java/org/apache/commons/digester3/SetNextRule.java
@@ -58,8 +58,8 @@ public class SetNextRule
*
* @param methodName Method name of the parent method to call
* @param paramType Java class name of the parent method's argument (if
you wish to use a primitive type,
- * specify the corresonding Java wrapper class instead,
such as <code>java.lang.Boolean</code>
- * for a <code>boolean</code> parameter)
+ * specify the corresonding Java wrapper class instead,
such as {@code java.lang.Boolean}
+ * for a {@code boolean} parameter)
*/
public SetNextRule( final String methodName, final String paramType )
{
@@ -71,8 +71,8 @@ public class SetNextRule
*
* @param methodName Method name of the parent method to call
* @param paramType Java class of the parent method's argument (if you
wish to use a primitive type, specify the
- * corresonding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresonding Java wrapper class instead, such as
{@code java.lang.Boolean} for a
+ * {@code boolean} parameter)
*/
public SetNextRule( final String methodName, final Class<?> paramType )
{
diff --git
a/core/src/main/java/org/apache/commons/digester3/SetPropertiesRule.java
b/core/src/main/java/org/apache/commons/digester3/SetPropertiesRule.java
index 5494c5f..2748d3d 100644
--- a/core/src/main/java/org/apache/commons/digester3/SetPropertiesRule.java
+++ b/core/src/main/java/org/apache/commons/digester3/SetPropertiesRule.java
@@ -85,8 +85,8 @@ public class SetPropertiesRule
* </p>
* <h5>Example One</h5>
* <p>
- * The following constructs a rule that maps the <code>alt-city</code>
attribute to the <code>city</code> property
- * and the <code>alt-state</code> to the <code>state</code> property. All
other attributes are mapped as usual using
+ * The following constructs a rule that maps the {@code alt-city}
attribute to the {@code city} property
+ * and the {@code alt-state} to the {@code state} property. All other
attributes are mapped as usual using
* exact name matching. <code><pre>
* SetPropertiesRule(
* new String[] {"alt-city", "alt-state"},
@@ -94,8 +94,8 @@ public class SetPropertiesRule
* </pre></code>
* <h5>Example Two</h5>
* <p>
- * The following constructs a rule that maps the <code>class</code>
attribute to the <code>className</code>
- * property. The attribute <code>ignore-me</code> is not mapped. All other
attributes are mapped as usual using
+ * The following constructs a rule that maps the {@code class} attribute
to the {@code className}
+ * property. The attribute {@code ignore-me} is not mapped. All other
attributes are mapped as usual using
* exact name matching. <code><pre>
* SetPropertiesRule(
* new String[] {"class", "ignore-me"},
@@ -257,7 +257,7 @@ public class SetPropertiesRule
* Are attributes found in the xml without matching properties to be
ignored?
* </p>
* <p>
- * If false, the parsing will interrupt with an
<code>NoSuchMethodException</code> if a property specified in the
+ * If false, the parsing will interrupt with an {@code
NoSuchMethodException} if a property specified in the
* XML is not found. The default is true.
* </p>
*
@@ -270,7 +270,7 @@ public class SetPropertiesRule
/**
* Sets whether attributes found in the xml without matching properties
should be ignored. If set to false, the
- * parsing will throw an <code>NoSuchMethodException</code> if an
unmatched attribute is found. This allows to trap
+ * parsing will throw an {@code NoSuchMethodException} if an unmatched
attribute is found. This allows to trap
* misspellings in the XML file.
*
* @param ignoreMissingProperty false to stop the parsing on unmatched
attributes.
diff --git a/core/src/main/java/org/apache/commons/digester3/SetRootRule.java
b/core/src/main/java/org/apache/commons/digester3/SetRootRule.java
index b2f06c0..b17226b 100644
--- a/core/src/main/java/org/apache/commons/digester3/SetRootRule.java
+++ b/core/src/main/java/org/apache/commons/digester3/SetRootRule.java
@@ -23,7 +23,7 @@ package org.apache.commons.digester3;
/**
* <p>
* Rule implementation that calls a method on the root object on the stack,
passing the top object (child) as an
- * argument. It is important to remember that this rule acts on
<code>end</code>.
+ * argument. It is important to remember that this rule acts on {@code end}.
* </p>
* <p>
* This rule now supports more flexible method matching by default. It is
possible that this may break (some) code
@@ -52,8 +52,8 @@ public class SetRootRule
*
* @param methodName Method name of the parent method to call
* @param paramType Java class name of the parent method's argument (if
you wish to use a primitive type,
- * specify the corresonding Java wrapper class instead,
such as <code>java.lang.Boolean</code>
- * for a <code>boolean</code> parameter)
+ * specify the corresonding Java wrapper class instead,
such as {@code java.lang.Boolean}
+ * for a {@code boolean} parameter)
*/
public SetRootRule( final String methodName, final String paramType )
{
@@ -65,8 +65,8 @@ public class SetRootRule
*
* @param methodName Method name of the parent method to call
* @param paramType Java class of the parent method's argument (if you
wish to use a primitive type, specify the
- * corresonding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresonding Java wrapper class instead, such as
{@code java.lang.Boolean} for a
+ * {@code boolean} parameter)
*/
public SetRootRule( final String methodName, final Class<?> paramType )
{
diff --git a/core/src/main/java/org/apache/commons/digester3/SetTopRule.java
b/core/src/main/java/org/apache/commons/digester3/SetTopRule.java
index 8ab56fd..1696593 100644
--- a/core/src/main/java/org/apache/commons/digester3/SetTopRule.java
+++ b/core/src/main/java/org/apache/commons/digester3/SetTopRule.java
@@ -52,8 +52,8 @@ public class SetTopRule
*
* @param methodName Method name of the parent method to call
* @param paramType Java class name of the parent method's argument (if
you wish to use a primitive type,
- * specify the corresonding Java wrapper class instead,
such as <code>java.lang.Boolean</code>
- * for a <code>boolean</code> parameter)
+ * specify the corresonding Java wrapper class instead,
such as {@code java.lang.Boolean}
+ * for a {@code boolean} parameter)
*/
public SetTopRule( final String methodName, final String paramType )
{
@@ -65,8 +65,8 @@ public class SetTopRule
*
* @param methodName Method name of the parent method to call
* @param paramType Java class of the parent method's argument (if you
wish to use a primitive type, specify the
- * corresonding Java wrapper class instead, such as
<code>java.lang.Boolean</code> for a
- * <code>boolean</code> parameter)
+ * corresonding Java wrapper class instead, such as {@code
java.lang.Boolean} for a
+ * {@code boolean} parameter)
*/
public SetTopRule( final String methodName, final Class<?> paramType )
{
diff --git
a/core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
b/core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
index 09b0f52..524009c 100644
--- a/core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
+++ b/core/src/main/java/org/apache/commons/digester3/SimpleRegexMatcher.java
@@ -29,8 +29,8 @@ import org.apache.commons.logging.LogFactory;
* <p>
* This uses just two wildcards:
* <ul>
- * <li><code>*</code> matches any sequence of none, one or more characters
- * <li><code>?</code> matches any one character
+ * <li>{@code *} matches any sequence of none, one or more characters
+ * <li>{@code ?} matches any one character
* </ul>
* Escaping these wildcards is not supported .
* </p>
@@ -52,9 +52,9 @@ public class SimpleRegexMatcher
// --------------------------------------------------------- Properties
/**
- * Gets the <code>Log</code> implementation.
+ * Gets the {@code Log} implementation.
*
- * @return the <code>Log</code> implementation.
+ * @return the {@code Log} implementation.
*/
public Log getLog()
{
@@ -62,9 +62,9 @@ public class SimpleRegexMatcher
}
/**
- * Sets the current <code>Log</code> implementation used by this class.
+ * Sets the current {@code Log} implementation used by this class.
*
- * @param log the current <code>Log</code> implementation used by this
class.
+ * @param log the current {@code Log} implementation used by this class.
*/
public void setLog( final Log log )
{
diff --git a/core/src/main/java/org/apache/commons/digester3/Substitutor.java
b/core/src/main/java/org/apache/commons/digester3/Substitutor.java
index 280a5f6..ce42bf0 100644
--- a/core/src/main/java/org/apache/commons/digester3/Substitutor.java
+++ b/core/src/main/java/org/apache/commons/digester3/Substitutor.java
@@ -27,7 +27,7 @@ import org.xml.sax.Attributes;
* future additions to be made without breaking backwards compatibility.)
* </p>
* <p>
- * Usage: When {@link Digester#setSubstitutor} is set, <code>Digester</code>
calls the methods in this interface to
+ * Usage: When {@link Digester#setSubstitutor} is set, {@code Digester} calls
the methods in this interface to
* create substitute values which will be passed into the Rule
implementations. Of course, it is perfectly acceptable
* for implementations not to make substitutions and simply return the inputs.
* </p>
@@ -42,17 +42,17 @@ public abstract class Substitutor
/**
* <p>
- * Substitutes the attributes (before they are passed to the
<code>Rule</code> implementations's).
+ * Substitutes the attributes (before they are passed to the {@code Rule}
implementations's).
* </p>
* <p>
- * <code>Digester</code> will only call this method a second time once the
original <code>Attributes</code> instance
- * can be safely reused. The implementation is therefore free to reuse the
same <code>Attributes</code> instance for
+ * {@code Digester} will only call this method a second time once the
original {@code Attributes} instance
+ * can be safely reused. The implementation is therefore free to reuse the
same {@code Attributes} instance for
* all calls.
* </p>
*
- * @param attributes the <code>Attributes</code> passed into
<code>Digester</code> by the SAX parser, not null (but
+ * @param attributes the {@code Attributes} passed into {@code Digester}
by the SAX parser, not null (but
* may be empty)
- * @return <code>Attributes</code> to be passed to the <code>Rule</code>
implementations. This method may pass back
+ * @return {@code Attributes} to be passed to the {@code Rule}
implementations. This method may pass back
* the Attributes passed in. Not null but possibly empty.
*/
public abstract Attributes substitute( Attributes attributes );
@@ -61,8 +61,8 @@ public abstract class Substitutor
* Substitutes for the body text. This method may substitute values into
the body text of the elements that Digester
* parses.
*
- * @param bodyText the body text (as passed to <code>Digester</code>)
- * @return the body text to be passed to the <code>Rule</code>
implementations
+ * @param bodyText the body text (as passed to {@code Digester})
+ * @return the body text to be passed to the {@code Rule} implementations
*/
public abstract String substitute( String bodyText );
diff --git
a/core/src/main/java/org/apache/commons/digester3/WithDefaultsRulesWrapper.java
b/core/src/main/java/org/apache/commons/digester3/WithDefaultsRulesWrapper.java
index 11043eb..f433068 100644
---
a/core/src/main/java/org/apache/commons/digester3/WithDefaultsRulesWrapper.java
+++
b/core/src/main/java/org/apache/commons/digester3/WithDefaultsRulesWrapper.java
@@ -26,12 +26,12 @@ import org.xml.sax.Attributes;
/**
* <p>
- * <code>Rules</code> <em>Decorator</em> that returns default rules when no
matches are returned by the wrapped
+ * {@code Rules} <em>Decorator</em> that returns default rules when no matches
are returned by the wrapped
* implementation.
* </p>
* <p>
- * This allows default <code>Rule</code> instances to be added to any existing
<code>Rules</code> implementation. These
- * default <code>Rule</code> instances will be returned for any match for
which the wrapped implementation does not
+ * This allows default {@code Rule} instances to be added to any existing
{@code Rules} implementation. These
+ * default {@code Rule} instances will be returned for any match for which the
wrapped implementation does not
* return any matches.
* </p>
* <p>
@@ -50,7 +50,7 @@ import org.xml.sax.Attributes;
* when a pattern does not match any other rule, then rule alpha will be
called.
* </p>
* <p>
- * <code>WithDefaultsRulesWrapper</code> follows the <em>Decorator</em>
pattern.
+ * {@code WithDefaultsRulesWrapper} follows the <em>Decorator</em> pattern.
* </p>
*
* @since 1.6
@@ -75,7 +75,7 @@ public class WithDefaultsRulesWrapper
/**
* Base constructor.
*
- * @param wrappedRules the wrapped <code>Rules</code> implementation, not
null
+ * @param wrappedRules the wrapped {@code Rules} implementation, not null
*/
public WithDefaultsRulesWrapper( final Rules wrappedRules )
{
diff --git
a/core/src/main/java/org/apache/commons/digester3/annotations/handlers/package-info.java
b/core/src/main/java/org/apache/commons/digester3/annotations/handlers/package-info.java
index b7220bb..78eaac6 100644
---
a/core/src/main/java/org/apache/commons/digester3/annotations/handlers/package-info.java
+++
b/core/src/main/java/org/apache/commons/digester3/annotations/handlers/package-info.java
@@ -1,5 +1,5 @@
/**
- * The <code>handlers</code> package contains
+ * The {@code handlers} package contains
* {@link org.apache.commons.digester3.annotations.AnnotationHandler}
* implementations.
*/
diff --git
a/core/src/main/java/org/apache/commons/digester3/annotations/package-info.java
b/core/src/main/java/org/apache/commons/digester3/annotations/package-info.java
index b95f98a..503f33a 100644
---
a/core/src/main/java/org/apache/commons/digester3/annotations/package-info.java
+++
b/core/src/main/java/org/apache/commons/digester3/annotations/package-info.java
@@ -1,6 +1,6 @@
/**
- * The <code>annotations</code> package provides for Java5 Annotations
- * meta data-based definition of rules for <code>Digester</code>.
+ * The {@code annotations} package provides for Java5 Annotations
+ * meta data-based definition of rules for {@code Digester}.
*/
package org.apache.commons.digester3.annotations;
diff --git
a/core/src/main/java/org/apache/commons/digester3/annotations/reflect/package-info.java
b/core/src/main/java/org/apache/commons/digester3/annotations/reflect/package-info.java
index 904de1e..cca5bb7 100644
---
a/core/src/main/java/org/apache/commons/digester3/annotations/reflect/package-info.java
+++
b/core/src/main/java/org/apache/commons/digester3/annotations/reflect/package-info.java
@@ -1,5 +1,5 @@
/**
- * The <code>reflect</code> package supply missing JVM classes to alow user
+ * The {@code reflect} package supply missing JVM classes to alow user
* manipulate entities as {@link java.lang.reflect.AnnotatedElement}.
*/
package org.apache.commons.digester3.annotations.reflect;
diff --git
a/core/src/main/java/org/apache/commons/digester3/binder/AbstractNamespaceURIBasedRulesModule.java
b/core/src/main/java/org/apache/commons/digester3/binder/AbstractNamespaceURIBasedRulesModule.java
index baa6652..dee13ca 100644
---
a/core/src/main/java/org/apache/commons/digester3/binder/AbstractNamespaceURIBasedRulesModule.java
+++
b/core/src/main/java/org/apache/commons/digester3/binder/AbstractNamespaceURIBasedRulesModule.java
@@ -35,7 +35,7 @@ public abstract class AbstractNamespaceURIBasedRulesModule
* Creates a new (nullable) namespaceURI-based {@link RulesModule} that
automatically binds every
* rule to the input namespaceURI.
*
- * @param namespaceURI Namespace URI for which this Rule is relevant, or
<code>null</code> to match
+ * @param namespaceURI Namespace URI for which this Rule is relevant, or
{@code null} to match
* independent of namespace.
*/
public AbstractNamespaceURIBasedRulesModule( /* @Nullable */final String
namespaceURI )
diff --git
a/core/src/main/java/org/apache/commons/digester3/binder/CallMethodBuilder.java
b/core/src/main/java/org/apache/commons/digester3/binder/CallMethodBuilder.java
index b5bff30..7899460 100644
---
a/core/src/main/java/org/apache/commons/digester3/binder/CallMethodBuilder.java
+++
b/core/src/main/java/org/apache/commons/digester3/binder/CallMethodBuilder.java
@@ -128,7 +128,7 @@ public final class CallMethodBuilder
}
/**
- * Should <code>MethodUtils.invokeExactMethod</code> be used for the
reflection.
+ * Should {@code MethodUtils.invokeExactMethod} be used for the reflection.
*
* @param useExactMatch Flag to mark exact matching or not
* @return this builder instance
diff --git
a/core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
b/core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
index 237a199..59e7375 100644
--- a/core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
+++ b/core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
@@ -115,7 +115,7 @@ public final class DigesterLoader
* The class loader to use for instantiating application objects.
* If not specified, the context class loader, or the class loader
* used to load Digester itself, is used, based on the value of the
- * <code>useContextClassLoader</code> variable.
+ * {@code useContextClassLoader} variable.
*/
private BinderClassLoader classLoader;
@@ -166,7 +166,7 @@ public final class DigesterLoader
/**
* Determine whether to use the Context ClassLoader (the one found by
- * calling <code>Thread.currentThread().getContextClassLoader()</code>)
+ * calling {@code Thread.currentThread().getContextClassLoader()})
* to resolve/load classes that are defined in various rules. If not
* using Context ClassLoader, then the class-loading defaults to
* using the calling-class' ClassLoader.
@@ -212,7 +212,7 @@ public final class DigesterLoader
}
/**
- * Sets the <code>Substitutor</code> to be used to convert attributes and
body text.
+ * Sets the {@code Substitutor} to be used to convert attributes and body
text.
*
* @param substitutor the Substitutor to be used to convert attributes and
body text
* or null if not substitution of these values is to be performed.
@@ -308,7 +308,7 @@ public final class DigesterLoader
/**
* Sets a flag indicating whether the requested feature is supported by
the underlying implementation of
- * <code>org.xml.sax.XMLReader</code>.
+ * {@code org.xml.sax.XMLReader}.
*
* @see org.apache.commons.digester3.Digester#setFeature(String, boolean)
* @param feature Name of the feature to set the status for
@@ -328,21 +328,21 @@ public final class DigesterLoader
/**
* <p>Register the specified DTD URL for the specified public identifier.
- * This must be called before the first call to <code>parse()</code>.
+ * This must be called before the first call to {@code parse()}.
* </p><p>
- * <code>Digester</code> contains an internal <code>EntityResolver</code>
- * implementation. This maps <code>PUBLICID</code>'s to URLs
+ * {@code Digester} contains an internal {@code EntityResolver}
+ * implementation. This maps {@code PUBLICID}'s to URLs
* (from which the resource will be loaded). A common use case for this
* method is to register local URLs (possibly computed at runtime by a
* classloader) for DTDs. This allows the performance advantage of using
- * a local version without having to ensure every <code>SYSTEM</code>
+ * a local version without having to ensure every {@code SYSTEM}
* URI on every processed xml document is local. This implementation
provides
* only basic functionality. If more sophisticated features are required,
* using {@link #setEntityResolver(EntityResolver)} to set a custom
resolver is recommended.
* </p><p>
* <strong>Note:</strong> This method will have no effect when a custom
- * <code>EntityResolver</code> has been set. (Setting a custom
- * <code>EntityResolver</code> overrides the internal implementation.)
+ * {@code EntityResolver} has been set. (Setting a custom
+ * {@code EntityResolver} overrides the internal implementation.)
* </p>
* @param publicId Public identifier of the DTD to be resolved
* @param entityURL The URL to use for reading this DTD
@@ -385,10 +385,10 @@ public final class DigesterLoader
}
/**
- * Set the <code>EntityResolver</code> used by SAX when resolving public
id and system id. This must be called
- * before the first call to <code>parse()</code>.
+ * Set 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</code> interface.
+ * @param entityResolver a class that implement the {@code EntityResolver}
interface.
* @return This loader instance, useful to chain methods.
*/
public DigesterLoader setEntityResolver( final EntityResolver
entityResolver )
diff --git
a/core/src/main/java/org/apache/commons/digester3/binder/NodeCreateRuleProvider.java
b/core/src/main/java/org/apache/commons/digester3/binder/NodeCreateRuleProvider.java
index 6bb8f88..32c6a7d 100644
---
a/core/src/main/java/org/apache/commons/digester3/binder/NodeCreateRuleProvider.java
+++
b/core/src/main/java/org/apache/commons/digester3/binder/NodeCreateRuleProvider.java
@@ -59,7 +59,7 @@ public final class NodeCreateRuleProvider
/**
* {@link NodeCreateRule} instance will be created either a DOM {@link
org.w3c.dom.Element Element}
* or a DOM {@link org.w3c.dom.DocumentFragment DocumentFragment},
depending on the value of the
- * <code>nodeType</code> parameter.
+ * {@code nodeType} parameter.
*
* @param nodeType the type of node to create, which can be either
* {@link org.w3c.dom.Node#ELEMENT_NODE Node.ELEMENT_NODE}
or
@@ -79,9 +79,9 @@ public final class NodeCreateRuleProvider
/**
* {@link NodeCreateRule} instance will be created a DOM {@link
org.w3c.dom.Element Element}, but
- * lets users specify the JAXP <code>DocumentBuilder</code> that should be
used when constructing the node tree.
+ * lets users specify the JAXP {@code DocumentBuilder} that should be used
when constructing the node tree.
*
- * @param documentBuilder the JAXP <code>DocumentBuilder</code> to use
+ * @param documentBuilder the JAXP {@code DocumentBuilder} to use
* @return this builder instance
*/
public NodeCreateRuleProvider usingDocumentBuilder( final DocumentBuilder
documentBuilder )
diff --git a/core/src/main/java/org/apache/commons/digester3/package-info.java
b/core/src/main/java/org/apache/commons/digester3/package-info.java
index d5e3716..ad1fd85 100644
--- a/core/src/main/java/org/apache/commons/digester3/package-info.java
+++ b/core/src/main/java/org/apache/commons/digester3/package-info.java
@@ -1,7 +1,7 @@
/**
- * The <code>xmlrules</code> package provides for XML-based definition of
- * rules for <code>Digester</code>. This improves maintainability of Java code,
- * as rules are now defined in XML and read into <code>Digester</code>
+ * The {@code xmlrules} package provides for XML-based definition of
+ * rules for {@code Digester}. This improves maintainability of Java code,
+ * as rules are now defined in XML and read into {@code Digester}
* at run-time.
*/
package org.apache.commons.digester3;
diff --git
a/core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
b/core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
index a0c31d1..b1faa0c 100644
--- a/core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
+++ b/core/src/main/java/org/apache/commons/digester3/plugins/PluginRules.java
@@ -182,9 +182,9 @@ public class PluginRules
}
/**
- * Return the namespace URI that will be applied to all subsequently added
<code>Rule</code> 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</code> objects.
+ * @return the namespace URI that will be applied to all subsequently
added {@code Rule} objects.
*/
@Override
public String getNamespaceURI()
@@ -193,9 +193,9 @@ public class PluginRules
}
/**
- * Set the namespace URI that will be applied to all subsequently added
<code>Rule</code> objects.
+ * Set 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</code> for
+ * @param namespaceURI Namespace URI that must match on all subsequently
added rules, or {@code null} for
* matching regardless of the current namespace URI
*/
@Override
diff --git
a/core/src/main/java/org/apache/commons/digester3/plugins/package-info.java
b/core/src/main/java/org/apache/commons/digester3/plugins/package-info.java
index 4e63dff..2d7ae24 100644
--- a/core/src/main/java/org/apache/commons/digester3/plugins/package-info.java
+++ b/core/src/main/java/org/apache/commons/digester3/plugins/package-info.java
@@ -1,5 +1,5 @@
/**
- * The <code>plugins</code> package provides an easy mechanism whereby new
+ * The {@code plugins} package provides an easy mechanism whereby new
* digestion rules can be added dynamically during a digestion.
*/
package org.apache.commons.digester3.plugins;
diff --git
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromClass.java
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromClass.java
index 1a1b334..8571964 100644
---
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromClass.java
+++
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromClass.java
@@ -77,7 +77,7 @@ public class FinderFromClass
* <p>
* The returned object (when non-null) will invoke the target method on
the selected class whenever its addRules
* method is invoked. The target method is expected to have the following
prototype:
- * <code> public static void xxxxx(Digester d, String patternPrefix);
</code>
+ * {@code public static void xxxxx(Digester d, String patternPrefix); }
* <p>
* The target method can be specified in several ways. If this object's
constructor was passed a non-null methodAttr
* parameter, and the properties defines a value with that key, then that
is taken as the target method name. If
diff --git
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltClass.java
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltClass.java
index e03f4a7..1d18c64 100644
---
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltClass.java
+++
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltClass.java
@@ -71,7 +71,7 @@ public class FinderFromDfltClass
* <p>
* The returned object (when non-null) will invoke the target method on
the selected class whenever its addRules
* method is invoked. The target method is expected to have the following
prototype:
- * <code> public static void xxxxx(Digester d, String patternPrefix);
</code>
+ * {@code public static void xxxxx(Digester d, String patternPrefix); }
*
* @param digester The digester instance where locating plugin classes
* @param pluginClass The plugin Java class
diff --git
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltMethod.java
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltMethod.java
index 57d49b2..e6bbad5 100644
---
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltMethod.java
+++
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromDfltMethod.java
@@ -64,7 +64,7 @@ public class FinderFromDfltMethod
* <p>
* The returned object (when non-null) will invoke the target method on
the plugin class whenever its addRules
* method is invoked. The target method is expected to have the following
prototype:
- * <code> public static void xxxxx(Digester d, String patternPrefix);
</code>
+ * {@code public static void xxxxx(Digester d, String patternPrefix); }
*
* @param d The digester instance where locating plugin classes
* @param pluginClass The plugin Java class
diff --git
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java
index ca0b22f..2f46c56 100644
---
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java
+++
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java
@@ -70,7 +70,7 @@ public class FinderFromMethod
* <p>
* The returned object (when non-null) will invoke the target method on
the plugin class whenever its addRules
* method is invoked. The target method is expected to have the following
prototype:
- * <code> public static void xxxxx(Digester d, String patternPrefix);
</code>
+ * {@code public static void xxxxx(Digester d, String patternPrefix); }
*
* @param d The digester instance where locating plugin classes
* @param pluginClass The plugin Java class
diff --git
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/LoaderFromClass.java
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/LoaderFromClass.java
index 8c2f1e6..520949d 100644
---
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/LoaderFromClass.java
+++
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/LoaderFromClass.java
@@ -106,7 +106,7 @@ public class LoaderFromClass
/**
* Find a method on the specified class whose name matches methodName, and
whose signature is:
- * <code> public static void foo(Digester d, String patternPrefix);</code>.
+ * {@code public static void foo(Digester d, String patternPrefix);}.
*
* @param rulesClass The target class
* @param methodName The method name has to be invoked
diff --git
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/package-info.java
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/package-info.java
index 2891f81..f7d21b6 100644
---
a/core/src/main/java/org/apache/commons/digester3/plugins/strategies/package-info.java
+++
b/core/src/main/java/org/apache/commons/digester3/plugins/strategies/package-info.java
@@ -1,5 +1,5 @@
/**
- * The <code>plugins.strategies</code> package contains "rule-finding" strategy
+ * The {@code plugins.strategies} package contains "rule-finding" strategy
* classes, and their associated "helper" loader classes.
*/
package org.apache.commons.digester3.plugins.strategies;
diff --git
a/core/src/main/java/org/apache/commons/digester3/substitution/CompoundSubstitutor.java
b/core/src/main/java/org/apache/commons/digester3/substitution/CompoundSubstitutor.java
index 75621bc..9227007 100644
---
a/core/src/main/java/org/apache/commons/digester3/substitution/CompoundSubstitutor.java
+++
b/core/src/main/java/org/apache/commons/digester3/substitution/CompoundSubstitutor.java
@@ -23,9 +23,9 @@ import org.apache.commons.digester3.Substitutor;
import org.xml.sax.Attributes;
/**
- * This Substitutor chains two Substitutors <code>a</code> and <code>b</code>.
- * All values to substitute are first handled by <code>a</code> and passed to
- * <code>b</code> afterwards.
+ * This Substitutor chains two Substitutors {@code a} and {@code b}.
+ * All values to substitute are first handled by {@code a} and passed to
+ * {@code b} afterwards.
*/
public class CompoundSubstitutor
extends Substitutor
@@ -42,8 +42,8 @@ public class CompoundSubstitutor
private final Substitutor b;
/**
- * Creates a new CompoundSubstitutor instance. All values overgiven to
<code>substitute()</code>
- * are first handled by <code>a</code> and passed to <code>b</code>
afterwards.
+ * Creates a new CompoundSubstitutor instance. All values overgiven to
{@code substitute()}
+ * are first handled by {@code a} and passed to {@code b} afterwards.
* Both Substitutor have to be not null.
*
* @param a Substitutor a
diff --git
a/core/src/main/java/org/apache/commons/digester3/substitution/package-info.java
b/core/src/main/java/org/apache/commons/digester3/substitution/package-info.java
index e2a0d1a..80f3f52 100644
---
a/core/src/main/java/org/apache/commons/digester3/substitution/package-info.java
+++
b/core/src/main/java/org/apache/commons/digester3/substitution/package-info.java
@@ -1,5 +1,5 @@
/**
- * The <code>substitution</code> provides for manipulation of xml attributes
and
+ * The {@code substitution} provides for manipulation of xml attributes and
* element body text before the data is processed by any Rule objects.
*/
package org.apache.commons.digester3.substitution;
diff --git
a/core/src/test/java/org/apache/commons/digester3/BeanPropertySetterRuleTestCase.java
b/core/src/test/java/org/apache/commons/digester3/BeanPropertySetterRuleTestCase.java
index e730a17..4dcb129 100644
---
a/core/src/test/java/org/apache/commons/digester3/BeanPropertySetterRuleTestCase.java
+++
b/core/src/test/java/org/apache/commons/digester3/BeanPropertySetterRuleTestCase.java
@@ -37,7 +37,7 @@ import org.xml.sax.SAXException;
/**
* <p>
- * Test case for <code>BeanPropertySetterRule</code>. This contains tests for
the main applications of the rule and two
+ * Test case for {@code BeanPropertySetterRule}. This contains tests for the
main applications of the rule and two
* more general tests of digester functionality used by this rule.
*/
public class BeanPropertySetterRuleTestCase
diff --git
a/core/src/test/java/org/apache/commons/digester3/CallMethodRuleTestCase.java
b/core/src/test/java/org/apache/commons/digester3/CallMethodRuleTestCase.java
index 5fc7443..fd31a01 100644
---
a/core/src/test/java/org/apache/commons/digester3/CallMethodRuleTestCase.java
+++
b/core/src/test/java/org/apache/commons/digester3/CallMethodRuleTestCase.java
@@ -39,7 +39,7 @@ import org.xml.sax.SAXException;
/**
* <p>
- * Tests for the <code>CallMethodRule</code> and associated
<code>CallParamRule</code>.
+ * Tests for the {@code CallMethodRule} and associated {@code CallParamRule}.
*
* @author Christopher Lenz
*/
diff --git
a/core/src/test/java/org/apache/commons/digester3/DigesterTestCase.java
b/core/src/test/java/org/apache/commons/digester3/DigesterTestCase.java
index cec437d..e865d79 100644
--- a/core/src/test/java/org/apache/commons/digester3/DigesterTestCase.java
+++ b/core/src/test/java/org/apache/commons/digester3/DigesterTestCase.java
@@ -98,7 +98,7 @@ public class DigesterTestCase
// ------------------------------------------------ Individual Test Methods
/**
- * Test <code>null</code> parsing. (should lead to
<code>IllegalArgumentException</code>s)
+ * Test {@code null} parsing. (should lead to {@code
IllegalArgumentException}s)
*/
@Test
public void testNullFileParse()
diff --git
a/core/src/test/java/org/apache/commons/digester3/NodeCreateRuleTestCase.java
b/core/src/test/java/org/apache/commons/digester3/NodeCreateRuleTestCase.java
index 743c3aa..d89a045 100644
---
a/core/src/test/java/org/apache/commons/digester3/NodeCreateRuleTestCase.java
+++
b/core/src/test/java/org/apache/commons/digester3/NodeCreateRuleTestCase.java
@@ -46,7 +46,7 @@ import org.xml.sax.SAXException;
/**
* <p>
- * Test case for the <code>NodeCreateRule</code>.
+ * Test case for the {@code NodeCreateRule}.
*
* @author Christopher Lenz
*/
diff --git
a/core/src/test/java/org/apache/commons/digester3/ObjectParamRuleTestCase.java
b/core/src/test/java/org/apache/commons/digester3/ObjectParamRuleTestCase.java
index 2bb2775..d707431 100644
---
a/core/src/test/java/org/apache/commons/digester3/ObjectParamRuleTestCase.java
+++
b/core/src/test/java/org/apache/commons/digester3/ObjectParamRuleTestCase.java
@@ -33,7 +33,7 @@ import org.xml.sax.SAXException;
/**
* <p>
- * Tests for the <code>ObjectParamRuleTestCase</code>
+ * Tests for the {@code ObjectParamRuleTestCase}
*
* @author Mark Huisman
*/
diff --git a/core/src/test/java/org/apache/commons/digester3/RuleTestCase.java
b/core/src/test/java/org/apache/commons/digester3/RuleTestCase.java
index 7eab705..6a333c6 100644
--- a/core/src/test/java/org/apache/commons/digester3/RuleTestCase.java
+++ b/core/src/test/java/org/apache/commons/digester3/RuleTestCase.java
@@ -266,7 +266,7 @@ public class RuleTestCase
}
/**
- * Same as <code>testRuleSet1</code> except using a single namespace.
+ * Same as {@code testRuleSet1} except using a single namespace.
*/
@Test
public void testRuleSet2()
@@ -290,7 +290,7 @@ public class RuleTestCase
}
/**
- * Same as <code>testRuleSet2</code> except using a namespace for employee
that we should recognize, and a namespace
+ * Same as {@code testRuleSet2} except using a namespace for employee that
we should recognize, and a namespace
* for address that we should skip.
*/
@Test
@@ -319,7 +319,7 @@ public class RuleTestCase
* in the same tree of objects. Instead of using the SetNextRule rule
which results in a method invocation on the
* (top-1) (parent) object with the top object (child) as an argument,
this test uses the SetTopRule rule which
* results in a method invocation on the top object (child) with the top-1
(parent) object as an argument. The three
- * argument form is tested in <code>testSetTopRule2</code>.
+ * argument form is tested in {@code testSetTopRule2}.
*/
@Test
public void testSetTopRule1()
@@ -341,7 +341,7 @@ public class RuleTestCase
}
/**
- * Same as <code>testSetTopRule1</code> except using the three argument
form of the SetTopRule rule.
+ * Same as {@code testSetTopRule1} except using the three argument form of
the SetTopRule rule.
*/
@Test
public void testSetTopRule2()
@@ -536,7 +536,7 @@ public class RuleTestCase
/**
* Validate the assertions for ObjectCreateRule3.
*
- * @param root Root object returned by <code>digester.parse()</code>
+ * @param root Root object returned by {@code digester.parse()}
*/
protected void validateObjectCreate3( final Object root )
{
diff --git
a/core/src/test/java/org/apache/commons/digester3/SetNestedPropertiesRuleTestCase.java
b/core/src/test/java/org/apache/commons/digester3/SetNestedPropertiesRuleTestCase.java
index e8e2ddb..ebf7dab 100644
---
a/core/src/test/java/org/apache/commons/digester3/SetNestedPropertiesRuleTestCase.java
+++
b/core/src/test/java/org/apache/commons/digester3/SetNestedPropertiesRuleTestCase.java
@@ -33,7 +33,7 @@ import org.xml.sax.SAXException;
/**
* <p>
- * Test case for <code>SetNestedPropertiesRule</code>. This contains tests for
the main applications of the rule and two
+ * Test case for {@code SetNestedPropertiesRule}. This contains tests for the
main applications of the rule and two
* more general tests of digester functionality used by this rule.
*/
public class SetNestedPropertiesRuleTestCase
diff --git
a/core/src/test/java/org/apache/commons/digester3/SetPropertiesRuleTestCase.java
b/core/src/test/java/org/apache/commons/digester3/SetPropertiesRuleTestCase.java
index a427820..cf4b461 100644
---
a/core/src/test/java/org/apache/commons/digester3/SetPropertiesRuleTestCase.java
+++
b/core/src/test/java/org/apache/commons/digester3/SetPropertiesRuleTestCase.java
@@ -33,7 +33,7 @@ import org.xml.sax.SAXException;
/**
* <p>
- * Test case for <code>SetPropertiesRule</code>.
+ * Test case for {@code SetPropertiesRule}.
* </p>
*/
public class SetPropertiesRuleTestCase
diff --git
a/core/src/test/java/org/apache/commons/digester3/SetPropertyRuleTestCase.java
b/core/src/test/java/org/apache/commons/digester3/SetPropertyRuleTestCase.java
index 76327b4..b30555b 100644
---
a/core/src/test/java/org/apache/commons/digester3/SetPropertyRuleTestCase.java
+++
b/core/src/test/java/org/apache/commons/digester3/SetPropertyRuleTestCase.java
@@ -37,7 +37,7 @@ import org.xml.sax.SAXException;
/**
* <p>
- * Test case for <code>SetPropertyRule</code>.
+ * Test case for {@code SetPropertyRule}.
* </p>
*/
public class SetPropertyRuleTestCase
diff --git a/core/src/test/java/org/apache/commons/digester3/TestRule.java
b/core/src/test/java/org/apache/commons/digester3/TestRule.java
index 074c539..8775fbc 100644
--- a/core/src/test/java/org/apache/commons/digester3/TestRule.java
+++ b/core/src/test/java/org/apache/commons/digester3/TestRule.java
@@ -38,7 +38,7 @@ public class TestRule
// ----------------------------------------------------- Instance Variables
- /** String identifing this particular <code>TestRule</code> */
+ /** String identifing this particular {@code TestRule} */
private final String identifier;
/** Used when testing body text */
diff --git a/core/src/test/java/org/apache/commons/digester3/URLTestCase.java
b/core/src/test/java/org/apache/commons/digester3/URLTestCase.java
index cc0df48..5f8c9a2 100644
--- a/core/src/test/java/org/apache/commons/digester3/URLTestCase.java
+++ b/core/src/test/java/org/apache/commons/digester3/URLTestCase.java
@@ -28,7 +28,7 @@ import org.junit.Test;
/**
* <p>
- * Unit tests that exercise the new (in 1.8) methods for passing in
<code>URL</code> arguments instead of strings.
+ * Unit tests that exercise the new (in 1.8) methods for passing in {@code
URL} arguments instead of strings.
* </p>
*/
public class URLTestCase
@@ -86,7 +86,7 @@ public class URLTestCase
/**
* <p>
- * The <code>Digester</code> instance under test.
+ * The {@code Digester} instance under test.
* </p>
*/
private Digester digester = null;
diff --git
a/examples/plugins/pipeline/src/main/java/org/apache/commons/digester3/examples/plugins/pipeline/Pipeline.java
b/examples/plugins/pipeline/src/main/java/org/apache/commons/digester3/examples/plugins/pipeline/Pipeline.java
index 59f11cd..2dabce9 100644
---
a/examples/plugins/pipeline/src/main/java/org/apache/commons/digester3/examples/plugins/pipeline/Pipeline.java
+++
b/examples/plugins/pipeline/src/main/java/org/apache/commons/digester3/examples/plugins/pipeline/Pipeline.java
@@ -25,7 +25,7 @@ import java.io.*;
/**
* This is the "main" class for this example.
* <p>
- * It can be run via <code>java Pipeline config-file-name</code>.
+ * It can be run via {@code java Pipeline config-file-name}.
* <p>
* The specified config file is parsed using the Apache Commons Digester.
* This config file specifies an input file to be read, a number of
diff --git
a/examples/rss/src/main/java/org/apache/commons/digester3/rss/Channel.java
b/examples/rss/src/main/java/org/apache/commons/digester3/rss/Channel.java
index 65ecf87..a529c33 100644
--- a/examples/rss/src/main/java/org/apache/commons/digester3/rss/Channel.java
+++ b/examples/rss/src/main/java/org/apache/commons/digester3/rss/Channel.java
@@ -432,7 +432,7 @@ public class Channel
* to the specified output stream, with the specified character encoding.
*
* @param stream The output stream to write to
- * @param encoding The character encoding to declare, or <code>null</code>
+ * @param encoding The character encoding to declare, or {@code null}
* for no declaration
*
* @throws UnsupportedEncodingException if the named encoding
@@ -470,7 +470,7 @@ public class Channel
* to the specified writer, indicating the specified character encoding.
*
* @param writer The writer to render output to
- * @param encoding The character encoding to declare, or <code>null</code>
+ * @param encoding The character encoding to declare, or {@code null}
* for no declaration
*/
public void render( final Writer writer, final String encoding )
@@ -496,7 +496,7 @@ public class Channel
* to the specified writer, indicating the specified character encoding.
*
* @param writer The writer to render output to
- * @param encoding The character encoding to declare, or <code>null</code>
+ * @param encoding The character encoding to declare, or {@code null}
* for no declaration
*/
public void render( final PrintWriter writer, final String encoding )
diff --git
a/examples/rss/src/main/java/org/apache/commons/digester3/rss/RSSDigester.java
b/examples/rss/src/main/java/org/apache/commons/digester3/rss/RSSDigester.java
index bc40434..30e410c 100644
---
a/examples/rss/src/main/java/org/apache/commons/digester3/rss/RSSDigester.java
+++
b/examples/rss/src/main/java/org/apache/commons/digester3/rss/RSSDigester.java
@@ -34,10 +34,10 @@ import org.xml.sax.SAXException;
* see the <a href="http://my.netscape.com/publish/";>My Netscape</a> site.</p>
*
* <p>The default implementation object returned by calling
- * <code>parse()</code> (an instance of
- * <code>org.apache.commons.digester3.rss.Channel</code>)
- * knows how to render itself in XML format via the <code>render()</code>
- * method. See the test <code>main()</code> method below for an
+ * {@code parse()} (an instance of
+ * {@code org.apache.commons.digester3.rss.Channel})
+ * knows how to render itself in XML format via the {@code render()}
+ * method. See the test {@code main()} method below for an
* example of using these classes.</p>
*/
@@ -57,7 +57,7 @@ public class RSSDigester
// ------------------------------------------------------------- Properties
/**
- * The fully qualified class name of the <code>Channel</code>
+ * The fully qualified class name of the {@code Channel}
* implementation class.
*/
protected String channelClass = "org.apache.commons.digester3.rss.Channel";
@@ -73,7 +73,7 @@ public class RSSDigester
}
/**
- * The fully qualified class name of the <code>Image</code>
+ * The fully qualified class name of the {@code Image}
* implementation class.
*/
protected String imageClass = "org.apache.commons.digester3.rss.Image";
@@ -89,7 +89,7 @@ public class RSSDigester
}
/**
- * The fully qualified class name of the <code>Item</code>
+ * The fully qualified class name of the {@code Item}
* implementation class.
*/
protected String itemClass = "org.apache.commons.digester3.rss.Item";
@@ -105,7 +105,7 @@ public class RSSDigester
}
/**
- * The fully qualified class name of the <code>TextInput</code>
+ * The fully qualified class name of the {@code TextInput}
* implementation class.
*/
protected String textInputClass =
"org.apache.commons.digester3.rss.TextInput";
