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.world;
18  
19  /**
20   * Direction to define different directions for dynamic
21   * direction management to add west, east, north, south, etc...
22   * 
23   * @author Matthew Purland
24   */
25  public class Direction {
26      
27      private String directionName;
28      
29      /**
30       * Creates a direction with a name such as "north" or "south".
31       * @param directionName Name of the direction.
32       */
33      public Direction(String directionName) {
34          this.directionName = directionName;
35      }
36      
37      /**
38       * Get name of direction.
39       */
40      public String getDirectionName() {
41          return directionName;
42      }
43  }