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.world.Location;
20  
21  /**
22   * Abilities for locations.  The ability will be run on a location.
23   * 
24   * @author Matthew Purland
25   */
26  public abstract class LocationAbility implements Ability {
27  
28      // Location for the ability.
29      private Location location;
30      
31      /**
32       * Constructor to create a LocationAbility to associate
33       * the ability with a location.
34       * 
35       * @param location Location to associate with the specific ability.
36       */
37      public LocationAbility(Location location) {
38          this.location = location;
39      }
40      
41      /**
42       * Get the location for the ability.
43       * @return Returns the location that is associated with the ability.
44       */
45      public Location getLocation() {
46          return location;
47      }
48  
49      /**
50       * {@inheritDoc}
51       */
52      abstract public void run() throws AbilityException;
53  }