CAMEL-8195: Add javadoc to model classes so we have EIP documentation out of the box
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/8d106739 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/8d106739 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/8d106739 Branch: refs/heads/master Commit: 8d106739c1530e012d8688dd252b6b25f0ec71b9 Parents: 9ec31ce Author: Claus Ibsen <davscl...@apache.org> Authored: Fri Jan 16 11:54:47 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Fri Jan 16 11:54:47 2015 +0100 ---------------------------------------------------------------------- .../src/main/java/org/apache/camel/model/AOPDefinition.java | 2 +- .../main/java/org/apache/camel/model/AggregateDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/BeanDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/CatchDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/ChoiceDefinition.java | 2 +- .../main/java/org/apache/camel/model/ContextScanDefinition.java | 3 +-- .../main/java/org/apache/camel/model/ConvertBodyDefinition.java | 2 +- .../main/java/org/apache/camel/model/DataFormatDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/DelayDefinition.java | 2 +- .../java/org/apache/camel/model/DynamicRouterDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/EnrichDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/FilterDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/FinallyDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/FromDefinition.java | 2 +- .../org/apache/camel/model/IdempotentConsumerDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/InOnlyDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/InOutDefinition.java | 2 +- .../main/java/org/apache/camel/model/InterceptDefinition.java | 2 +- .../java/org/apache/camel/model/InterceptFromDefinition.java | 2 +- .../apache/camel/model/InterceptSendToEndpointDefinition.java | 2 +- .../main/java/org/apache/camel/model/LoadBalanceDefinition.java | 2 +- .../java/org/apache/camel/model/LoadBalancerDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/LogDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/LoopDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/MarshalDefinition.java | 2 +- .../main/java/org/apache/camel/model/MulticastDefinition.java | 2 +- .../java/org/apache/camel/model/OnCompletionDefinition.java | 2 +- .../main/java/org/apache/camel/model/OnExceptionDefinition.java | 2 +- .../apache/camel/model/OptimisticLockRetryPolicyDefinition.java | 2 +- .../main/java/org/apache/camel/model/OtherwiseDefinition.java | 2 +- .../main/java/org/apache/camel/model/PackageScanDefinition.java | 2 +- .../main/java/org/apache/camel/model/PipelineDefinition.java | 5 ++--- .../src/main/java/org/apache/camel/model/PolicyDefinition.java | 2 +- .../main/java/org/apache/camel/model/PollEnrichDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/ProcessDefinition.java | 2 +- .../java/org/apache/camel/model/RecipientListDefinition.java | 2 +- .../java/org/apache/camel/model/RedeliveryPolicyDefinition.java | 2 +- .../java/org/apache/camel/model/RemoveHeaderDefinition.java | 2 +- .../java/org/apache/camel/model/RemoveHeadersDefinition.java | 2 +- .../java/org/apache/camel/model/RemovePropertiesDefinition.java | 2 +- .../java/org/apache/camel/model/RemovePropertyDefinition.java | 2 +- .../main/java/org/apache/camel/model/ResequenceDefinition.java | 2 +- .../java/org/apache/camel/model/RestContextRefDefinition.java | 2 +- .../main/java/org/apache/camel/model/RollbackDefinition.java | 2 +- .../java/org/apache/camel/model/RouteBuilderDefinition.java | 2 +- .../java/org/apache/camel/model/RouteContextRefDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/RouteDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/RoutesDefinition.java | 2 +- .../main/java/org/apache/camel/model/RoutingSlipDefinition.java | 2 +- .../main/java/org/apache/camel/model/SamplingDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/SendDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/SetBodyDefinition.java | 2 +- .../org/apache/camel/model/SetExchangePatternDefinition.java | 2 +- .../java/org/apache/camel/model/SetFaultBodyDefinition.java | 2 +- .../main/java/org/apache/camel/model/SetHeaderDefinition.java | 2 +- .../java/org/apache/camel/model/SetOutHeaderDefinition.java | 2 +- .../main/java/org/apache/camel/model/SetPropertyDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/SortDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/SplitDefinition.java | 3 +-- .../src/main/java/org/apache/camel/model/StopDefinition.java | 2 +- .../org/apache/camel/model/ThreadPoolProfileDefinition.java | 3 +-- .../src/main/java/org/apache/camel/model/ThreadsDefinition.java | 2 +- .../main/java/org/apache/camel/model/ThrottleDefinition.java | 2 +- .../java/org/apache/camel/model/ThrowExceptionDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/ToDefinition.java | 2 +- .../main/java/org/apache/camel/model/TransactedDefinition.java | 2 +- .../main/java/org/apache/camel/model/TransformDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/TryDefinition.java | 2 +- .../main/java/org/apache/camel/model/UnmarshalDefinition.java | 2 +- .../main/java/org/apache/camel/model/ValidateDefinition.java | 2 +- .../src/main/java/org/apache/camel/model/WhenDefinition.java | 2 +- .../apache/camel/model/WhenSkipSendToEndpointDefinition.java | 3 +++ .../src/main/java/org/apache/camel/model/WireTapDefinition.java | 3 +-- .../org/apache/camel/model/config/PropertiesDefinition.java | 2 +- .../java/org/apache/camel/model/config/PropertyDefinition.java | 2 +- .../java/org/apache/camel/model/dataformat/AvroDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/BarcodeDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/Base64DataFormat.java | 2 +- .../org/apache/camel/model/dataformat/BeanioDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/BindyDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/CastorDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/CryptoDataFormat.java | 5 +++++ .../java/org/apache/camel/model/dataformat/CsvDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/CustomDataFormat.java | 2 +- .../apache/camel/model/dataformat/DataFormatsDefinition.java | 2 +- .../org/apache/camel/model/dataformat/FlatpackDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/GzipDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/HL7DataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/IcalDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/JaxbDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/JibxDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/JsonDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/PGPDataFormat.java | 3 +-- .../org/apache/camel/model/dataformat/ProtobufDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/RssDataFormat.java | 2 +- .../apache/camel/model/dataformat/SerializationDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/SoapJaxbDataFormat.java | 3 +++ .../org/apache/camel/model/dataformat/SyslogDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/TidyMarkupDataFormat.java | 2 +- .../apache/camel/model/dataformat/UniVocityCsvDataFormat.java | 2 +- .../camel/model/dataformat/UniVocityFixedWidthDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/UniVocityHeader.java | 2 +- .../apache/camel/model/dataformat/UniVocityTsvDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/XMLBeansDataFormat.java | 2 +- .../apache/camel/model/dataformat/XMLSecurityDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/XStreamDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/XmlJsonDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/XmlRpcDataFormat.java | 2 +- .../java/org/apache/camel/model/dataformat/ZipDataFormat.java | 2 +- .../org/apache/camel/model/dataformat/ZipFileDataFormat.java | 2 +- .../java/org/apache/camel/model/language/JXPathExpression.java | 2 +- .../org/apache/camel/model/language/MethodCallExpression.java | 3 +-- .../java/org/apache/camel/model/language/RefExpression.java | 4 +--- .../java/org/apache/camel/model/language/SimpleExpression.java | 3 +-- .../java/org/apache/camel/model/language/XPathExpression.java | 2 -- .../loadbalancer/CircuitBreakerLoadBalancerDefinition.java | 2 +- .../camel/model/loadbalancer/CustomLoadBalancerDefinition.java | 2 +- .../model/loadbalancer/FailoverLoadBalancerDefinition.java | 2 +- .../camel/model/loadbalancer/RandomLoadBalancerDefinition.java | 2 +- .../model/loadbalancer/RoundRobinLoadBalancerDefinition.java | 2 +- .../camel/model/loadbalancer/StickyLoadBalancerDefinition.java | 2 +- .../camel/model/loadbalancer/TopicLoadBalancerDefinition.java | 3 +-- .../model/loadbalancer/WeightedLoadBalancerDefinition.java | 2 +- .../java/org/apache/camel/model/rest/DeleteVerbDefinition.java | 3 +++ .../java/org/apache/camel/model/rest/GetVerbDefinition.java | 3 +++ .../java/org/apache/camel/model/rest/HeadVerbDefinition.java | 3 +++ .../java/org/apache/camel/model/rest/PostVerbDefinition.java | 3 +++ .../java/org/apache/camel/model/rest/PutVerbDefinition.java | 3 +++ .../java/org/apache/camel/model/rest/RestBindingDefinition.java | 3 +++ .../apache/camel/model/rest/RestConfigurationDefinition.java | 2 +- .../main/java/org/apache/camel/model/rest/RestDefinition.java | 2 +- .../java/org/apache/camel/model/rest/RestHostNameResolver.java | 3 +++ .../org/apache/camel/model/rest/RestPropertyDefinition.java | 2 +- .../main/java/org/apache/camel/model/rest/RestsDefinition.java | 2 +- .../main/java/org/apache/camel/model/rest/VerbDefinition.java | 3 +++ 135 files changed, 159 insertions(+), 137 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java b/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java index 462eee0..b843cf7 100644 --- a/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <aop/> element + * Does processing before and/or after the route is completed * * @deprecated will be removed in the future. You can for example use {@link Processor} and * {@link org.apache.camel.spi.InterceptStrategy} to do AOP in Camel. http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/AggregateDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/AggregateDefinition.java b/camel-core/src/main/java/org/apache/camel/model/AggregateDefinition.java index bcd4e2a..96d02e5 100644 --- a/camel-core/src/main/java/org/apache/camel/model/AggregateDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/AggregateDefinition.java @@ -47,7 +47,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.concurrent.SynchronousExecutorService; /** - * Represents an XML <aggregate/> element + * Aggregates many messages into a single message * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java b/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java index d6d0d10..b4b356f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java @@ -37,7 +37,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <bean/> element + * Calls a java bean * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/CatchDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/CatchDefinition.java b/camel-core/src/main/java/org/apache/camel/model/CatchDefinition.java index 26b6a0e..04276f5 100644 --- a/camel-core/src/main/java/org/apache/camel/model/CatchDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/CatchDefinition.java @@ -37,7 +37,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ExpressionToPredicateAdapter; /** - * Represents an XML <catch/> element + * Catches exceptions as part of a try, catch, finally block * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ChoiceDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ChoiceDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ChoiceDefinition.java index 5af254a..3ea388c 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ChoiceDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ChoiceDefinition.java @@ -36,7 +36,7 @@ import org.apache.camel.util.CollectionStringBuffer; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <choice/> element + * Routes messages based on a series of predicates * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ContextScanDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ContextScanDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ContextScanDefinition.java index 0d092db..b349d54 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ContextScanDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ContextScanDefinition.java @@ -18,7 +18,6 @@ package org.apache.camel.model; import java.util.ArrayList; import java.util.List; - import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlElement; @@ -27,7 +26,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.camel.spi.Label; /** - * <code>ContextScanDefinition</code> represents a <contextScan/> element. + * Scans for Java {@link org.apache.camel.builder.RouteBuilder} instances in the context {@link org.apache.camel.spi.Registry}. */ @Label("configuration") @XmlRootElement(name = "contextScan") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ConvertBodyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ConvertBodyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ConvertBodyDefinition.java index e0ef1d1..ab2dcde 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ConvertBodyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ConvertBodyDefinition.java @@ -31,7 +31,7 @@ import org.apache.camel.spi.Required; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <convertBodyTo/> element + * Converts the message body to another type */ @Label("EIP,transformation") @XmlRootElement(name = "convertBodyTo") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/DataFormatDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/DataFormatDefinition.java b/camel-core/src/main/java/org/apache/camel/model/DataFormatDefinition.java index 31464a0..57c98a7 100644 --- a/camel-core/src/main/java/org/apache/camel/model/DataFormatDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/DataFormatDefinition.java @@ -31,7 +31,7 @@ import org.apache.camel.util.ObjectHelper; import static org.apache.camel.util.EndpointHelper.isReferenceParameter; /** - * Represents the base XML type for DataFormat. + * Represents a Camel data format */ @Label("dataformat,transformation") @XmlType(name = "dataFormat") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/DelayDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/DelayDefinition.java b/camel-core/src/main/java/org/apache/camel/model/DelayDefinition.java index f858cd3..e901c39 100644 --- a/camel-core/src/main/java/org/apache/camel/model/DelayDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/DelayDefinition.java @@ -34,7 +34,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <delay/> element + * Delays processing for a specified length of time * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/DynamicRouterDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/DynamicRouterDefinition.java b/camel-core/src/main/java/org/apache/camel/model/DynamicRouterDefinition.java index f6334d4..1d4adbc 100644 --- a/camel-core/src/main/java/org/apache/camel/model/DynamicRouterDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/DynamicRouterDefinition.java @@ -31,7 +31,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <dynamicRouter/> element + * Routes messages based on dynamic rules */ @Label("EIP,routing") @XmlRootElement(name = "dynamicRouter") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/EnrichDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/EnrichDefinition.java b/camel-core/src/main/java/org/apache/camel/model/EnrichDefinition.java index 6c4e6e9..ede29f8 100644 --- a/camel-core/src/main/java/org/apache/camel/model/EnrichDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/EnrichDefinition.java @@ -33,7 +33,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <enrich/> element + * Enriches a message with data from a secondary resource * * @see Enricher */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/FilterDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/FilterDefinition.java b/camel-core/src/main/java/org/apache/camel/model/FilterDefinition.java index 39f4048..cd523a3 100644 --- a/camel-core/src/main/java/org/apache/camel/model/FilterDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/FilterDefinition.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <filter/> element + * Filter out messages based using a predicate * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/FinallyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/FinallyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/FinallyDefinition.java index 5e05e66..8e39528 100644 --- a/camel-core/src/main/java/org/apache/camel/model/FinallyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/FinallyDefinition.java @@ -26,7 +26,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <finally/> element + * Path traversed when a try, catch, finally block exits * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/FromDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/FromDefinition.java b/camel-core/src/main/java/org/apache/camel/model/FromDefinition.java index 40a457a..aaeaffd 100644 --- a/camel-core/src/main/java/org/apache/camel/model/FromDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/FromDefinition.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <from/> element + * Act as a message source as input to a route * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/IdempotentConsumerDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/IdempotentConsumerDefinition.java b/camel-core/src/main/java/org/apache/camel/model/IdempotentConsumerDefinition.java index 9b39010..88cb197 100644 --- a/camel-core/src/main/java/org/apache/camel/model/IdempotentConsumerDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/IdempotentConsumerDefinition.java @@ -31,7 +31,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <idempotentConsumer/> element + * Filters out duplicate messages */ @Label("EIP,endpoints") @XmlRootElement(name = "idempotentConsumer") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/InOnlyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/InOnlyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/InOnlyDefinition.java index cb6230e..9170e05 100644 --- a/camel-core/src/main/java/org/apache/camel/model/InOnlyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/InOnlyDefinition.java @@ -25,7 +25,7 @@ import org.apache.camel.ExchangePattern; import org.apache.camel.spi.Label; /** - * Represents an XML <inOnly/> element + * Marks the exchange pattern for the route to one way * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/InOutDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/InOutDefinition.java b/camel-core/src/main/java/org/apache/camel/model/InOutDefinition.java index 38fe60d..b658a1f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/InOutDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/InOutDefinition.java @@ -25,7 +25,7 @@ import org.apache.camel.ExchangePattern; import org.apache.camel.spi.Label; /** - * Represents an XML <inOut/> element + * Marks the exchange pattern for the route to request/reply * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/InterceptDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/InterceptDefinition.java b/camel-core/src/main/java/org/apache/camel/model/InterceptDefinition.java index bbc2e36..baaaecf 100644 --- a/camel-core/src/main/java/org/apache/camel/model/InterceptDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/InterceptDefinition.java @@ -33,7 +33,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <intercept/> element + * Intercepts a message at each step in the route * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/InterceptFromDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/InterceptFromDefinition.java b/camel-core/src/main/java/org/apache/camel/model/InterceptFromDefinition.java index 1e51c4f..eb3c31a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/InterceptFromDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/InterceptFromDefinition.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.support.ExpressionAdapter; /** - * Represents an XML <interceptFrom/> element + * Intercepts incoming messages * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/InterceptSendToEndpointDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/InterceptSendToEndpointDefinition.java b/camel-core/src/main/java/org/apache/camel/model/InterceptSendToEndpointDefinition.java index 118e39e..e94469a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/InterceptSendToEndpointDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/InterceptSendToEndpointDefinition.java @@ -36,7 +36,7 @@ import org.apache.camel.util.EndpointHelper; import org.apache.camel.util.URISupport; /** - * Represents an XML <interceptToEndpoint/> element + * Intercepts messages being sent to an endpoint * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/LoadBalanceDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/LoadBalanceDefinition.java b/camel-core/src/main/java/org/apache/camel/model/LoadBalanceDefinition.java index 25e775e..ed4b6e2 100644 --- a/camel-core/src/main/java/org/apache/camel/model/LoadBalanceDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/LoadBalanceDefinition.java @@ -54,7 +54,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.CollectionStringBuffer; /** - * Represents an XML <loadBalance/> element + * Balances message processing among a number of nodes */ @Label("EIP,routing") @XmlRootElement(name = "loadBalance") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/LoadBalancerDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/LoadBalancerDefinition.java b/camel-core/src/main/java/org/apache/camel/model/LoadBalancerDefinition.java index fd815e4..2745f9c 100644 --- a/camel-core/src/main/java/org/apache/camel/model/LoadBalancerDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/LoadBalancerDefinition.java @@ -33,7 +33,7 @@ import org.apache.camel.util.IntrospectionSupport; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <loadBalancer/> element + * Balances message processing among a number of nodes */ @Label("EIP,routing") @XmlType(name = "loadBalancer") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/LogDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/LogDefinition.java b/camel-core/src/main/java/org/apache/camel/model/LogDefinition.java index 66428f9..96f8cd7 100644 --- a/camel-core/src/main/java/org/apache/camel/model/LogDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/LogDefinition.java @@ -37,7 +37,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Represents an XML <log/> element + * Logs the defined message to the logger * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/LoopDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/LoopDefinition.java b/camel-core/src/main/java/org/apache/camel/model/LoopDefinition.java index 456e928..77e3724 100644 --- a/camel-core/src/main/java/org/apache/camel/model/LoopDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/LoopDefinition.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <loop/> element + * Processes a message multiple times * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/MarshalDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/MarshalDefinition.java b/camel-core/src/main/java/org/apache/camel/model/MarshalDefinition.java index f2b9f79..e434f54 100644 --- a/camel-core/src/main/java/org/apache/camel/model/MarshalDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/MarshalDefinition.java @@ -63,7 +63,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Marshals to a binary payload using the given {@link DataFormatDefinition} + * Marshals data into a specified format for transmission over a transport or component * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/MulticastDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/MulticastDefinition.java b/camel-core/src/main/java/org/apache/camel/model/MulticastDefinition.java index dab88ae..7e18a8d 100644 --- a/camel-core/src/main/java/org/apache/camel/model/MulticastDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/MulticastDefinition.java @@ -38,7 +38,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.CamelContextHelper; /** - * Represents an XML <multicast/> element + * Routes the same message to multiple paths either sequentially or in parallel. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/OnCompletionDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/OnCompletionDefinition.java b/camel-core/src/main/java/org/apache/camel/model/OnCompletionDefinition.java index 1849dbb..d7546c2 100644 --- a/camel-core/src/main/java/org/apache/camel/model/OnCompletionDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/OnCompletionDefinition.java @@ -40,7 +40,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <onCompletion/> element + * Route to be executed when normal route processing completes * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java b/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java index d0e9888..9ef76a6 100644 --- a/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/OnExceptionDefinition.java @@ -49,7 +49,7 @@ import org.apache.camel.util.ExpressionToPredicateAdapter; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <onException/> element + * Route to be executed when an exception is thrown * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/OptimisticLockRetryPolicyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/OptimisticLockRetryPolicyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/OptimisticLockRetryPolicyDefinition.java index e4c383a..483b948 100644 --- a/camel-core/src/main/java/org/apache/camel/model/OptimisticLockRetryPolicyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/OptimisticLockRetryPolicyDefinition.java @@ -25,7 +25,7 @@ import org.apache.camel.processor.aggregate.OptimisticLockRetryPolicy; import org.apache.camel.spi.Label; /** - * Represents an XML <optimisticLockRetryPolicy/> element + * To configure optimistic locking * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/OtherwiseDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/OtherwiseDefinition.java b/camel-core/src/main/java/org/apache/camel/model/OtherwiseDefinition.java index 002f2f7..14fa7fb 100644 --- a/camel-core/src/main/java/org/apache/camel/model/OtherwiseDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/OtherwiseDefinition.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.CollectionStringBuffer; /** - * Represents an XML <otherwise/> element + * Route to be executed when all other choices evaluate to <tt>false</tt> * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/PackageScanDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/PackageScanDefinition.java b/camel-core/src/main/java/org/apache/camel/model/PackageScanDefinition.java index 70fc448..c7f8293 100644 --- a/camel-core/src/main/java/org/apache/camel/model/PackageScanDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/PackageScanDefinition.java @@ -25,7 +25,7 @@ import javax.xml.bind.annotation.XmlElement; import javax.xml.bind.annotation.XmlRootElement; /** - * <code>PackageScanDefinition</code> represents a <packageScan/> element. + * Scans for Java {@link org.apache.camel.builder.RouteBuilder} classes in java packages */ @XmlRootElement(name = "packageScan") @XmlAccessorType(XmlAccessType.FIELD) http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/PipelineDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/PipelineDefinition.java b/camel-core/src/main/java/org/apache/camel/model/PipelineDefinition.java index d660231..6508b72 100644 --- a/camel-core/src/main/java/org/apache/camel/model/PipelineDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/PipelineDefinition.java @@ -25,10 +25,9 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <pipeline/> element which can be used to define an explicit pipeline; or to define - * a specific pipeline within a <multicast> block + * Routes the message to a sequence of processors. * - * @version + * @version */ @Label("EIP,routing") @XmlRootElement(name = "pipeline") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/PolicyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/PolicyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/PolicyDefinition.java index 3566fff..29d7ea1 100644 --- a/camel-core/src/main/java/org/apache/camel/model/PolicyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/PolicyDefinition.java @@ -32,7 +32,7 @@ import org.apache.camel.spi.TransactedPolicy; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <policy/> element + * Defines a policy the route will use * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/PollEnrichDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/PollEnrichDefinition.java b/camel-core/src/main/java/org/apache/camel/model/PollEnrichDefinition.java index 2f5aa24..79fe419 100644 --- a/camel-core/src/main/java/org/apache/camel/model/PollEnrichDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/PollEnrichDefinition.java @@ -33,7 +33,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <pollEnrich/> element + * Enriches messages with data polled from a secondary resource * * @see org.apache.camel.processor.Enricher */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java index 222489a..3ce2079 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java @@ -33,7 +33,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <process/> element + * Calls a Camel processor. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RecipientListDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RecipientListDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RecipientListDefinition.java index 3cda843..ee03079 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RecipientListDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RecipientListDefinition.java @@ -41,7 +41,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.CamelContextHelper; /** - * Represents an XML <recipientList/> element + * Routes messages to a number of dynamically specified recipients (dynamic to) * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RedeliveryPolicyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RedeliveryPolicyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RedeliveryPolicyDefinition.java index 13ce369..53b426c 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RedeliveryPolicyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RedeliveryPolicyDefinition.java @@ -29,7 +29,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <redeliveryPolicy/> element + * To configure re-delivery for error handling * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RemoveHeaderDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RemoveHeaderDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RemoveHeaderDefinition.java index c691193..79dfe24 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RemoveHeaderDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RemoveHeaderDefinition.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <removeHeader/> element + * Removes a named header from the message */ @Label("EIP,transformation") @XmlRootElement(name = "removeHeader") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java index fbb35c1..7611d21 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <removeHeaders/> element + * Removes message headers whose name matches a specified pattern */ @Label("EIP,transformation") @XmlRootElement(name = "removeHeaders") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RemovePropertiesDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RemovePropertiesDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RemovePropertiesDefinition.java index b0504ce..7915c30 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RemovePropertiesDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RemovePropertiesDefinition.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <removeProperties/> element + * Removes message exchange properties whose name matches a specified pattern */ @Label("EIP,transformation") @XmlRootElement(name = "removeProperties") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RemovePropertyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RemovePropertyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RemovePropertyDefinition.java index ac8f88a..2125868 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RemovePropertyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RemovePropertyDefinition.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <removeProperty/> element + * Removes a named property from the message exchange */ @Label("EIP,transformation") @XmlRootElement(name = "removeProperty") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ResequenceDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ResequenceDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ResequenceDefinition.java index 2bd63e7..fda7f58 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ResequenceDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ResequenceDefinition.java @@ -44,7 +44,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <resequence/> element + * Resequences (re-order) messages based on an expression * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RestContextRefDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RestContextRefDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RestContextRefDefinition.java index 8a1251a..19c9287 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RestContextRefDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RestContextRefDefinition.java @@ -27,7 +27,7 @@ import org.apache.camel.model.rest.RestDefinition; import org.apache.camel.spi.Label; /** - * Represents an XML <restContextRef/> element + * To refer to an XML file with rest services defined using the rest-dsl * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RollbackDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RollbackDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RollbackDefinition.java index b0c6d0f..3f23c9b 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RollbackDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RollbackDefinition.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <rollback/> element + * Forces a rollback by stopping routing the message */ @Label("EIP,routing") @XmlRootElement(name = "rollback") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RouteBuilderDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RouteBuilderDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RouteBuilderDefinition.java index 10b2da3..63021b8 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RouteBuilderDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RouteBuilderDefinition.java @@ -29,7 +29,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <routeBuilderRef/> element + * To refer to a Java {@link org.apache.camel.builder.RouteBuilder} instance to use. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RouteContextRefDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RouteContextRefDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RouteContextRefDefinition.java index 03a64a8..1f29b94 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RouteContextRefDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RouteContextRefDefinition.java @@ -27,7 +27,7 @@ import org.apache.camel.CamelContext; import org.apache.camel.spi.Label; /** - * Represents an XML <routeContextRef/> element + * To refer to an XML file with routes defined using the xml-dsl * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java index a23a212..b08c62a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java @@ -56,7 +56,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <route/> element + * A Camel route * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RoutesDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RoutesDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RoutesDefinition.java index ccb8053..79e2663 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RoutesDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RoutesDefinition.java @@ -30,7 +30,7 @@ import org.apache.camel.ErrorHandlerFactory; import org.apache.camel.spi.Label; /** - * Represents a collection of routes + * A series of Camel routes * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/RoutingSlipDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/RoutingSlipDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RoutingSlipDefinition.java index aed3738..ace30ac 100644 --- a/camel-core/src/main/java/org/apache/camel/model/RoutingSlipDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/RoutingSlipDefinition.java @@ -32,7 +32,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <routingSlip/> element + * Routes a message through a series of steps that are pre-determined (the slip) */ @Label("EIP,routing") @XmlRootElement(name = "routingSlip") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SamplingDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SamplingDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SamplingDefinition.java index e46e263..877e93d 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SamplingDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SamplingDefinition.java @@ -32,7 +32,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <sample/> element + * Extract a sample of the messages passing through a route * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SendDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SendDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SendDefinition.java index 69eecd7..508af03 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SendDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SendDefinition.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Base class for sending to an endpoint with an optional {@link ExchangePattern} + * Sends the message to an endpoint * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SetBodyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SetBodyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SetBodyDefinition.java index 9027225..8218873 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SetBodyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SetBodyDefinition.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <setBody/> element. + * Sets the contents of the message body */ @Label("EIP,transformation") @XmlRootElement(name = "setBody") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SetExchangePatternDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SetExchangePatternDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SetExchangePatternDefinition.java index d0174d4..22570b2 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SetExchangePatternDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SetExchangePatternDefinition.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <setExchangePattern/> element + * Sets the exchange pattern on the message exchange * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SetFaultBodyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SetFaultBodyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SetFaultBodyDefinition.java index 047b20a..35d6315 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SetFaultBodyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SetFaultBodyDefinition.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <setFaultBody/> element. + * Sets the contents of a fault message's body */ @Label("EIP,transformation") @XmlRootElement(name = "setFaultBody") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SetHeaderDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SetHeaderDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SetHeaderDefinition.java index e5c90e4..4d355f6 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SetHeaderDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SetHeaderDefinition.java @@ -32,7 +32,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <setHeader/> element + * Sets the value of a message header */ @Label("EIP,transformation") @XmlRootElement(name = "setHeader") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SetOutHeaderDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SetOutHeaderDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SetOutHeaderDefinition.java index ccc71ae..82bd77f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SetOutHeaderDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SetOutHeaderDefinition.java @@ -31,7 +31,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <setOutHeader/> element + * Sets the value of a header on the outbound message * * @deprecated not really needed, will be removed in the future */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SetPropertyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SetPropertyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SetPropertyDefinition.java index 2b40650..e62a3cb 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SetPropertyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SetPropertyDefinition.java @@ -32,7 +32,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <setProperty/> element + * Sets a named property on the message exchange */ @Label("EIP,transformation") @XmlRootElement(name = "setProperty") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SortDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SortDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SortDefinition.java index e9151b8..60ff340 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SortDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SortDefinition.java @@ -33,7 +33,7 @@ import org.apache.camel.util.ObjectHelper; import static org.apache.camel.builder.ExpressionBuilder.bodyExpression; /** - * Represents an XML <sort/> element + * Sorts the contents of the message */ @Label("EIP,routing") @XmlRootElement(name = "sort") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/SplitDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/SplitDefinition.java b/camel-core/src/main/java/org/apache/camel/model/SplitDefinition.java index d121e1d..0dd81ee 100644 --- a/camel-core/src/main/java/org/apache/camel/model/SplitDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/SplitDefinition.java @@ -17,7 +17,6 @@ package org.apache.camel.model; import java.util.concurrent.ExecutorService; - import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlAttribute; @@ -37,7 +36,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.CamelContextHelper; /** - * Represents an XML <split/> element + * Splits a single message into many sub-messages. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/StopDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/StopDefinition.java b/camel-core/src/main/java/org/apache/camel/model/StopDefinition.java index 7daac02..4e6554d 100644 --- a/camel-core/src/main/java/org/apache/camel/model/StopDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/StopDefinition.java @@ -26,7 +26,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <stop/> element + * Stops the processing of the current message * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ThreadPoolProfileDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ThreadPoolProfileDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ThreadPoolProfileDefinition.java index 63a3f07..e0a3989 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ThreadPoolProfileDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ThreadPoolProfileDefinition.java @@ -29,9 +29,8 @@ import org.apache.camel.ThreadPoolRejectedPolicy; import org.apache.camel.builder.xml.TimeUnitAdapter; import org.apache.camel.spi.Label; - /** - * Represents an XML <threadPoolProfile/> element + * To configure thread pools * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ThreadsDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ThreadsDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ThreadsDefinition.java index 3d357c6..573ab10 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ThreadsDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ThreadsDefinition.java @@ -40,7 +40,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.spi.ThreadPoolProfile; /** - * Represents an XML <threads/> element + * Specifies that all steps after this node are processed asynchronously * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java index 2daf572..f84e9c6 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java @@ -34,7 +34,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <throttle/> element + * Controls the rate at which messages are passed to the next node in the route * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ThrowExceptionDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ThrowExceptionDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ThrowExceptionDefinition.java index d15dcef..cadd5d6 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ThrowExceptionDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ThrowExceptionDefinition.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents an XML <throwException/> element + * Throws an exception */ @Label("EIP,errorHandler") @XmlRootElement(name = "throwException") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ToDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ToDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ToDefinition.java index 08db19f..889caa5 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ToDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ToDefinition.java @@ -26,7 +26,7 @@ import org.apache.camel.ExchangePattern; import org.apache.camel.spi.Label; /** - * Represents an XML <to/> element + * Sends the message to an endpoint * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/TransactedDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/TransactedDefinition.java b/camel-core/src/main/java/org/apache/camel/model/TransactedDefinition.java index 4f282c2..aa1d58f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/TransactedDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/TransactedDefinition.java @@ -40,7 +40,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Represents an XML <transacted/> element + * Enables transaction on the route * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/TransformDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/TransformDefinition.java b/camel-core/src/main/java/org/apache/camel/model/TransformDefinition.java index d7a3047..186d56a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/TransformDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/TransformDefinition.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <transform/> element + * Transforms the message body based on an expression */ @Label("EIP,transformation") @XmlRootElement(name = "transform") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/TryDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/TryDefinition.java b/camel-core/src/main/java/org/apache/camel/model/TryDefinition.java index 97ac5b5..32b4ea9 100644 --- a/camel-core/src/main/java/org/apache/camel/model/TryDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/TryDefinition.java @@ -36,7 +36,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ExpressionToPredicateAdapter; /** - * Represents an XML <try/> element + * Marks the beginning of a try, catch, finally block * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/UnmarshalDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/UnmarshalDefinition.java b/camel-core/src/main/java/org/apache/camel/model/UnmarshalDefinition.java index f4c8b43..2f4c54a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/UnmarshalDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/UnmarshalDefinition.java @@ -63,7 +63,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Unmarshals the binary payload using the given {@link DataFormatDefinition} + * Converts the message data received from the wire into a format that Apache Camel processors can consume * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/ValidateDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ValidateDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ValidateDefinition.java index ee99d76..902314a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ValidateDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ValidateDefinition.java @@ -26,7 +26,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <validate/> element + * Validates a message based on an expression * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/WhenDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/WhenDefinition.java b/camel-core/src/main/java/org/apache/camel/model/WhenDefinition.java index fe71473..c3f9b1c 100644 --- a/camel-core/src/main/java/org/apache/camel/model/WhenDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/WhenDefinition.java @@ -25,7 +25,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents an XML <when/> element + * Triggers a route when an expression evaluates to <tt>true</tt> * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/WhenSkipSendToEndpointDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/WhenSkipSendToEndpointDefinition.java b/camel-core/src/main/java/org/apache/camel/model/WhenSkipSendToEndpointDefinition.java index 9037d1e..3de3ddf 100644 --- a/camel-core/src/main/java/org/apache/camel/model/WhenSkipSendToEndpointDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/WhenSkipSendToEndpointDefinition.java @@ -23,6 +23,9 @@ import org.apache.camel.Predicate; import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; +/** + * Predicate to determine if the message should be sent or not to the endpoint, when using interceptSentToEndpoint. + */ @Label("EIP,routing") @XmlRootElement(name = "whenSkipSendToEndpoint") public class WhenSkipSendToEndpointDefinition extends WhenDefinition { http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/WireTapDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/WireTapDefinition.java b/camel-core/src/main/java/org/apache/camel/model/WireTapDefinition.java index 2448d76..b4da281 100644 --- a/camel-core/src/main/java/org/apache/camel/model/WireTapDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/WireTapDefinition.java @@ -19,7 +19,6 @@ package org.apache.camel.model; import java.util.ArrayList; import java.util.List; import java.util.concurrent.ExecutorService; - import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlAttribute; @@ -40,7 +39,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.CamelContextHelper; /** - * Represents an XML <wireTap/> element + * Routes a copy of a message (or creates a new message) to a secondary destination while continue routing the original message. */ @Label("EIP,management") @XmlRootElement(name = "wireTap") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/config/PropertiesDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/config/PropertiesDefinition.java b/camel-core/src/main/java/org/apache/camel/model/config/PropertiesDefinition.java index b4eceea..628ef12 100644 --- a/camel-core/src/main/java/org/apache/camel/model/config/PropertiesDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/config/PropertiesDefinition.java @@ -28,7 +28,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.camel.spi.Label; /** - * Represents the XML type for <properties>. + * A series of key value pair */ @Label("configuration") @XmlRootElement(name = "properties") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java index 5e28506..81a754a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java @@ -22,7 +22,7 @@ import javax.xml.bind.annotation.XmlAttribute; import javax.xml.bind.annotation.XmlRootElement; /** - * Represents the XML type for <property>. + * A key value pair */ @XmlRootElement(name = "property") @XmlAccessorType(XmlAccessType.FIELD) http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java index cc2e401..543da5d 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Label; /** - * Represents a avro DataFormat {@link org.apache.camel.spi.DataFormat} + * Avro data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java index 9f22072..4fa3460 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Label; /** - * Represents a Barcode DataFormat {@link org.apache.camel.spi.DataFormat} + * Barcode data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java index 5b40669..55c651c 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Label; /** - * Represents the Base64 {@link org.apache.camel.spi.DataFormat} + * Base64 data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java index ce4b029..40df8cc 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Label; /** - * Represents the BeanIO {@link org.apache.camel.spi.DataFormat} + * BeanIO data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java index 56654fb..292825a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents the Bindy {@link org.apache.camel.spi.DataFormat} + * Bindy data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java index 8a6f5f0..70afce8 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Label; /** - * Represents a <a href="http://camel.apache.org/castor.html";>Castor</a> {@link org.apache.camel.spi.DataFormat}. + * Castor data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java index 53dfed5..6d55acb 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java @@ -31,6 +31,11 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; +/** + * Crypto data format + * + * @version + */ @Label("dataformat,transformation") @XmlRootElement(name = "crypto") @XmlAccessorType(XmlAccessType.FIELD) http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java index 7424380..e8d2144 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java @@ -31,7 +31,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * Represents a CSV (Comma Separated Values) {@link org.apache.camel.spi.DataFormat} + * CSV data format */ @Label("dataformat,transformation") @XmlRootElement(name = "csv") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java index cf0bce6..1250711 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents the custom {@link org.apache.camel.spi.DataFormat} to lookup using a reference + * Custom data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java index 8cc51e7..f39d1cc 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java @@ -30,7 +30,7 @@ import org.apache.camel.model.DataFormatDefinition; import org.apache.camel.spi.Label; /** - * Represents the XML type for a collection of DataFormats. + * To configure data formats */ @Label("dataformat,transformation") @XmlRootElement(name = "dataFormats") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java index ca9dcde..aa48e7a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java @@ -30,7 +30,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * Represents a <a href="http://camel.apache.org/flatpack.html";>Flatpack</a> {@link org.apache.camel.spi.DataFormat}. + * Flatpack data format */ @Label("dataformat,transformation") @XmlRootElement(name = "flatpack") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java index 1b0f81c..392ba32 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java @@ -24,7 +24,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.spi.RouteContext; /** - * Represents the GZip {@link DataFormat} + * GZip data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java index d4c5dd1..252b8f1 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Label; /** - * Represents a <a href="http://camel.apache.org/hl7.html";>HL7</a> {@link org.apache.camel.spi.DataFormat}. + * HL7 data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java index 5d5c8d2..90bba3d 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Label; /** - * Represents a <a href="http://camel.apache.org/ical";>iCal</a> {@link org.apache.camel.spi.DataFormat}. + * iCal data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java index aa94637..704b64e 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.Label; import org.apache.camel.util.ObjectHelper; /** - * Represents the JAXB2 XML {@link DataFormat} + * JAXB data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java index 945a992..b360c89 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents the JiBX XML {@link org.apache.camel.spi.DataFormat} + * JiBX data format */ @Label("dataformat,transformation") @XmlRootElement(name = "jibx") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java index e0075ea..0568fad 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Represents the Json {@link DataFormat} + * Json data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java index c8a34a1..a0c950d 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java @@ -27,8 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Label; /** - * Represents a <a href="http://camel.apache.org/crypto.html";>pgp</a> - * {@link org.apache.camel.spi.DataFormat}. + * PGP data format */ @Label("dataformat,transformation") @XmlRootElement(name = "pgp") http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java index a5a9d6d..d2f9e34 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Label; /** - * Represents a protobuf DataFormat {@link org.apache.camel.spi.DataFormat} + * Google protobuf data format * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/8d106739/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java index 1e2f8f5..3ecdf2c 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java @@ -24,7 +24,7 @@ import org.apache.camel.model.DataFormatDefinition; import org.apache.camel.spi.Label; /** - * Represents the <a href="http://camel.apache.org/rss.html";>RSS</a> {@link org.apache.camel.spi.DataFormat}. + * RSS data format */ @Label("dataformat,transformation") @XmlRootElement(name = "rss")
