KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > mx > util > RunnableScheduler


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */

22 package org.jboss.mx.util;
23
24 import java.util.Iterator JavaDoc;
25 import java.util.TreeSet JavaDoc;
26
27 import org.jboss.util.threadpool.ThreadPool;
28 import org.jboss.util.timeout.TimeoutFactory;
29 import org.jboss.util.timeout.Timeout;
30
31 /**
32  * A runnable scheduler.<p>
33  *
34  * The scheduler needs to be started to do real work. To add work to the
35  * scheduler, create a SchedulableRunnable and set the scheduler. When
36  * the next run has passed the work is performed.
37  *
38  * @see SchedulableRunnable
39  *
40  * @author <a HREF="mailto:Adrian.Brock@HappeningTimes.com">Adrian Brock</a>.
41  * @version $Revision: 58167 $
42  */

43 public class RunnableScheduler
44 {
45
46    // Attributes ----------------------------------------------------
47

48    /**
49     * The runnables to schedule
50     */

51    private TimeoutFactory factory;
52
53    /**
54     * Constructs a new runnable scheduler.
55     */

56    public RunnableScheduler()
57    {
58        this.factory = new TimeoutFactory();
59    }
60
61    /**
62     * Constructs a new runnable scheduler.
63     */

64    public RunnableScheduler(ThreadPool threadPool)
65    {
66        this.factory = new TimeoutFactory(threadPool);
67    }
68
69    /**
70     * Starts the scheduler.
71     */

72    public void start()
73    {
74    }
75
76    /**
77     * Stops the scheduler, cancels all submitted jobs.
78     */

79    public synchronized void stop()
80    {
81       factory.cancel();
82    }
83
84    /**
85     * Runs the scheduler.
86     */

87    public void run()
88    {
89    }
90
91    // Public --------------------------------------------------------
92

93    // X Implementation ----------------------------------------------
94

95    // Y Overrides ---------------------------------------------------
96

97    // Protected -----------------------------------------------------
98

99    // Package -------------------------------------------------------
100

101    /**
102     * Add a schedulable runnable
103     *
104     * @param runnable the runnable to add
105     */

106    Timeout add(SchedulableRunnable runnable)
107    {
108       return factory.schedule(runnable.getNextRun(), runnable);
109    }
110
111    // Private -------------------------------------------------------
112

113    // Inner Classes -------------------------------------------------
114
}
115
116
Popular Tags