KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > resource > spi > timer > Timer


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.resource.spi.timer;
23
24 import java.util.List JavaDoc;
25
26 /**
27  * A Timer represents a.
28  *
29  * @author <a HREF="weston.price@jboss.com">Weston Price</a>
30  * @version $Revision: 45842 $
31  */
32 public interface Timer
33 {
34    
35    /**
36     * Cancel the timer.
37     *
38     */
39    public void cancel();
40    
41    /**
42     * Set the timer name;
43     *
44     * @param name the name of the timer.
45     *
46     */
47    public void setName(String JavaDoc name);
48    
49    /**
50     * Get the timer name.
51     *
52     * @return the timer name;
53     *
54     */
55    public String JavaDoc getName();
56    
57    public List JavaDoc getTimerListeners() throws TimerException;
58    public void setTimerListeners(List JavaDoc listeners);
59    
60    public boolean isPersistent();
61    
62    public boolean hasFired();
63    
64    public boolean isCanceled();
65    
66    public long getPeriod();
67    
68    public long getScheduledExecutionTime();
69    
70    
71 }
72
Popular Tags