svn commit: r713440 - /activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

svn commit: r713440 - /activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java

davsclaus-2
Author: davsclaus
Date: Wed Nov 12 09:57:57 2008
New Revision: 713440

URL: http://svn.apache.org/viewvc?rev=713440&view=rev
Log:
Polished javadoc

Modified:
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java?rev=713440&r1=713439&r2=713440&view=diff
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java (original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java Wed Nov 12 09:57:57 2008
@@ -61,6 +61,8 @@
     /**
      * Creates a new exchange for communicating with this exchange using the
      * given exchange to pre-populate the values of the headers and messages
+     *
+     * @param exchange given exchange to use for pre-polulate
      */
     Exchange createExchange(Exchange exchange);
 
@@ -75,6 +77,7 @@
      * Creates a new producer which is used send messages into the endpoint
      *
      * @return a newly created producer
+     * @throws Exception can be thrown
      */
     Producer createProducer() throws Exception;
 
@@ -84,7 +87,9 @@
      * Driven Consumer</a> which consumes messages from the endpoint using the
      * given processor
      *
+     * @param processor  the given processor
      * @return a newly created consumer
+     * @throws Exception can be thrown
      */
     Consumer createConsumer(Processor processor) throws Exception;
 
@@ -104,8 +109,18 @@
      */
     PollingConsumer createPollingConsumer() throws Exception;
 
+    /**
+     * Configure properties on this endpoint.
+     *
+     * @param options  the options (properties)
+     */
     void configureProperties(Map options);
 
+    /**
+     * Sets the camel context.
+     *
+     * @param context the camel context
+     */
     void setCamelContext(CamelContext context);
 
     @Deprecated
@@ -117,8 +132,8 @@
     /**
      * Should all properties be known or does the endpoint allow unknown options?
      * <p/>
-     * <tt>Lenient = false</tt> means that the endpoint should validate that all
-     * given options is known and configured properly
+     * <tt>lenient = false</tt> means that the endpoint should validate that all
+     * given options is known and configured properly.
      * <tt>lenient = true</tt> means that the endpoint allows additional unknown options to
      * be passed to it but does not throw a ResolveEndpointFailedException when creating
      * the endpoint.