KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > buchuki > ensmer > input > command > Command


1 /*
2  * Copyright 2004 Dusty Phillips
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.buchuki.ensmer.input.command;
17
18 import com.buchuki.ensmer.input.event.*;
19
20 /**
21  * Interface representing a command that can occur. The command is executed
22  * given the EnsmerInputEvent that activated it.
23  *
24  * @author Dusty Phillips [dusty@buchuki.com]
25  */
26 public interface Command {
27
28     /**
29      * Execute the command. The EnsmerInputEvent that activated the command
30      * is provided in case it contains values needed by the execution of the
31      * command.
32      *
33      * @param event the EnsmerInputEvent that activated the command, or null
34      * if the command is going to be executed without an event.
35      * @return true if the command executed and should not be subject to
36      * further processing, false if some condition necessary for execution was
37      * not satisfied
38      */
39     public boolean execute(EnsmerInputEvent event);
40 }
41
Popular Tags