This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new d429f82 CAMEL-15844: Add javadoc about init/start logic not in
constructors.
d429f82 is described below
commit d429f82bd3b37dace6f1e79e842dff8a49df5895
Author: Claus Ibsen <[email protected]>
AuthorDate: Sat Jan 23 12:22:45 2021 +0100
CAMEL-15844: Add javadoc about init/start logic not in constructors.
---
.../src/main/java/org/apache/camel/Consumer.java | 4 ++--
.../src/main/java/org/apache/camel/Endpoint.java | 16 ++++++++--------
.../src/main/java/org/apache/camel/PollingConsumer.java | 4 ++--
.../src/main/java/org/apache/camel/Producer.java | 4 ++--
4 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/core/camel-api/src/main/java/org/apache/camel/Consumer.java
b/core/camel-api/src/main/java/org/apache/camel/Consumer.java
index bd368e3e..0f3ec2e 100644
--- a/core/camel-api/src/main/java/org/apache/camel/Consumer.java
+++ b/core/camel-api/src/main/java/org/apache/camel/Consumer.java
@@ -19,8 +19,8 @@ package org.apache.camel;
/**
* A consumer of message exchanges from an {@link Endpoint}.
* <p/>
- * Important: Do not do any initialization in the constructor.
- * Instead use {@link
org.apache.camel.support.service.ServiceSupport#doInit()} or
+ * Important: Do not do any initialization in the constructor. Instead use
+ * {@link org.apache.camel.support.service.ServiceSupport#doInit()} or
* {@link org.apache.camel.support.service.ServiceSupport#doStart()}.
*/
public interface Consumer extends Service, EndpointAware {
diff --git a/core/camel-api/src/main/java/org/apache/camel/Endpoint.java
b/core/camel-api/src/main/java/org/apache/camel/Endpoint.java
index 39be552..10bfd5e 100644
--- a/core/camel-api/src/main/java/org/apache/camel/Endpoint.java
+++ b/core/camel-api/src/main/java/org/apache/camel/Endpoint.java
@@ -88,8 +88,8 @@ public interface Endpoint extends IsSingleton, Service {
/**
* Creates a new producer which is used send messages into the endpoint.
*
- * Important: Do not do any initialization in the constructor of the
{@link Producer}.
- * Instead use {@link ServiceSupport#doInit()} or {@link
ServiceSupport#doStart()}.
+ * Important: Do not do any initialization in the constructor of the
{@link Producer}. Instead use
+ * {@link ServiceSupport#doInit()} or {@link ServiceSupport#doStart()}.
*
* @return a newly created producer
* @throws Exception can be thrown
@@ -106,8 +106,8 @@ public interface Endpoint extends IsSingleton, Service {
/**
* Creates a new producer which is used send messages into the endpoint
*
- * Important: Do not do any initialization in the constructor of the
{@link Producer}.
- * Instead use {@link ServiceSupport#doInit()} or {@link
ServiceSupport#doStart()}.
+ * Important: Do not do any initialization in the constructor of the
{@link Producer}. Instead use
+ * {@link ServiceSupport#doInit()} or {@link ServiceSupport#doStart()}.
*
* @return a newly created producer
* @throws Exception can be thrown
@@ -118,8 +118,8 @@ public interface Endpoint extends IsSingleton, Service {
* Creates a new <a
href="http://camel.apache.org/event-driven-consumer.html";>Event Driven
Consumer</a> which
* consumes messages from the endpoint using the given processor
*
- * Important: Do not do any initialization in the constructor of the
{@link Consumer}.
- * Instead use {@link ServiceSupport#doInit()} or {@link
ServiceSupport#doStart()}.
+ * Important: Do not do any initialization in the constructor of the
{@link Consumer}. Instead use
+ * {@link ServiceSupport#doInit()} or {@link ServiceSupport#doStart()}.
*
* @param processor the given processor
* @return a newly created consumer
@@ -134,8 +134,8 @@ public interface Endpoint extends IsSingleton, Service {
* rather than using the <a
href="http://camel.apache.org/event-driven-consumer.html";>Event Based
Consumer</a>
* returned by {@link #createConsumer(Processor)}
*
- * Important: Do not do any initialization in the constructor of the
{@link PollingConsumer}.
- * Instead use {@link ServiceSupport#doInit()} or {@link
ServiceSupport#doStart()}.
+ * Important: Do not do any initialization in the constructor of the
{@link PollingConsumer}. Instead use
+ * {@link ServiceSupport#doInit()} or {@link ServiceSupport#doStart()}.
*
* @return a newly created pull consumer
* @throws Exception if the pull consumer could not be created
diff --git a/core/camel-api/src/main/java/org/apache/camel/PollingConsumer.java
b/core/camel-api/src/main/java/org/apache/camel/PollingConsumer.java
index cf68364..98be57a 100644
--- a/core/camel-api/src/main/java/org/apache/camel/PollingConsumer.java
+++ b/core/camel-api/src/main/java/org/apache/camel/PollingConsumer.java
@@ -26,8 +26,8 @@ package org.apache.camel;
* This is needed to ensure any {@link org.apache.camel.spi.Synchronization}
works is being executed. For example if you
* consumed from a file endpoint, then the consumed file is only moved/delete
when you done the {@link Exchange}.
* <p/>
- * Important: Do not do any initialization in the constructor.
- * Instead use {@link
org.apache.camel.support.service.ServiceSupport#doInit()} or
+ * Important: Do not do any initialization in the constructor. Instead use
+ * {@link org.apache.camel.support.service.ServiceSupport#doInit()} or
* {@link org.apache.camel.support.service.ServiceSupport#doStart()}.
*/
public interface PollingConsumer extends Consumer {
diff --git a/core/camel-api/src/main/java/org/apache/camel/Producer.java
b/core/camel-api/src/main/java/org/apache/camel/Producer.java
index e9c7605..aeba81e 100644
--- a/core/camel-api/src/main/java/org/apache/camel/Producer.java
+++ b/core/camel-api/src/main/java/org/apache/camel/Producer.java
@@ -19,8 +19,8 @@ package org.apache.camel;
/**
* Provides a channel on which clients can create and invoke message exchanges
on an {@link Endpoint}.
* <p/>
- * Important: Do not do any initialization in the constructor.
- * Instead use {@link
org.apache.camel.support.service.ServiceSupport#doInit()} or
+ * Important: Do not do any initialization in the constructor. Instead use
+ * {@link org.apache.camel.support.service.ServiceSupport#doInit()} or
* {@link org.apache.camel.support.service.ServiceSupport#doStart()}.
*/
public interface Producer extends Processor, Service, IsSingleton,
EndpointAware {
