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  import net.sf.mud4j.character.Character;
20  
21  /**
22   * Defines a character ability.
23   * 
24   * @author Matthew Purland
25   */
26  public abstract class CharacterAbility implements Ability {
27  
28      // Character interface to use for ability.
29      protected Character character;
30      
31      /**
32       * Constructor to provide association between character and
33       * the ability.
34       * 
35       * @param character Character to associate to the ability.
36       */
37      public CharacterAbility(Character character) {
38          this.character = character;
39      }
40  
41      /**
42       * Get the character.
43       *
44       * @return the character.
45       */
46      public Character getCharacter() {
47          return this.character;
48      }        
49      
50      /**
51       * {@inheritDoc}
52       */
53      abstract public void run() throws AbilityException;
54  }