svn commit: r706523 - in /activemq/camel/trunk/camel-core/src/main/java/org/apache/camel: PollingConsumer.java impl/DefaultCamelContext.java impl/EventDrivenPollingConsumer.java

[davsclaus]

Author: davsclaus
Date: Mon Oct 20 22:43:33 2008
New Revision: 706523

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

Modified:
    
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/PollingConsumer.java
    
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
    
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/EventDrivenPollingConsumer.java

Modified: 
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/PollingConsumer.java
URL: 
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/PollingConsumer.java?rev=706523&r1=706522&r2=706523&view=diff
==============================================================================
--- 
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/PollingConsumer.java
 (original)
+++ 
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/PollingConsumer.java
 Mon Oct 20 22:43:33 2008
@@ -28,6 +28,8 @@
     /**
      * Waits until a message is available and then returns it. Warning that 
this
      * method could block indefinitely if no messages are available.
+     * <p/>
+     * Will return <tt>null</tt> if the consumer is not started
      * 
      * @return the message exchange received.
      */
@@ -35,10 +37,10 @@
 
     /**
      * Attempts to receive a message exchange immediately without waiting and
-     * returning null if a message exchange is not available yet.
+     * returning <tt>null</tt> if a message exchange is not available yet.
      * 
      * @return the message exchange if one is immediately available otherwise
-     *         null
+     *         <tt>null</tt>
      */
     E receiveNoWait();
 
@@ -47,10 +49,10 @@
      * to expire if a message is not yet available
      * 
      * @param timeout the amount of time in milliseconds to wait for a message
-     *                before timing out and returning null
+     *                before timing out and returning <tt>null</tt>
      * 
      * @return the message exchange if one iwas available within the timeout
-     *         period, or null if the timeout expired
+     *         period, or <tt>null</tt> if the timeout expired
      */
     E receive(long timeout);
 

Modified: 
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
URL: 
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java?rev=706523&r1=706522&r2=706523&view=diff
==============================================================================
--- 
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
 (original)
+++ 
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
 Mon Oct 20 22:43:33 2008
@@ -129,8 +129,6 @@
     /**
      * Creates the [EMAIL PROTECTED] CamelContext} using the given JNDI 
context as the
      * registry
-     *
-     * @param jndiContext
      */
     public DefaultCamelContext(Context jndiContext) {
         this();

Modified: 
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/EventDrivenPollingConsumer.java
URL: 
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/EventDrivenPollingConsumer.java?rev=706523&r1=706522&r2=706523&view=diff
==============================================================================
--- 
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/EventDrivenPollingConsumer.java
 (original)
+++ 
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/EventDrivenPollingConsumer.java
 Mon Oct 20 22:43:33 2008
@@ -64,6 +64,7 @@
                 handleInteruptedException(e);
             }
         }
+        LOG.debug("Consumer is not running, so returning null");
         return null;
     }