You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2014/08/12 21:06:11 UTC
[3/3] git commit: Polished javadoc
Polished javadoc
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/c46be6a3
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/c46be6a3
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/c46be6a3
Branch: refs/heads/master
Commit: c46be6a3dd9e3ab11d064524338bfe01bf6014b7
Parents: f71d4ec
Author: Claus Ibsen <da...@apache.org>
Authored: Tue Aug 12 21:05:56 2014 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Tue Aug 12 21:05:56 2014 +0200
----------------------------------------------------------------------
.../src/main/java/org/apache/camel/NamedNode.java | 3 +++
camel-core/src/main/java/org/apache/camel/Route.java | 2 +-
.../java/org/apache/camel/builder/ExchangeBuilder.java | 13 ++++++++++++-
.../apache/camel/builder/ThreadPoolProfileBuilder.java | 5 +++++
.../src/main/java/org/apache/camel/spi/Breakpoint.java | 3 +++
5 files changed, 24 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/c46be6a3/camel-core/src/main/java/org/apache/camel/NamedNode.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/NamedNode.java b/camel-core/src/main/java/org/apache/camel/NamedNode.java
index 75065b6..9d652c5 100644
--- a/camel-core/src/main/java/org/apache/camel/NamedNode.java
+++ b/camel-core/src/main/java/org/apache/camel/NamedNode.java
@@ -16,6 +16,9 @@
*/
package org.apache.camel;
+/**
+ * Represents a node in the {@link org.apache.camel.model routes} which is identified by an id.
+ */
public interface NamedNode {
/**
http://git-wip-us.apache.org/repos/asf/camel/blob/c46be6a3/camel-core/src/main/java/org/apache/camel/Route.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/Route.java b/camel-core/src/main/java/org/apache/camel/Route.java
index 53e4c1d..3adb442 100644
--- a/camel-core/src/main/java/org/apache/camel/Route.java
+++ b/camel-core/src/main/java/org/apache/camel/Route.java
@@ -24,7 +24,7 @@ import org.apache.camel.spi.RouteContext;
/**
* A <a href="http://camel.apache.org/routes.html">Route</a>
* defines the processing used on an inbound message exchange
- * from a specific {@link org.apache.camel.Endpoint} within a {@link org.apache.camel.CamelContext}
+ * from a specific {@link org.apache.camel.Endpoint} within a {@link org.apache.camel.CamelContext}.
* <p/>
* Use the API from {@link org.apache.camel.CamelContext} to control the lifecycle of a route,
* such as starting and stopping using the {@link org.apache.camel.CamelContext#startRoute(String)}
http://git-wip-us.apache.org/repos/asf/camel/blob/c46be6a3/camel-core/src/main/java/org/apache/camel/builder/ExchangeBuilder.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/builder/ExchangeBuilder.java b/camel-core/src/main/java/org/apache/camel/builder/ExchangeBuilder.java
index 61d5513..12f9003 100644
--- a/camel-core/src/main/java/org/apache/camel/builder/ExchangeBuilder.java
+++ b/camel-core/src/main/java/org/apache/camel/builder/ExchangeBuilder.java
@@ -25,6 +25,11 @@ import org.apache.camel.ExchangePattern;
import org.apache.camel.Message;
import org.apache.camel.impl.DefaultExchange;
+/**
+ * Builder to create {@link Exchange} and add headers and set body on the Exchange {@link Message}.
+ * <p/>
+ * Use the {@link #build()} method when done setting up the exchange.
+ */
public final class ExchangeBuilder {
private CamelContext context;
private ExchangePattern pattern;
@@ -38,6 +43,7 @@ public final class ExchangeBuilder {
/**
* Create the exchange by setting the camel context
+ *
* @param context the camel context
* @return exchange builder
*/
@@ -47,7 +53,8 @@ public final class ExchangeBuilder {
/**
* Set the in message body on the exchange
- * @param body
+ *
+ * @param body the body
* @return exchange builder
*/
public ExchangeBuilder withBody(Object body) {
@@ -57,6 +64,7 @@ public final class ExchangeBuilder {
/**
* Set the message header of the in message on the exchange
+ *
* @param key the key of the header
* @param value the value of the header
* @return exchange builder
@@ -68,6 +76,7 @@ public final class ExchangeBuilder {
/**
* Set the message exchange pattern on the exchange
+ *
* @param pattern exchange pattern
* @return exchange builder
*/
@@ -78,6 +87,7 @@ public final class ExchangeBuilder {
/**
* Set the exchange property
+ *
* @param key the key of the exchange property
* @param value the value of the exchange property
* @return exchange builder
@@ -89,6 +99,7 @@ public final class ExchangeBuilder {
/**
* Build up the exchange from the exchange builder
+ *
* @return exchange
*/
public Exchange build() {
http://git-wip-us.apache.org/repos/asf/camel/blob/c46be6a3/camel-core/src/main/java/org/apache/camel/builder/ThreadPoolProfileBuilder.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/builder/ThreadPoolProfileBuilder.java b/camel-core/src/main/java/org/apache/camel/builder/ThreadPoolProfileBuilder.java
index 8434c0d..83cb463 100644
--- a/camel-core/src/main/java/org/apache/camel/builder/ThreadPoolProfileBuilder.java
+++ b/camel-core/src/main/java/org/apache/camel/builder/ThreadPoolProfileBuilder.java
@@ -21,6 +21,11 @@ import java.util.concurrent.TimeUnit;
import org.apache.camel.ThreadPoolRejectedPolicy;
import org.apache.camel.spi.ThreadPoolProfile;
+/**
+ * Builder to build {@link org.apache.camel.spi.ThreadPoolProfile}.
+ * <p/>
+ * Use the {@link #build()} method when done setting up the profile.
+ */
public class ThreadPoolProfileBuilder {
private final ThreadPoolProfile profile;
http://git-wip-us.apache.org/repos/asf/camel/blob/c46be6a3/camel-core/src/main/java/org/apache/camel/spi/Breakpoint.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/spi/Breakpoint.java b/camel-core/src/main/java/org/apache/camel/spi/Breakpoint.java
index 0f3bd68..0fdac64 100644
--- a/camel-core/src/main/java/org/apache/camel/spi/Breakpoint.java
+++ b/camel-core/src/main/java/org/apache/camel/spi/Breakpoint.java
@@ -38,6 +38,9 @@ import org.apache.camel.model.ProcessorDefinition;
*/
public interface Breakpoint {
+ /**
+ * State of the breakpoint as either active or suspended.
+ */
enum State {
Active, Suspended
}