[camel] branch main updated: Javadoc

[da...@apache.org]

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 e2926ad  Javadoc
e2926ad is described below

commit e2926ad62db65bedbd170b0497b46e1ce301edb3
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Thu Nov 4 10:34:43 2021 +0100

    Javadoc
---
 core/camel-api/src/main/java/org/apache/camel/Route.java     | 12 ++++++++++--
 .../src/main/java/org/apache/camel/spi/RouteError.java       |  8 ++++++++
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/core/camel-api/src/main/java/org/apache/camel/Route.java b/core/camel-api/src/main/java/org/apache/camel/Route.java
index 5c0dddf..c34c2df 100644
--- a/core/camel-api/src/main/java/org/apache/camel/Route.java
+++ b/core/camel-api/src/main/java/org/apache/camel/Route.java
@@ -182,14 +182,22 @@ public interface Route extends RuntimeConfiguration {
     void warmUp();
 
     /**
-     * Gets the last error.
+     * Gets the last error that happened during changing the route lifecycle, i.e. such as when
+     * an exception was thrown during starting the route.
+     * <p/>
+     * This is only errors for route lifecycle changes, it is not exceptions thrown during routing messsages
+     * with the Camel routing engine.
      *
      * @return the error
      */
     RouteError getLastError();
 
     /**
-     * Sets the last error.
+     * Sets the last error that happened during changing the route lifecycle, i.e. such as when
+     * an exception was thrown during starting the route.
+     * <p/>
+     * This is only errors for route lifecycle changes, it is not exceptions thrown during routing messsages
+     * with the Camel routing engine.
      *
      * @param error the error
      */
diff --git a/core/camel-api/src/main/java/org/apache/camel/spi/RouteError.java b/core/camel-api/src/main/java/org/apache/camel/spi/RouteError.java
index b306f81..4130929 100644
--- a/core/camel-api/src/main/java/org/apache/camel/spi/RouteError.java
+++ b/core/camel-api/src/main/java/org/apache/camel/spi/RouteError.java
@@ -16,7 +16,15 @@
  */
 package org.apache.camel.spi;
 
+/**
+ * The last error that happened during changing the route lifecycle, i.e. such as when
+ * an exception was thrown during starting the route.
+ * <p/>
+ * This is only errors for route lifecycle changes, it is not exceptions thrown during routing messsages
+ * with the Camel routing engine.
+ */
 public interface RouteError {
+
     enum Phase {
         START,
         STOP,