This is an automated email from the ASF dual-hosted git repository.
bvahdat pushed a commit to branch exchange-javadoc
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/exchange-javadoc by this push:
new 17803c8 improve javadoc
17803c8 is described below
commit 17803c8e6f44a01d66a956631d17cde85440fbb1
Author: Babak Vahdat <bvah...@apache.org>
AuthorDate: Mon May 17 08:38:55 2021 +0200
improve javadoc
---
.../camel-api/src/main/java/org/apache/camel/Exchange.java | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/core/camel-api/src/main/java/org/apache/camel/Exchange.java
b/core/camel-api/src/main/java/org/apache/camel/Exchange.java
index 8ec2d21..a263a03 100644
--- a/core/camel-api/src/main/java/org/apache/camel/Exchange.java
+++ b/core/camel-api/src/main/java/org/apache/camel/Exchange.java
@@ -630,9 +630,11 @@ public interface Exchange {
/**
* Returns the endpoint which originated this message exchange if a
consumer on an endpoint created the message
- * exchange, otherwise this property will be <tt>null</tt>, e.g. when this
message exchange has been cloned through
- * another parent message exchange (which itself has been created through
the consumer of it's own endpoint). If
- * desired one could still retrieve the consumer endpoint of such a parent
message exchange as the following:
+ * exchange, otherwise his property will be <tt>null</tt>.
+ *
+ * Note: In case this message exchange has been cloned through another
parent message exchange (which itself has
+ * been created through the consumer of it's own endpoint), then if
desired one could still retrieve the consumer
+ * endpoint of such a parent message exchange as the following:
*
* <pre>
* getContext().getRoute(getFromRouteId()).getEndpoint()
@@ -642,8 +644,10 @@ public interface Exchange {
/**
* Returns the route id which originated this message exchange if a route
consumer on an endpoint created the
- * message exchange or if this message exchange has been cloned through
another parent message exchange, otherwise
- * this property will be <tt>null</tt>
+ * message exchange, otherwise his property will be <tt>null</tt>.
+ *
+ * Note: In case this message exchange has been cloned through another
parent message exchange then this method
+ * would return the <tt>fromRouteId<tt> property of that exchange.
*/
String getFromRouteId();
