CAMEL-8023 Add javadoc to camel-core endpoints so we have 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/4084c2a7 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/4084c2a7 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/4084c2a7 Branch: refs/heads/master Commit: 4084c2a7721e733d91eaa58949f89e1f0cb1c4fa Parents: 95163ca Author: Kevin Earls <[email protected]> Authored: Thu Feb 5 19:03:45 2015 +0100 Committer: Willem Jiang <[email protected]> Committed: Fri Feb 6 14:39:55 2015 +0800 ---------------------------------------------------------------------- .../org/apache/camel/component/beanclass/ClassComponent.java | 2 +- .../apache/camel/component/binding/BindingNameComponent.java | 3 ++- .../org/apache/camel/component/browse/BrowseComponent.java | 2 +- .../camel/component/controlbus/ControlBusComponent.java | 2 +- .../camel/component/dataformat/DataFormatComponent.java | 5 +++++ .../org/apache/camel/component/direct/DirectComponent.java | 6 +++--- .../apache/camel/component/directvm/DirectVmComponent.java | 3 +-- .../java/org/apache/camel/component/file/FileComponent.java | 2 +- .../apache/camel/component/language/LanguageComponent.java | 4 ++-- .../java/org/apache/camel/component/log/LogComponent.java | 2 +- .../java/org/apache/camel/component/mock/MockComponent.java | 2 +- .../camel/component/properties/PropertiesComponent.java | 2 +- .../java/org/apache/camel/component/ref/RefComponent.java | 2 +- .../java/org/apache/camel/component/seda/SedaComponent.java | 3 +-- .../java/org/apache/camel/component/stub/StubComponent.java | 2 ++ .../java/org/apache/camel/component/test/TestComponent.java | 2 ++ .../java/org/apache/camel/component/timer/TimerComponent.java | 2 ++ .../apache/camel/component/validator/ValidatorComponent.java | 5 +++-- .../main/java/org/apache/camel/component/vm/VmComponent.java | 7 ++----- .../java/org/apache/camel/component/xslt/XsltComponent.java | 3 +-- .../java/org/apache/camel/component/event/EventComponent.java | 3 +-- .../java/org/apache/camel/component/sql/SqlComponent.java | 2 ++ 22 files changed, 37 insertions(+), 29 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassComponent.java b/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassComponent.java index af5e7bc..d8f2597 100644 --- a/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/beanclass/ClassComponent.java @@ -25,7 +25,7 @@ import org.apache.camel.component.bean.BeanHolder; import org.apache.camel.component.bean.ConstantBeanHolder; /** - * The <a href="http://camel.apache.org/class.html";>Class Component</a> is for invoking Java classes from Camel. + * The <a href="http://camel.apache.org/class.html";>Class Component</a> is for binding JavaBeans to Camel message exchanges based on class name. * <p/> * This component is an extension to the {@link org.apache.camel.component.bean.BeanComponent}. * http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/binding/BindingNameComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/binding/BindingNameComponent.java b/camel-core/src/main/java/org/apache/camel/component/binding/BindingNameComponent.java index 3ed73e6..31b32db 100644 --- a/camel-core/src/main/java/org/apache/camel/component/binding/BindingNameComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/binding/BindingNameComponent.java @@ -22,8 +22,9 @@ import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; /** - * To compose a Camel component with a Camel data-format as a single binding unit. + * The <a href="http://camel.apache.org/binding.html>Binding Component<a/> is for composing a Camel component with a Camel data-format as a single binding unit. * <p/> + * * A Binding component using the URI form <code>binding:nameOfBinding:endpointURI</code> * to extract the binding name which is then resolved from the registry and used to create a * {@link BindingEndpoint} from the underlying {@link Endpoint} http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/browse/BrowseComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/browse/BrowseComponent.java b/camel-core/src/main/java/org/apache/camel/component/browse/BrowseComponent.java index 80559a5..7e4c0aa 100644 --- a/camel-core/src/main/java/org/apache/camel/component/browse/BrowseComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/browse/BrowseComponent.java @@ -22,7 +22,7 @@ import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; /** - * The <a href="http://camel.apache.org/browse.html";>browse</a> component. + * The <a href="http://camel.apache.org/browse.html";>Browse Component</a> provides a simple <a href="http://camel.apache.org/browsableendpoint.html";>BrowsableEndpoint</a> for testing visualization or debugging. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusComponent.java b/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusComponent.java index f2ca975..5085a9d 100644 --- a/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/controlbus/ControlBusComponent.java @@ -23,7 +23,7 @@ import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; /** - * The <a href="http://camel.apache.org/controlbus.html";>control bus</a> component. + * The <a href="http://camel.apache.org/controlbus.html";>Control Bus component</a> allows sending messages to a control-bus endpoint to control routes. */ public class ControlBusComponent extends UriEndpointComponent { http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatComponent.java b/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatComponent.java index 668df4f..e101b9e 100644 --- a/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/dataformat/DataFormatComponent.java @@ -24,6 +24,11 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.util.EndpointHelper; import org.apache.camel.util.ObjectHelper; +/** + * The <a href="http://camel.apache.org/dataformat-component.html";>Data Format Component</a> enables using Data Format as a component. + * + * @version + */ public class DataFormatComponent extends UriEndpointComponent { public DataFormatComponent() { http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/direct/DirectComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/direct/DirectComponent.java b/camel-core/src/main/java/org/apache/camel/component/direct/DirectComponent.java index 836ccc6..b3253a5 100644 --- a/camel-core/src/main/java/org/apache/camel/component/direct/DirectComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/direct/DirectComponent.java @@ -24,11 +24,11 @@ import org.apache.camel.impl.UriEndpointComponent; import org.apache.camel.util.ServiceHelper; /** - * Represents the component that manages {@link DirectEndpoint}. It holds the - * list of named direct endpoints. + * The <a href="http://camel.apache.org/direct.html";>Direct Component</a> manages {@link DirectEndpoint} and holds the list of named direct endpoints. * - * @version + * @version */ + public class DirectComponent extends UriEndpointComponent { // must keep a map of consumers on the component to ensure endpoints can lookup old consumers http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmComponent.java b/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmComponent.java index 12d2016..6765fa6 100644 --- a/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/directvm/DirectVmComponent.java @@ -27,8 +27,7 @@ import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; /** - * Represents the component that manages {@link DirectVmEndpoint}. It holds the - * list of named direct-vm endpoints. + * The <a href="http://camel.apache.org/direct-vm.html";>Direct VM Component</a> manages {@link DirectVmEndpoint} and holds the list of named direct-vm endpoints. */ public class DirectVmComponent extends UriEndpointComponent { http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/file/FileComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/file/FileComponent.java b/camel-core/src/main/java/org/apache/camel/component/file/FileComponent.java index e68b49b..17dc54e 100644 --- a/camel-core/src/main/java/org/apache/camel/component/file/FileComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/file/FileComponent.java @@ -29,7 +29,7 @@ import org.apache.camel.util.ObjectHelper; import org.apache.camel.util.StringHelper; /** - * File component. + * * The <a href="http://camel.apache.org/file.html";>File Component</a> provides access to file systems. */ public class FileComponent extends GenericFileComponent<File> implements EndpointCompleter { /** http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/language/LanguageComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/language/LanguageComponent.java b/camel-core/src/main/java/org/apache/camel/component/language/LanguageComponent.java index 2942ae3..8997c06 100644 --- a/camel-core/src/main/java/org/apache/camel/component/language/LanguageComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/language/LanguageComponent.java @@ -26,8 +26,8 @@ import org.apache.camel.util.ObjectHelper; import org.apache.camel.util.ResourceHelper; /** - * The <a href="http://camel.apache.org/language-component.html";>language component</a> to send - * {@link org.apache.camel.Exchange}s to a given language and have the script being executed. + * The <a href="http://camel.apache.org/language-component.html";>Language component</a> enables sending + * {@link org.apache.camel.Exchange}s to a given language in order to have a script executed. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java b/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java index 7fad12b..8e506a0 100644 --- a/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java @@ -30,7 +30,7 @@ import org.slf4j.LoggerFactory; /** * The <a href="http://camel.apache.org/log.html";>Log Component</a> - * to log message exchanges to the underlying logging mechanism. + * is for logging message exchanges via the underlying logging mechanism. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/mock/MockComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/mock/MockComponent.java b/camel-core/src/main/java/org/apache/camel/component/mock/MockComponent.java index 152e686..3bd356e 100644 --- a/camel-core/src/main/java/org/apache/camel/component/mock/MockComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/mock/MockComponent.java @@ -25,7 +25,7 @@ import org.apache.camel.processor.ThroughputLogger; import org.apache.camel.util.CamelLogger; /** - * Component for testing with mock endpoints. + * The <a href="http://camel.apache.org/mock.html";>Mock Component</a> provides mock endpoints for testing. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/properties/PropertiesComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/properties/PropertiesComponent.java b/camel-core/src/main/java/org/apache/camel/component/properties/PropertiesComponent.java index 520c4d0..3b53d0a 100644 --- a/camel-core/src/main/java/org/apache/camel/component/properties/PropertiesComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/properties/PropertiesComponent.java @@ -33,7 +33,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * The <a href="http://camel.apache.org/properties";>properties</a> component. + * The <a href="http://camel.apache.org/properties";>Properties Component</a> allows you to use property placeholders when defining Endpoint URIs * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/ref/RefComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/ref/RefComponent.java b/camel-core/src/main/java/org/apache/camel/component/ref/RefComponent.java index 67690fe..2f6f6c4 100644 --- a/camel-core/src/main/java/org/apache/camel/component/ref/RefComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/ref/RefComponent.java @@ -22,7 +22,7 @@ import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; /** - * Component for lookup of existing endpoints bound in the {@link org.apache.camel.spi.Registry}. + * The <a href="http://camel.apache.org/ref.html";>Ref Component</a> is for lookup of existing endpoints bound in the {@link org.apache.camel.spi.Registry}. * <p/> * This component uses the <tt>ref:</tt> notation instead of the mostly common <tt>uri:</tt> notation. */ http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/seda/SedaComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/seda/SedaComponent.java b/camel-core/src/main/java/org/apache/camel/component/seda/SedaComponent.java index bf8c420..a0f4269 100644 --- a/camel-core/src/main/java/org/apache/camel/component/seda/SedaComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/seda/SedaComponent.java @@ -28,8 +28,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * An implementation of the <a href="http://camel.apache.org/seda.html";>SEDA components</a> - * for asynchronous SEDA exchanges on a {@link BlockingQueue} within a CamelContext + * The <a href="http://camel.apache.org/seda.html";>SEDA Component</a> is for asynchronous SEDA exchanges on a {@link BlockingQueue} within a CamelContext * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/stub/StubComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/stub/StubComponent.java b/camel-core/src/main/java/org/apache/camel/component/stub/StubComponent.java index d273b67..a72a648 100644 --- a/camel-core/src/main/java/org/apache/camel/component/stub/StubComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/stub/StubComponent.java @@ -25,6 +25,8 @@ import org.apache.camel.component.seda.BlockingQueueFactory; import org.apache.camel.component.vm.VmComponent; /** + * The <a href="http://camel.apache.org/stub.html";>Stub Component</a> is for stubbing out endpoints while developing or testing. + * * Allows you to easily stub out a middleware transport by prefixing the URI with "stub:" which is * handy for testing out routes, or isolating bits of middleware. */ http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/test/TestComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/test/TestComponent.java b/camel-core/src/main/java/org/apache/camel/component/test/TestComponent.java index 2e7d665..af16c2d 100644 --- a/camel-core/src/main/java/org/apache/camel/component/test/TestComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/test/TestComponent.java @@ -27,6 +27,8 @@ import org.apache.camel.util.ObjectHelper; import org.apache.camel.util.UnsafeUriCharactersEncoder; /** + * The <a href="http://camel.apache.org/test.html";>Test Component</a> is for simplifying unit and integration tests. + * * Component for testing by polling test messages from another endpoint on startup as the expected message bodies to * receive during testing. * http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/timer/TimerComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/timer/TimerComponent.java b/camel-core/src/main/java/org/apache/camel/component/timer/TimerComponent.java index 6c6ab01..63404ee 100644 --- a/camel-core/src/main/java/org/apache/camel/component/timer/TimerComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/timer/TimerComponent.java @@ -28,6 +28,8 @@ import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; /** + * The <a href="http://camel.apache.org/timer.html";>Timer Component</a> is for generating message exchanges when a timer fires. + * * Represents the component that manages {@link TimerEndpoint}. It holds the * list of {@link TimerConsumer} objects that are started. * http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorComponent.java b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorComponent.java index acde232..07e038a 100644 --- a/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/validator/ValidatorComponent.java @@ -22,8 +22,9 @@ import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; /** - * The <a href="http://camel.apache.org/validation.html";>Validator Component</a> - * for validating XML against some schema + * The <a href="http://camel.apache.org/validation.html";>Validator Component</a> is for validating XML against a schema + * + * @version */ public class ValidatorComponent extends UriEndpointComponent { http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/vm/VmComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/vm/VmComponent.java b/camel-core/src/main/java/org/apache/camel/component/vm/VmComponent.java index 9cf8030..04501b8 100644 --- a/camel-core/src/main/java/org/apache/camel/component/vm/VmComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/vm/VmComponent.java @@ -29,12 +29,9 @@ import org.apache.camel.component.seda.QueueReference; import org.apache.camel.component.seda.SedaComponent; /** - * An implementation of the <a href="http://camel.apache.org/vm.html";>VM components</a> - * for asynchronous SEDA exchanges on a {@link BlockingQueue} within the classloader tree containing - * the camel-core.jar. i.e. to handle communicating across CamelContext instances and possibly across - * web application contexts, providing that camel-core.jar is on the system classpath. + * The <a href="http://camel.apache.org/vm.html";>VM component</a> is for asynchronous SEDA exchanges on a {@link BlockingQueue} * - * @version + * @version */ public class VmComponent extends SedaComponent { protected static final Map<String, QueueReference> QUEUES = new HashMap<String, QueueReference>(); http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/camel-core/src/main/java/org/apache/camel/component/xslt/XsltComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/xslt/XsltComponent.java b/camel-core/src/main/java/org/apache/camel/component/xslt/XsltComponent.java index 999c8a8..06e981c 100644 --- a/camel-core/src/main/java/org/apache/camel/component/xslt/XsltComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/xslt/XsltComponent.java @@ -28,8 +28,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * An <a href="http://camel.apache.org/xslt.html";>XSLT Component</a> - * for performing XSLT transforms of messages + * The <a href="http://camel.apache.org/xslt.html";>XSLT Component</a> is for performing XSLT transformations of messages */ public class XsltComponent extends UriEndpointComponent { http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/components/camel-spring/src/main/java/org/apache/camel/component/event/EventComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-spring/src/main/java/org/apache/camel/component/event/EventComponent.java b/components/camel-spring/src/main/java/org/apache/camel/component/event/EventComponent.java index b383f5c..779a63f 100644 --- a/components/camel-spring/src/main/java/org/apache/camel/component/event/EventComponent.java +++ b/components/camel-spring/src/main/java/org/apache/camel/component/event/EventComponent.java @@ -30,8 +30,7 @@ import org.springframework.context.ApplicationEvent; import org.springframework.context.ConfigurableApplicationContext; /** - * An <a href="http://camel.apache.org/event.html";>Event Component</a> - * for working with Spring ApplicationEvents. + * The <a href="http://camel.apache.org/event.html";>Event Component</a> is for working with Spring ApplicationEvents. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/4084c2a7/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlComponent.java b/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlComponent.java index 145c98b..1f62fdd 100755 --- a/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlComponent.java +++ b/components/camel-sql/src/main/java/org/apache/camel/component/sql/SqlComponent.java @@ -27,6 +27,8 @@ import org.apache.camel.util.IntrospectionSupport; import org.springframework.jdbc.core.JdbcTemplate; /** + * The <a href="http://camel.apache.org/sql-component.html";>SQL Component</a> is for working with databases using JDBC queries. + * * @version */ public class SqlComponent extends UriEndpointComponent {
