View Javadoc

1   /**
2    * Copyright 2006 Matthew Purland (m.purland@gmail.com)
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  
17  package net.sf.mud4j.ability;
18  
19  /**
20   * Ability interface to create basic interface for abilities that may be used by
21   * commands, or other abilities. An ability is a runnable independent command
22   * that acts upon a target (Character, Location, Item, etc).
23   * 
24   * @author Matthew Purland
25   */
26  public interface Ability {
27      /**
28       * Run the ability.
29       * 
30       * @throws AbilityException in case the ability encounters a problem or
31       *             cannot continue.
32       */
33      public void run() throws AbilityException;
34  }