Return-Path: 
 <avalon-cvs-return-10670-qmlist-jakarta-archive-avalon-cvs=jakarta.apache.org@jakarta.apache.org>
Delivered-To: apmail-jakarta-avalon-cvs-archive@apache.org
Received: (qmail 68775 invoked from network); 12 Sep 2002 10:24:38 -0000
Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131)
  by daedalus.apache.org with SMTP; 12 Sep 2002 10:24:38 -0000
Received: (qmail 2187 invoked by uid 97); 12 Sep 2002 10:25:26 -0000
Delivered-To: qmlist-jakarta-archive-avalon-cvs@jakarta.apache.org
Received: (qmail 2137 invoked by uid 97); 12 Sep 2002 10:25:25 -0000
Mailing-List: contact avalon-cvs-help@jakarta.apache.org; run by ezmlm
Precedence: bulk
List-Unsubscribe: <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
List-Subscribe: <mailto:avalon-cvs-subscribe@jakarta.apache.org>
List-Help: <mailto:avalon-cvs-help@jakarta.apache.org>
List-Post: <mailto:avalon-cvs@jakarta.apache.org>
List-Id: "Avalon CVS List" <avalon-cvs.jakarta.apache.org>
Reply-To: "Avalon Developers List" <avalon-dev@jakarta.apache.org>
Delivered-To: mailing list avalon-cvs@jakarta.apache.org
Received: (qmail 2126 invoked by uid 97); 12 Sep 2002 10:25:25 -0000
X-Antivirus: nagoya (v4218 created Aug 14 2002)
Date: 12 Sep 2002 10:24:33 -0000
Message-ID: <20020912102433.43039.qmail@icarus.apache.org>
From: donaldp@apache.org
To: jakarta-avalon-cornerstone-cvs@apache.org
Subject: cvs commit:
 jakarta-avalon-cornerstone/src/java/org/apache/avalon/cornerstone/services/scheduler
 CronTimeTrigger.java PeriodicTimeTrigger.java TimeTrigger.java
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N

donaldp     2002/09/12 03:24:33

  Modified:    src/java/org/apache/avalon/cornerstone/services/scheduler
                        CronTimeTrigger.java PeriodicTimeTrigger.java
                        TimeTrigger.java
  Log:
  Improved the javadocs.
  
  Submitted by: Greg Steuck <greg-avalon-apps@nest.cx>
  
  Revision  Changes    Path
  1.8       +6 -4      jakarta-avalon-cornerstone/src/java/org/apache/avalon/cornerstone/services/scheduler/CronTimeTrigger.java
  
  Index: CronTimeTrigger.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-cornerstone/src/java/org/apache/avalon/cornerstone/services/scheduler/CronTimeTrigger.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- CronTimeTrigger.java	5 Aug 2002 14:12:14 -0000	1.7
  +++ CronTimeTrigger.java	12 Sep 2002 10:24:32 -0000	1.8
  @@ -65,14 +65,16 @@
       }
   
       /**
  -     * Retrieve the next time at which this trigger activates.
  +     * Returns the next time after the given <tt>moment</tt> when
  +     * this trigger goes off.
        *
  -     * @return the time at which the trigger will activate
  +     * @param moment base point in milliseconds
  +     * @return the time in milliseconds when this trigger goes off
        */
  -    public long getTimeAfter( final long time )
  +    public long getTimeAfter( final long moment )
       {
           //first create calendars
  -        final Date timeMarker = new Date( time );
  +        final Date timeMarker = new Date( moment );
           final GregorianCalendar relativeTo = new GregorianCalendar();
           relativeTo.setTime( timeMarker );
           relativeTo.set( Calendar.SECOND, 0 );
  
  
  
  1.6       +21 -7     jakarta-avalon-cornerstone/src/java/org/apache/avalon/cornerstone/services/scheduler/PeriodicTimeTrigger.java
  
  Index: PeriodicTimeTrigger.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-cornerstone/src/java/org/apache/avalon/cornerstone/services/scheduler/PeriodicTimeTrigger.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- PeriodicTimeTrigger.java	5 Aug 2002 14:12:14 -0000	1.5
  +++ PeriodicTimeTrigger.java	12 Sep 2002 10:24:32 -0000	1.6
  @@ -8,7 +8,9 @@
   package org.apache.avalon.cornerstone.services.scheduler;
   
   /**
  - * This is the triggers based on a start time and period.
  + * Goes off every <tt>period</tt> milliseconds after waiting for
  + * <tt>offset</tt> milliseconds from the moment the trigger was
  + * <tt>reset</tt>.
    *
    * @author <a href="mailto:peter at apache.org">Peter Donald</a>
    * @author <a href="mailto:ram.chidambaram@telus.com">Ram Chidambaram</a>
  @@ -20,6 +22,16 @@
       protected final long m_period;
       private long m_triggerTime;
   
  +    /**
  +     * Creates a periodic trigger. It goes off the first time after
  +     * <tt>offset</tt> milliseconds from the time it was
  +     * <tt>reset</tt> and then every <tt>offset</tt>
  +     * milliseconds. The trigger is <tt>reset</tt> as
  +     * part of its construction.
  +     *
  +     * @param offset initial delay in milliseconds, -1 means fire immediately
  +     * @param period after initial delay in milliseconds, -1 means fire only once after initial delay
  +     */
       public PeriodicTimeTrigger( final int offset, final int period )
       {
           m_offset = offset;
  @@ -29,22 +41,24 @@
       }
   
       /**
  -     * Retrieve the next time at which this trigger activates.
  +     * Returns the next time after the given <tt>moment</tt> when
  +     * this trigger goes off.
        *
  -     * @return the time at which the trigger will activate
  +     * @param moment base point in milliseconds
  +     * @return the time in milliseconds when this trigger goes off
        */
  -    public long getTimeAfter( final long time )
  +    public long getTimeAfter( final long moment )
       {
  -        if( time <= m_triggerTime )
  +        if( moment <= m_triggerTime )
               return m_triggerTime;
           else
           {
               if( -1 == m_period ) return -1;
   
  -            final long over = time - m_triggerTime;
  +            final long over = moment - m_triggerTime;
               final long remainder = over % m_period;
   
  -            return time + ( m_period - remainder );
  +            return moment + ( m_period - remainder );
           }
       }
   
  
  
  
  1.5       +7 -4      jakarta-avalon-cornerstone/src/java/org/apache/avalon/cornerstone/services/scheduler/TimeTrigger.java
  
  Index: TimeTrigger.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-cornerstone/src/java/org/apache/avalon/cornerstone/services/scheduler/TimeTrigger.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- TimeTrigger.java	5 Aug 2002 14:12:14 -0000	1.4
  +++ TimeTrigger.java	12 Sep 2002 10:24:32 -0000	1.5
  @@ -8,7 +8,8 @@
   package org.apache.avalon.cornerstone.services.scheduler;
   
   /**
  - * This is the marker interface for time-based Triggers.
  + * A kind of trigger that makes the determination to go off based
  + * on time.
    *
    * @author <a href="mailto:peter at apache.org">Peter Donald</a>
    * @author <a href="mailto:ram.chidambaram@telus.com">Ram Chidambaram</a>
  @@ -17,9 +18,11 @@
       extends Trigger
   {
       /**
  -     * Retrieve the next time at trigger activates relative to another time.
  +     * Returns the next time after the given <tt>moment</tt> when
  +     * this trigger goes off.
        *
  -     * @return the time at which the trigger activates
  +     * @param moment base point in milliseconds
  +     * @return the time in milliseconds when this trigger goes off
        */
  -    long getTimeAfter( long time );
  +    long getTimeAfter( long moment );
   }
  
  
  

--
To unsubscribe, e-mail:   <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@jakarta.apache.org>