Package org.cip4.jdflib.util.thread

Class TimeSweeper

  • All Implemented Interfaces:
    Sweeper
    public class TimeSweeper
extends java.lang.Object
implements Sweeper
    class that sweeps at a regular interval - useful in case multiple sweepers with differing timing requirements are run

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.apache.commons.logging.Log log  
      protected long nSweep  
      protected java.lang.Runnable runner  
      protected long t0  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected TimeSweeper​(int interval)  
        TimeSweeper​(int interval, java.lang.Runnable runner)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Class<?> getRunnerClass()
      get the subclass or class of the runner
      boolean needSweep()
      if true we want to sweep
      void setFirstInterval​(int interval)  
      void setInterval​(int interval)  
      boolean sweep()
      default is nop or runner.run
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • log

        protected org.apache.commons.logging.Log log

      • t0

        protected long t0

      • nSweep

        protected long nSweep

      • runner

        protected java.lang.Runnable runner

    • Constructor Detail

      • TimeSweeper

        protected TimeSweeper​(int interval)
        Parameters:
        interval - the time interval in seconds

      • TimeSweeper

        public TimeSweeper​(int interval,
                   java.lang.Runnable runner)
        Parameters:
        interval - the time interval in seconds
        runner - the runnable to run

    • Method Detail

      • setInterval

        public void setInterval​(int interval)
        Parameters:
        interval - in seconds

      • setFirstInterval

        public void setFirstInterval​(int interval)
        Parameters:
        interval - in seconds

      • getRunnerClass

        public java.lang.Class<?> getRunnerClass()
        get the subclass or class of the runner
        Returns:

      • sweep

        public boolean sweep()
        default is nop or runner.run
        Specified by:
        sweep in interface Sweeper
        Returns:
        true if all went well
        See Also:
        Sweeper.sweep()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()