svn commit: r713912 - /servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java

[ff...@apache.org]

Author: ffang
Date: Thu Nov 13 18:57:00 2008
New Revision: 713912

URL: http://svn.apache.org/viewvc?rev=713912&view=rev
Log:
[SM-1642]Add better documentation around attributes & elements for the servicemix-file component

Modified:
    servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java

Modified: servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java?rev=713912&r1=713911&r2=713912&view=diff
==============================================================================
--- servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java (original)
+++ servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java Thu Nov 13 18:57:00 2008
@@ -31,8 +31,8 @@
 import org.apache.servicemix.executors.Executor;
 
 /**
- * An implementation inheritence class for an endpoint which polls some resource at periodic intervals to decide if
- * there is an event to process.
+ * An implementation inheritance class for an endpoint which polls some resource
+ * at periodic intervals to decide if there is an event to process.
  *
  * @version $Revision: 464478 $
  */
@@ -75,71 +75,65 @@
         return executor;
     }
 
-    public long getDelay() {
-        return delay;
-    }
 
     /**
-     * Sets the amount of time the endpoint waits before making the first poll.
+     * Sets the amount of time in milliseconds that the endpoint should wait before making the first poll.
      *
      * @param        delay   a long specifying the number of milliseconds to wait
-     * @org.apache.xbean.Property description="the number of milliseconds to wait before the first poll"
      */
     public void setDelay(long delay) {
         this.delay = delay;
     }
 
-    public Date getFirstTime() {
-        return firstTime;
+    public long getDelay() {
+        return delay;
     }
 
+
     /**
      * Sets the date on which the first poll will be executed. If a delay is 
      * also set using <code>setDelay</code>, the delay interval will be added 
-     * after the date specified,
+     * after the date specified.
      *
      * @param        firstTime       a <code>Date</code> specifying when to make the 
      *                               first polling attempt
-     * @org.apache.xbean.Property description="the date of the first polling attempt. The date is specified using the <code>YYYY-MM-DD</code> format. The <code>delay</code> value is added after the date."
      */
     public void setFirstTime(Date firstTime) {
         this.firstTime = firstTime;
     }
 
-    public long getPeriod() {
-        return period;
-    }
-
-    /**
-     * returns if more than one poll can be active at a time
-     *  
-     * @return Returns the concurrentPolling flag.
-     * @org.apache.xbean.Property description="returns if more than one poll can be active at a time"
-     */
-    public boolean isConcurrentPolling() {
-        return this.concurrentPolling;
+    public Date getFirstTime() {
+        return firstTime;
     }
 
     /**
-     * sets if more than one poll can be active at a time (true means yes)
+     * Sets whether more than one poll can be active at a time (true means yes). Default value is <code>false</code>.
      * 
      * @param concurrentPolling The concurrentPolling to set.
-     * @org.apache.xbean.Property description="sets if more than one poll can be active at a time (true means yes)"
      */
     public void setConcurrentPolling(boolean concurrentPolling) {
         this.concurrentPolling = concurrentPolling;
     }
+   
+    public boolean isConcurrentPolling() {
+        return this.concurrentPolling;
+    }
+
     
     /**
      * Sets the number of milliseconds between polling attempts.
      *
      * @param        period  a long specifying the gap between polling attempts
-     * @org.apache.xbean.Property description="the number of milliseconds between polling attempts"
      */
     public void setPeriod(long period) {
         this.period = period;
     }
 
+    public long getPeriod() {
+        return period;
+    }
+
+
     public Scheduler getScheduler() {
         return scheduler;
     }