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 227c34433b69 CAMEL-21356: Javadoc compliance with doclint for Java 17
in camel-management-api, camel-xml-jaxp and camel-java-io (#29652)
227c34433b69 is described below
commit 227c34433b69a3cdcdc24f736599f185d91d68c4
Author: Loris Boiteux <[email protected]>
AuthorDate: Wed Nov 11 21:03:17 2026 +0100
CAMEL-21356: Javadoc compliance with doclint for Java 17 in
camel-management-api, camel-xml-jaxp and camel-java-io (#29652)
Fix the Javadoc of camel-management-api, camel-xml-jaxp and camel-java-io
so it passes doclint:
<tt> becomes <code>, <p/> becomes <p>, unresolvable {@link} become {@code},
and the touched blocks get
their wording corrected.
Co-authored-by: Claude Opus 5.5 <[email protected]>
---
.../org/apache/camel/java/in/ChainReplayer.java | 2 +-
.../org/apache/camel/java/in/ConstantResolver.java | 2 +-
.../apache/camel/java/in/EndpointDslResolver.java | 2 +-
.../org/apache/camel/java/in/LwJavaParser.java | 4 ++--
.../org/apache/camel/java/in/ModelNormalizer.java | 4 ++--
.../camel/java/in/NamingEndpointDslResolver.java | 2 +-
.../JmxNotificationBroadcasterAware.java | 2 +-
.../camel/api/management/ManagedCamelContext.java | 26 +++++++++++-----------
.../mbean/ComponentVerifierExtension.java | 2 +-
.../management/mbean/ManagedCamelContextMBean.java | 3 ++-
.../mbean/ManagedStreamCachingStrategyMBean.java | 2 +-
.../support/processor/validation/SchemaReader.java | 2 +-
.../processor/validation/ValidatingProcessor.java | 9 ++++----
.../org/apache/camel/util/xml/SourceCache.java | 4 ++--
.../apache/camel/util/xml/StreamSourceCache.java | 4 ++--
15 files changed, 35 insertions(+), 35 deletions(-)
diff --git
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/ChainReplayer.java
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/ChainReplayer.java
index 21080e22f456..7420a36471a3 100644
---
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/ChainReplayer.java
+++
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/ChainReplayer.java
@@ -84,7 +84,7 @@ import org.apache.camel.support.builder.Namespaces;
* Builds the model by replaying the chains of a Java source against Camel's
own DSL: {@code from("a").to("b")} calls
* {@code from("a")} on a route builder and {@code to("b")} on the route it
returns. So {@code end()}, blocks,
* expression clauses and ids behave exactly as in a compiled route, for every
EIP.
- * <p/>
+ * <p>
* Nothing of the parsed project runs or is loaded. Only methods of Camel's
model and builder types are called (see
* {@link #isAllowed(Method)}); a class of the project becomes an empty stub
with its name ({@link StubClassLoader}); a
* lambda, an anonymous class or {@code new Foo()} becomes a placeholder
object of the type the DSL asks for; a value
diff --git
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/ConstantResolver.java
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/ConstantResolver.java
index 5bbb0627834d..721d5344d83c 100644
---
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/ConstantResolver.java
+++
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/ConstantResolver.java
@@ -20,7 +20,7 @@ package org.apache.camel.java.in;
* The value of a constant the parser cannot read itself: one of a class that
is not on its class path, such as a
* component's header constant ({@code KafkaConstants.KEY}) or a constant of
another source file of the project
* ({@code Application.QUEUE}). The parser asks it before it reports the
constant as unresolved.
- * <p/>
+ * <p>
* A tool plugs one in with {@link
LwJavaParser#setConstantResolver(ConstantResolver)}: with the Camel catalog it
knows
* every component's header constants, with the project's sources it knows
their constants.
*/
diff --git
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/EndpointDslResolver.java
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/EndpointDslResolver.java
index 1b7f012d7b28..c56e4ca73a86 100644
---
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/EndpointDslResolver.java
+++
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/EndpointDslResolver.java
@@ -21,7 +21,7 @@ import java.util.List;
/**
* Turns a call of the endpoint DSL, {@code
kafka("orders").brokers("b:9092")}, into the endpoint URI it stands for,
* {@code kafka://orders?brokers=b:9092}, without the endpoint DSL on the
class path.
- * <p/>
+ * <p>
* {@link #NAMING} works by the rules the endpoint DSL is generated with, and
needs nothing. A tool with the Camel
* catalog can plug in its own (see {@link
LwJavaParser#setEndpointDslResolver(EndpointDslResolver)}) to also confirm
* the component exists, check option names, and know the prefix of
multi-value options.
diff --git
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/LwJavaParser.java
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/LwJavaParser.java
index 88c8aa2335f2..1f3d0b5c3675 100644
---
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/LwJavaParser.java
+++
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/LwJavaParser.java
@@ -22,11 +22,11 @@ import java.util.Map;
/**
* Reads the routes of a Java DSL source into the Camel model without
compiling it (CAMEL-25148), the reverse of
* {@link org.apache.camel.java.LwModelToJavaDumper}.
- * <p/>
+ * <p>
* It reads the source as text: the imports, the constants of the class, and
the statements of {@code configure()} (or
* the statements of a snippet), then replays each chain of calls against
Camel's own DSL to build the model. Nothing of
* the project is compiled, loaded or run, so it needs no classpath of the
project and takes milliseconds.
- * <p/>
+ * <p>
* What it cannot work out is reported in {@link
JavaParseResult#unresolved()}, and a value it could not work out is
* kept in the model as {@code ?{source text}}: values computed at runtime or
in helper methods, routes built in loops,
* lambdas and processors, the endpoint DSL.
diff --git
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/ModelNormalizer.java
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/ModelNormalizer.java
index e0706bffa2d5..680ea1d07ae3 100644
---
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/ModelNormalizer.java
+++
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/ModelNormalizer.java
@@ -35,11 +35,11 @@ import org.apache.camel.support.builder.ValueBuilder;
/**
* Makes a replayed model what the other DSLs have, so tools see one model
whatever the DSL.
- * <p/>
+ * <p>
* Classes: the Java DSL keeps a class as a {@link Class} ({@code
throwException(Foo.class, "msg")},
* {@code convertBodyTo(byte[].class)}), where XML and YAML keep its name in a
String option next to it
* ({@code exceptionType}, {@code type}); the name is filled in.
- * <p/>
+ * <p>
* Expressions: they are made plain languages where they can be. The Java DSL
keeps an expression clause
* ({@code setHeader("x").constant("y")}) or a value builder ({@code
header("x")}) as an object wrapped in an
* {@link ExpressionDefinition}, which no DSL can write back; the language
inside it ({@code constant}, {@code header},
diff --git
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/NamingEndpointDslResolver.java
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/NamingEndpointDslResolver.java
index c96df5f98b46..22e685fe00c1 100644
---
a/core/camel-java-io/src/main/java/org/apache/camel/java/in/NamingEndpointDslResolver.java
+++
b/core/camel-java-io/src/main/java/org/apache/camel/java/in/NamingEndpointDslResolver.java
@@ -26,7 +26,7 @@ import java.util.regex.Pattern;
* ({@code platformHttp} is {@code platform-http}), its argument is the path,
and each builder method is the option of
* the same name. The URI is built as the endpoint DSL builds it for producers
and consumers alike:
* {@code scheme://path?option=value&...}.
- * <p/>
+ * <p>
* Without the catalog it cannot tell a component from any other method of
that name, so the parser only asks it for
* sources that use the endpoint DSL; nor does it know the prefix of a
multi-value option.
*/
diff --git
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/JmxNotificationBroadcasterAware.java
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/JmxNotificationBroadcasterAware.java
index 36508a8030c0..b645679f0336 100644
---
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/JmxNotificationBroadcasterAware.java
+++
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/JmxNotificationBroadcasterAware.java
@@ -20,7 +20,7 @@ import javax.management.NotificationBroadcasterSupport;
/**
* Strategy to use a custom {@link NotificationBroadcasterSupport} when
broadcasting JMX notifications using for example
- * the {@link org.apache.camel.management.JmxNotificationEventNotifier}.
+ * the {@code org.apache.camel.management.JmxNotificationEventNotifier}.
*/
public interface JmxNotificationBroadcasterAware {
diff --git
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/ManagedCamelContext.java
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/ManagedCamelContext.java
index c20d31164127..5df4bb44a9ff 100644
---
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/ManagedCamelContext.java
+++
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/ManagedCamelContext.java
@@ -33,31 +33,31 @@ public interface ManagedCamelContext {
ManagedCamelContextMBean getManagedCamelContext();
/**
- * Gets the managed processor client api from any of the routes which with
the given id
+ * Gets the managed processor client api with the given id, from any of
the routes
*
* @param id id of the processor
- * @return the processor or <tt>null</tt> if not found
+ * @return the processor or <code>null</code> if not found
*/
default ManagedProcessorMBean getManagedProcessor(String id) {
return getManagedProcessor(id, ManagedProcessorMBean.class);
}
/**
- * Gets the managed processor client api from any of the routes which with
the given id
+ * Gets the managed processor client api with the given id, from any of
the routes
*
* @param id id of the processor
* @param type the managed processor type from the
* {@link
org.apache.camel.api.management.mbean} package.
- * @return the processor or <tt>null</tt> if not
found
+ * @return the processor or <code>null</code> if
not found
* @throws IllegalArgumentException if the type is not compliant
*/
<T extends ManagedProcessorMBean> T getManagedProcessor(String id,
Class<T> type);
/**
- * Gets the managed step client api from any of the routes which with the
given id
+ * Gets the managed step client api with the given id, from any of the
routes
*
* @param id id of the step
- * @return the step or <tt>null</tt> if not found
+ * @return the step or <code>null</code> if not found
*/
ManagedStepMBean getManagedStep(String id);
@@ -65,7 +65,7 @@ public interface ManagedCamelContext {
* Gets the managed route client api with the given route id
*
* @param routeId id of the route
- * @return the route or <tt>null</tt> if not found
+ * @return the route or <code>null</code> if not found
*/
default ManagedRouteMBean getManagedRoute(String routeId) {
return getManagedRoute(routeId, ManagedRouteMBean.class);
@@ -77,7 +77,7 @@ public interface ManagedCamelContext {
* @param routeId id of the route
* @param type the managed route type from the {@link
org.apache.camel.api.management.mbean}
* package.
- * @return the route or <tt>null</tt> if not found
+ * @return the route or <code>null</code> if not
found
* @throws IllegalArgumentException if the type is not compliant
*/
<T extends ManagedRouteMBean> T getManagedRoute(String routeId, Class<T>
type);
@@ -93,7 +93,7 @@ public interface ManagedCamelContext {
* Gets the managed route group client api with the given route group
*
* @param group the name of the group
- * @return the route group or <tt>null</tt> if not found
+ * @return the route group or <code>null</code> if not found
*/
ManagedRouteGroupMBean getManagedRouteGroup(String group);
@@ -106,22 +106,22 @@ public interface ManagedCamelContext {
List<ManagedRouteMBean> getManagedRoutesByGroup(String groupId);
/**
- * Gets the managed consumer client api from any of the routes which with
the given route id
+ * Gets the managed consumer client api of the route with the given route
id
*
* @param id route id having the consumer
- * @return the consumer or <tt>null</tt> if not found
+ * @return the consumer or <code>null</code> if not found
*/
default ManagedConsumerMBean getManagedConsumer(String id) {
return getManagedConsumer(id, ManagedConsumerMBean.class);
}
/**
- * Gets the managed consumer client api from any of the routes which with
the given route id
+ * Gets the managed consumer client api of the route with the given route
id
*
* @param id route id having the consumer
* @param type the managed consumer type from the
{@link org.apache.camel.api.management.mbean}
* package.
- * @return the consumer or <tt>null</tt> if not
found
+ * @return the consumer or <code>null</code> if
not found
* @throws IllegalArgumentException if the type is not compliant
*/
<T extends ManagedConsumerMBean> T getManagedConsumer(String id, Class<T>
type);
diff --git
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ComponentVerifierExtension.java
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ComponentVerifierExtension.java
index 7feb583efae4..63ef945dd6e5 100644
---
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ComponentVerifierExtension.java
+++
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ComponentVerifierExtension.java
@@ -32,7 +32,7 @@ import
org.apache.camel.api.management.mbean.ComponentVerifierExtension.Verifica
* Defines the interface used for validating component/endpoint parameters.
The central method of this interface is
* {@link ManagedComponentMBean#verify(String, Map)} which takes a scope and a
set of parameters which should be
* verified.
- * <p/>
+ * <p>
* The return value is a {@link ComponentVerifierExtension.Result} of the
verification
*/
public final class ComponentVerifierExtension {
diff --git
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
index 8b2640d55ec5..f5a90389f315 100644
---
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
+++
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
@@ -267,7 +267,8 @@ public interface ManagedCamelContextMBean extends
ManagedPerformanceCounterMBean
* Creates the endpoint by the given uri
*
* @param uri uri of endpoint to create
- * @return <tt>true</tt> if a new endpoint was created,
<tt>false</tt> if the endpoint already existed
+ * @return <code>true</code> if a new endpoint was created,
<code>false</code> if the endpoint already
+ * existed
* @throws Exception is thrown if error occurred
*/
@ManagedOperation(description = "Creates the endpoint by the given URI")
diff --git
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedStreamCachingStrategyMBean.java
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedStreamCachingStrategyMBean.java
index ff16b2da1c5a..c1842ee4684c 100644
---
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedStreamCachingStrategyMBean.java
+++
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedStreamCachingStrategyMBean.java
@@ -22,7 +22,7 @@ import org.apache.camel.api.management.ManagedOperation;
public interface ManagedStreamCachingStrategyMBean extends ManagedServiceMBean
{
/**
- * Used for selecting if the memory limit is <tt>committed</tt> or
<tt>maximum</tt> heap memory setting.
+ * Used for selecting if the memory limit is <code>committed</code> or
<code>maximum</code> heap memory setting.
*/
enum SpoolUsedHeapMemoryLimit {
Committed,
diff --git
a/core/camel-xml-jaxp/src/main/java/org/apache/camel/support/processor/validation/SchemaReader.java
b/core/camel-xml-jaxp/src/main/java/org/apache/camel/support/processor/validation/SchemaReader.java
index c8285ce3dff2..1445b873984d 100644
---
a/core/camel-xml-jaxp/src/main/java/org/apache/camel/support/processor/validation/SchemaReader.java
+++
b/core/camel-xml-jaxp/src/main/java/org/apache/camel/support/processor/validation/SchemaReader.java
@@ -44,7 +44,7 @@ import org.slf4j.LoggerFactory;
/**
* Reads the schema used in the processor {@link ValidatingProcessor}. A
schema re-reading could be forced using
- * {@link
org.apache.camel.component.validator.ValidatorEndpoint#clearCachedSchema()}.
+ * {@code
org.apache.camel.component.validator.ValidatorEndpoint#clearCachedSchema()}.
*/
public class SchemaReader {
diff --git
a/core/camel-xml-jaxp/src/main/java/org/apache/camel/support/processor/validation/ValidatingProcessor.java
b/core/camel-xml-jaxp/src/main/java/org/apache/camel/support/processor/validation/ValidatingProcessor.java
index 240efaf3a889..d58cf5d9aa54 100644
---
a/core/camel-xml-jaxp/src/main/java/org/apache/camel/support/processor/validation/ValidatingProcessor.java
+++
b/core/camel-xml-jaxp/src/main/java/org/apache/camel/support/processor/validation/ValidatingProcessor.java
@@ -322,12 +322,11 @@ public class ValidatingProcessor extends
AsyncProcessorSupport {
/**
* Checks whether we need an {@link InputStream} to access the message
body or header.
- * <p/>
+ * <p>
* Depending on the content in the message body or header, we may not need
to convert to {@link InputStream}.
*
* @param exchange the current exchange
- * @return <tt>true</tt> to convert to {@link InputStream}
beforehand converting to {@link Source}
- * afterward.
+ * @return <code>true</code> to convert to {@link InputStream}
before converting to {@link Source}
*/
protected boolean isInputStreamNeeded(Exchange exchange) {
Object content = getContentToValidate(exchange);
@@ -355,10 +354,10 @@ public class ValidatingProcessor extends
AsyncProcessorSupport {
/**
* Converts the inbound body or header to a {@link Source}, if it is
<b>not</b> already a {@link Source}.
- * <p/>
+ * <p>
* This implementation will prefer to source in the following order:
* <ul>
- * <li>DOM - DOM if explicit configured to use DOM</li>
+ * <li>DOM - DOM if explicitly configured to use DOM</li>
* <li>SAX - SAX as 2nd choice</li>
* <li>Stream - Stream as 3rd choice</li>
* <li>DOM - DOM as 4th choice</li>
diff --git
a/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/SourceCache.java
b/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/SourceCache.java
index 09f3fbf76b59..43972633aba1 100644
---
a/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/SourceCache.java
+++
b/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/SourceCache.java
@@ -26,8 +26,8 @@ import org.apache.camel.util.IOHelper;
/**
* {@link org.apache.camel.StreamCache} implementation for {@link
StringSource}s.
- * <p/>
- * <b>Important:</b> All the classes from the Camel release that implements
{@link StreamCache} is NOT intended for end
+ * <p>
+ * <b>Important:</b> All the classes from the Camel release that implement
{@link StreamCache} are NOT intended for end
* users to create as instances, but they are part of Camels
* <a
href="https://camel.apache.org/manual/stream-caching.html";>stream-caching</a>
functionality.
*/
diff --git
a/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/StreamSourceCache.java
b/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/StreamSourceCache.java
index d0ac8e872dec..9631586cb7bc 100644
---
a/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/StreamSourceCache.java
+++
b/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/StreamSourceCache.java
@@ -31,8 +31,8 @@ import org.apache.camel.util.IOHelper;
/**
* A {@link org.apache.camel.StreamCache} for {@link
javax.xml.transform.stream.StreamSource}s.
- * <p/>
- * <b>Important:</b> All the classes from the Camel release that implements
{@link StreamCache} is NOT intended for end
+ * <p>
+ * <b>Important:</b> All the classes from the Camel release that implement
{@link StreamCache} are NOT intended for end
* users to create as instances, but they are part of Camels
* <a
href="https://camel.apache.org/manual/stream-caching.html";>stream-caching</a>
functionality.
*/
