This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 4d9945793ae3 CAMEL-21356 - Javadoc compliance with doclint for Java 17
in camel-core-catalog, camel-xml-io-util, camel-core-engine and
camel-core-reifier (#29717)
4d9945793ae3 is described below
commit 4d9945793ae3f989fc8c9725cbb09ba34e84c75b
Author: Loris Boiteux <[email protected]>
AuthorDate: Thu Nov 12 19:08:59 2026 +0100
CAMEL-21356 - Javadoc compliance with doclint for Java 17 in
camel-core-catalog, camel-xml-io-util, camel-core-engine and camel-core-reifier
(#29717)
Co-authored-by: Claude Opus 5.5 <[email protected]>
---
.../camel/catalog/impl/AbstractCamelCatalog.java | 10 ++--
.../apache/camel/catalog/impl/CatalogHelper.java | 36 ++++++------
.../org/apache/camel/impl/DefaultCamelContext.java | 4 +-
.../org/apache/camel/reifier/AbstractReifier.java | 6 +-
.../org/apache/camel/reifier/CacheReifier.java | 2 +-
.../camel/reifier/IdempotentConsumerReifier.java | 2 +-
.../org/apache/camel/reifier/ProcessorReifier.java | 64 +++++++++++-----------
.../camel/reifier/language/ExpressionReifier.java | 4 +-
.../camel/xml/io/util/XmlStreamDetector.java | 1 -
.../apache/camel/xml/io/util/XmlStreamReader.java | 8 +--
10 files changed, 66 insertions(+), 71 deletions(-)
diff --git
a/core/camel-core-catalog/src/main/java/org/apache/camel/catalog/impl/AbstractCamelCatalog.java
b/core/camel-core-catalog/src/main/java/org/apache/camel/catalog/impl/AbstractCamelCatalog.java
index de0015bde178..9c6fe38e5c4c 100644
---
a/core/camel-core-catalog/src/main/java/org/apache/camel/catalog/impl/AbstractCamelCatalog.java
+++
b/core/camel-core-catalog/src/main/java/org/apache/camel/catalog/impl/AbstractCamelCatalog.java
@@ -1500,11 +1500,11 @@ public abstract class AbstractCamelCatalog {
* The placeholders cannot be resolved during validation as we do not run
the actual Camel application with the
* property placeholders setup, and the languages are parsed after the
placeholders have been resolved at runtime.
*
- * A placeholder that is already inside a quoted literal is replaced by
<tt>{{XXX}}</tt> to <tt>~^XXX^~</tt>, and
- * otherwise by <tt>{{XXX}}</tt> to <tt>'~XXX~'</tt>. The quotes are
needed because the languages do not accept a
- * bare unquoted literal as operand, such as in <tt>${body} >=
{{threshold}}</tt>. Both dummies have the same length
- * as the placeholder they replace, so the position reported in a parser
error still points at the same location in
- * the original text.
+ * A placeholder <code>{{XXX}}</code> that is already inside a quoted
literal is replaced by <code>~^XXX^~</code>,
+ * and otherwise by <code>'~XXX~'</code>. The quotes are needed because
the languages do not accept a bare unquoted
+ * literal as operand, such as in <code>${body} >=
{{threshold}}</code>. Both dummies have the same length as the
+ * placeholder they replace, so the position reported in a parser error
still points at the same location in the
+ * original text.
*
* @param text the text
* @return the text with the property placeholders replaced by a
dummy value
diff --git
a/core/camel-core-catalog/src/main/java/org/apache/camel/catalog/impl/CatalogHelper.java
b/core/camel-core-catalog/src/main/java/org/apache/camel/catalog/impl/CatalogHelper.java
index abdf623bd4a5..ec5c65561f0c 100644
---
a/core/camel-core-catalog/src/main/java/org/apache/camel/catalog/impl/CatalogHelper.java
+++
b/core/camel-core-catalog/src/main/java/org/apache/camel/catalog/impl/CatalogHelper.java
@@ -43,10 +43,8 @@ public final class CatalogHelper {
}
/**
- * Loads the entire stream into memory as a String and returns it.
- * <p/>
- * <b>Notice:</b> This implementation appends a <tt>\n</tt> as line
terminator at the of the text.
- * <p/>
+ * Loads the entire stream into memory and adds each line to the given
list.
+ * <p>
* Warning, don't use for crazy big streams :)
*/
public static void loadLines(InputStream in, List<String> lines) throws
IOException {
@@ -60,10 +58,8 @@ public final class CatalogHelper {
}
/**
- * Loads the entire stream into memory as a String and returns it.
- * <p/>
- * <b>Notice:</b> This implementation appends a <tt>\n</tt> as line
terminator at the of the text.
- * <p/>
+ * Loads the entire stream into memory and returns its lines.
+ * <p>
* Warning, don't use for crazy big streams :)
*/
public static List<String> loadLines(InputStream in) throws IOException {
@@ -74,9 +70,9 @@ public final class CatalogHelper {
/**
* Loads the entire stream into memory as a String and returns it.
- * <p/>
- * <b>Notice:</b> This implementation appends a <tt>\n</tt> as line
terminator at the of the text.
- * <p/>
+ * <p>
+ * <b>Notice:</b> This implementation appends a <code>\n</code> as line
terminator at the end of the text.
+ * <p>
* Warning, don't use for crazy big streams :)
*/
public static String loadText(InputStream in) throws IOException {
@@ -88,7 +84,7 @@ public final class CatalogHelper {
*
* @param name the name
* @param pattern the pattern
- * @return <tt>true</tt> if matched, or <tt>false</tt> if not
+ * @return <code>true</code> if matched, or <code>false</code> if
not
*/
public static boolean matchWildcard(String name, String pattern) {
// we have wildcard support in that hence you can match with: file* to
match any file endpoints
@@ -99,9 +95,9 @@ public final class CatalogHelper {
}
/**
- * Tests whether the value is <tt>null</tt> or an empty string.
+ * Tests whether the value is <code>null</code> or a blank string.
*
- * @param value the value, if its a String it will be tested for text
length as well
+ * @param value the value, if it is a String it is also tested for being
blank
* @return true if empty
*/
public static boolean isEmpty(Object value) {
@@ -109,9 +105,9 @@ public final class CatalogHelper {
}
/**
- * Tests whether the value is <b>not</b> <tt>null</tt> or an empty string.
+ * Tests whether the value is <b>not</b> <code>null</code> and not a blank
string.
*
- * @param value the value, if its a String it will be tested for text
length as well
+ * @param value the value, if it is a String it is also tested for being
blank
* @return true if <b>not</b> empty
*/
public static boolean isNotEmpty(Object value) {
@@ -152,10 +148,10 @@ public final class CatalogHelper {
* Parses the query part of the uri (eg the parameters) manually. This
method is mostly used by the CamelCatalog in
* order to be able to handle certain special characters markers (i.e.:
"{{" and "}}"). It should not be used
* anywhere else.
- * <p/>
- * The URI parameters will by default be URI encoded. However, you can
define a parameter values with the syntax:
- * <tt>key=RAW(value)</tt> which tells Camel to not encode the value, and
use the value as is (eg key=value) and the
- * value has <b>not</b> been encoded.
+ * <p>
+ * The URI parameters will by default be URI encoded. However, you can
define parameter values with the syntax:
+ * <code>key=RAW(value)</code> which tells Camel to not encode the value,
and use the value as is (eg key=value) and
+ * the value has <b>not</b> been encoded.
*
* @param uri the uri
* @return the parameters, or an empty map if no
parameters (eg never null)
diff --git
a/core/camel-core-engine/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
b/core/camel-core-engine/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
index 16036421cefc..6117f47a43f5 100644
---
a/core/camel-core-engine/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
+++
b/core/camel-core-engine/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
@@ -111,8 +111,8 @@ public class DefaultCamelContext extends SimpleCamelContext
implements ModelCame
/**
* Creates the {@link ModelCamelContext} using {@link
org.apache.camel.support.DefaultRegistry} as registry.
- * <p/>
- * Use one of the other constructors to force use an explicit registry.
+ * <p>
+ * Use one of the other constructors to force the use of an explicit
registry.
*/
public DefaultCamelContext() {
this(true);
diff --git
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/AbstractReifier.java
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/AbstractReifier.java
index 38e648f82ae7..f9059c5f182a 100644
---
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/AbstractReifier.java
+++
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/AbstractReifier.java
@@ -207,10 +207,10 @@ public abstract class AbstractReifier implements
BeanRepository {
/**
* Looks up a bean by name as {@link #lookupByName(String)} does; the bean
may be of any type (such as a POJO that
- * is adapted afterwards). A <tt>#class:</tt> whose class does not exist
fails here, with the built-in bean of the
- * expected type that was likely meant, instead of answering <tt>null</tt>.
+ * is adapted afterwards). A <code>#class:</code> whose class does not
exist fails here, with the built-in bean of
+ * the expected type that was likely meant, instead of answering
<code>null</code>.
*
- * @param name the bean name or <tt>#class:</tt> reference
+ * @param name the bean name or <code>#class:</code> reference
* @param expectedType the type the bean is expected to be, for the error
message only
*/
public Object lookupByName(String name, Class<?> expectedType) {
diff --git
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/CacheReifier.java
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/CacheReifier.java
index eba5a57f7239..5affe7779418 100644
---
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/CacheReifier.java
+++
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/CacheReifier.java
@@ -58,7 +58,7 @@ public class CacheReifier extends
ExpressionReifier<CacheDefinition> {
/**
* Strategy method to resolve the {@link KeyValueRepository} to use.
- * <p/>
+ * <p>
* Resolution order:
* <ol>
* <li>Explicit bean set programmatically</li>
diff --git
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/IdempotentConsumerReifier.java
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/IdempotentConsumerReifier.java
index 5773d481f287..a19aa2c95208 100644
---
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/IdempotentConsumerReifier.java
+++
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/IdempotentConsumerReifier.java
@@ -61,7 +61,7 @@ public class IdempotentConsumerReifier extends
ExpressionReifier<IdempotentConsu
/**
* Strategy method to resolve the {@link
org.apache.camel.spi.IdempotentRepository} to use.
- * <p/>
+ * <p>
* If no explicit {@link IdempotentRepository} is configured (neither as a
bean reference nor inline), this method
* falls back to looking up a {@link KeyValueRepository} from the Camel
registry and wrapping it in a
* {@link KeyValueIdempotentRepository} adapter.
diff --git
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ProcessorReifier.java
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ProcessorReifier.java
index cd149d697471..e3ec310310d5 100644
---
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ProcessorReifier.java
+++
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ProcessorReifier.java
@@ -359,13 +359,13 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
/**
* Determines whether a new thread pool will be created or not.
- * <p/>
+ * <p>
* This is used to know if a new thread pool will be created, and
therefore is not shared by others, and therefore
* exclusive to the definition.
*
* @param definition the node definition which may leverage executor
service.
- * @param useDefault whether to fallback and use a default thread pool,
if no explicit configured
- * @return <tt>true</tt> if a new thread pool will be created,
<tt>false</tt> if not
+ * @param useDefault whether to fallback and use a default thread pool,
if none is explicitly configured
+ * @return <code>true</code> if a new thread pool will be
created, <code>false</code> if not
* @see #getConfiguredExecutorService(String,
ExecutorServiceAwareDefinition, boolean)
*/
public boolean willCreateNewThreadPool(ExecutorServiceAwareDefinition<?>
definition, boolean useDefault) {
@@ -389,13 +389,13 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
/**
* Will look up and get the configured {@link ExecutorService} from the
given definition.
- * <p/>
+ * <p>
* This method will look up for configured thread pool in the following
order
* <ul>
- * <li>from the definition if any explicit configured executor
service.</li>
+ * <li>from the definition, if an executor service is explicitly
configured.</li>
* <li>from the {@link org.apache.camel.spi.Registry} if found</li>
* <li>from the known list of {@link
org.apache.camel.spi.ThreadPoolProfile ThreadPoolProfile(s)}.</li>
- * <li>if none found, then <tt>null</tt> is returned.</li>
+ * <li>if none found, then <code>null</code> is returned.</li>
* </ul>
* The various {@link ExecutorServiceAwareDefinition} should use this
helper method to ensure they support
* configured executor services in the same coherent way.
@@ -403,8 +403,9 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
* @param name name which is appended to the thread
name, when the {@link ExecutorService} is
* created based on a {@link
org.apache.camel.spi.ThreadPoolProfile}.
* @param definition the node definition which may leverage
executor service.
- * @param useDefault whether to fallback and use a default
thread pool, if no explicit configured
- * @return the configured executor service, or
<tt>null</tt> if none was configured.
+ * @param useDefault whether to fallback and use a default
thread pool, if none is explicitly
+ * configured
+ * @return the configured executor service, or
<code>null</code> if none was configured.
* @throws IllegalArgumentException is thrown if lookup of executor
service in {@link org.apache.camel.spi.Registry}
* was not found
*/
@@ -437,13 +438,13 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
/**
* Will look up and get the configured {@link
java.util.concurrent.ScheduledExecutorService} from the given
* definition.
- * <p/>
+ * <p>
* This method will look up for configured thread pool in the following
order
* <ul>
- * <li>from the definition if any explicit configured executor
service.</li>
+ * <li>from the definition, if an executor service is explicitly
configured.</li>
* <li>from the {@link org.apache.camel.spi.Registry} if found</li>
* <li>from the known list of {@link
org.apache.camel.spi.ThreadPoolProfile ThreadPoolProfile(s)}.</li>
- * <li>if none found, then <tt>null</tt> is returned.</li>
+ * <li>if none found, then <code>null</code> is returned.</li>
* </ul>
* The various {@link ExecutorServiceAwareDefinition} should use this
helper method to ensure they support
* configured executor services in the same coherent way.
@@ -451,8 +452,9 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
* @param name name which is appended to the thread
name, when the {@link ExecutorService} is
* created based on a {@link
org.apache.camel.spi.ThreadPoolProfile}.
* @param definition the node definition which may leverage
executor service.
- * @param useDefault whether to fallback and use a default
thread pool, if no explicit configured
- * @return the configured executor service, or
<tt>null</tt> if none was configured.
+ * @param useDefault whether to fallback and use a default
thread pool, if none is explicitly
+ * configured
+ * @return the configured executor service, or
<code>null</code> if none was configured.
* @throws IllegalArgumentException is thrown if the found instance is not
a ScheduledExecutorService type, or
* lookup of executor service in {@link
org.apache.camel.spi.Registry} was not
* found
@@ -491,20 +493,20 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
/**
* Will lookup in {@link org.apache.camel.spi.Registry} for a {@link
ScheduledExecutorService} registered with the
- * given <tt>executorServiceRef</tt> name.
- * <p/>
+ * given <code>executorServiceRef</code> name.
+ * <p>
* This method will lookup for configured thread pool in the following
order
* <ul>
* <li>from the {@link org.apache.camel.spi.Registry} if found</li>
* <li>from the known list of {@link
org.apache.camel.spi.ThreadPoolProfile ThreadPoolProfile(s)}.</li>
- * <li>if none found, then <tt>null</tt> is returned.</li>
+ * <li>if none found, then <code>null</code> is returned.</li>
* </ul>
*
* @param name name which is appended to the thread name,
when the {@link ExecutorService} is created
* based on a {@link
org.apache.camel.spi.ThreadPoolProfile}.
* @param source the source to use the thread pool
* @param executorServiceRef reference name of the thread pool
- * @return the executor service, or <tt>null</tt> if
none was found.
+ * @return the executor service, or <code>null</code>
if none was found.
*/
public ScheduledExecutorService lookupScheduledExecutorServiceRef(
String name, Object source,
@@ -525,20 +527,20 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
/**
* Will lookup in {@link org.apache.camel.spi.Registry} for a {@link
ExecutorService} registered with the given
- * <tt>executorServiceRef</tt> name.
- * <p/>
+ * <code>executorServiceRef</code> name.
+ * <p>
* This method will lookup for configured thread pool in the following
order
* <ul>
* <li>from the {@link org.apache.camel.spi.Registry} if found</li>
* <li>from the known list of {@link
org.apache.camel.spi.ThreadPoolProfile ThreadPoolProfile(s)}.</li>
- * <li>if none found, then <tt>null</tt> is returned.</li>
+ * <li>if none found, then <code>null</code> is returned.</li>
* </ul>
*
* @param name name which is appended to the thread name,
when the {@link ExecutorService} is created
* based on a {@link
org.apache.camel.spi.ThreadPoolProfile}.
* @param source the source to use the thread pool
* @param executorServiceRef reference name of the thread pool
- * @return the executor service, or <tt>null</tt> if
none was found.
+ * @return the executor service, or <code>null</code>
if none was found.
*/
public ExecutorService lookupExecutorServiceRef(String name, Object
source, String executorServiceRef) {
ExecutorServiceManager manager =
camelContext.getExecutorServiceManager();
@@ -556,13 +558,13 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
}
/**
- * Is there any outputs in the given list.
- * <p/>
- * Is used for check if the route output has any real outputs (non
abstracts)
+ * Are there any outputs in the given list.
+ * <p>
+ * Is used to check if the route output has any real outputs (non
abstracts)
*
* @param outputs the outputs
* @param excludeAbstract whether or not to exclude abstract outputs
(e.g. skip onException etc.)
- * @return <tt>true</tt> if has outputs, otherwise
<tt>false</tt> is returned
+ * @return <code>true</code> if has outputs, otherwise
<code>false</code> is returned
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
public boolean hasOutputs(List<ProcessorDefinition<?>> outputs, boolean
excludeAbstract) {
@@ -601,8 +603,8 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
/**
* Creates the child processor (outputs) from the current definition
*
- * @param mandatory whether or not children is mandatory (ie the
definition should have outputs)
- * @return the created children, or <tt>null</tt> if definition
had no output
+ * @param mandatory whether or not children are mandatory (ie the
definition should have outputs)
+ * @return the created children, or <code>null</code> if
definition had no output
* @throws Exception is thrown if error creating the child or if it was
mandatory and there was no output defined on
* definition
*/
@@ -911,15 +913,15 @@ public abstract class ProcessorReifier<T extends
ProcessorDefinition<?>> extends
/**
* Will lookup and get the configured {@link AggregationStrategy} from the
given definition.
- * <p/>
+ * <p>
* This method will lookup for configured aggregation strategy in the
following order
* <ul>
- * <li>from the definition if any explicit configured aggregation
strategy.</li>
+ * <li>from the definition, if an aggregation strategy is explicitly
configured.</li>
* <li>from the {@link org.apache.camel.spi.Registry} if found</li>
- * <li>if none found, then <tt>null</tt> is returned.</li>
+ * <li>if none found, then <code>null</code> is returned.</li>
* </ul>
* The various {@link AggregationStrategyAwareDefinition} should use this
helper method to ensure they support
- * configured executor services in the same coherent way.
+ * configured aggregation strategies in the same coherent way.
*
* @param definition the node definition which may leverage
aggregation strategy
* @throws IllegalArgumentException is thrown if lookup of aggregation
strategy in
diff --git
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/language/ExpressionReifier.java
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/language/ExpressionReifier.java
index 0e995ae41a00..2cf36efd52d9 100644
---
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/language/ExpressionReifier.java
+++
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/language/ExpressionReifier.java
@@ -185,8 +185,8 @@ public class ExpressionReifier<T extends
ExpressionDefinition> extends AbstractR
}
/**
- * Wraps the expression so a result that is a String starting with
<tt>resource:</tt> is loaded and its content is
- * the result (resolveResource=true, CAMEL-24884). A name without a scheme
is a classpath resource. Applies to
+ * Wraps the expression so a result that is a String starting with
<code>resource:</code> is loaded and its content
+ * is the result (resolveResource=true, CAMEL-24884). A name without a
scheme is a classpath resource. Applies to
* expressions only: a predicate answers true or false, there is no
resource to load in its result.
*/
private Expression resolveResourceResult(Expression delegate) {
diff --git
a/core/camel-xml-io-util/src/main/java/org/apache/camel/xml/io/util/XmlStreamDetector.java
b/core/camel-xml-io-util/src/main/java/org/apache/camel/xml/io/util/XmlStreamDetector.java
index db9e455bfd67..909c249caebe 100644
---
a/core/camel-xml-io-util/src/main/java/org/apache/camel/xml/io/util/XmlStreamDetector.java
+++
b/core/camel-xml-io-util/src/main/java/org/apache/camel/xml/io/util/XmlStreamDetector.java
@@ -36,7 +36,6 @@ import javax.xml.stream.XMLStreamReader;
* <li>prefix:namespace mapping declared at root element</li>
* <li>modeline declarations before root element</li>
* </ul>
- * </p>
*
* <p>
* While we can have any kind of XML document and the namespaced content may
be available at various places in the
diff --git
a/core/camel-xml-io-util/src/main/java/org/apache/camel/xml/io/util/XmlStreamReader.java
b/core/camel-xml-io-util/src/main/java/org/apache/camel/xml/io/util/XmlStreamReader.java
index af2f039eed46..c1d5473f71a7 100644
---
a/core/camel-xml-io-util/src/main/java/org/apache/camel/xml/io/util/XmlStreamReader.java
+++
b/core/camel-xml-io-util/src/main/java/org/apache/camel/xml/io/util/XmlStreamReader.java
@@ -399,9 +399,8 @@ public class XmlStreamReader extends Reader {
/**
* Returns the default encoding to use if none is set in HTTP
content-type, XML prolog and the rules based on
* content-type are not adequate.
- * <p/>
+ * <p>
* If it is NULL the content-type based rules are used.
- * <p/>
*
* @return the default encoding to use.
*/
@@ -412,11 +411,10 @@ public class XmlStreamReader extends Reader {
/**
* Sets the default encoding to use if none is set in HTTP content-type,
XML prolog and the rules based on
* content-type are not adequate.
- * <p/>
+ * <p>
* If it is set to NULL the content-type based rules are used.
- * <p/>
+ * <p>
* By default it is NULL.
- * <p/>
*
* @param encoding charset encoding to default to.
*/
