KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > event > command > RepeatedCommand


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12  * implied.
13  *
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 package org.apache.excalibur.event.command;
18
19 /**
20  * A Signal is a specific type of QueueElement that denotes a Control code
21  * for the Queue system.
22  *
23  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
24  */
25 public interface RepeatedCommand extends DelayedCommand
26 {
27     /**
28      * If the value is less than 1 (0 or negative), the command repeats for
29      * as long as the CommandManager is running. If the value is above 0,
30      * the Command repeats only for that specific amount of times before it
31      * is removed from the system.
32      *
33      * @return the number of times the command repeats
34      */
35     int getNumberOfRepeats();
36
37     /**
38      * Gets the repeat interval so that the CommandQueue keeps it for the
39      * specified amount of time before enqueuing it again. This value must
40      * not be negative.
41      *
42      * @return the number of milliseconds between each repeat
43      */
44     long getRepeatInterval();
45 }
46
Popular Tags