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.area;
18  
19  import java.util.Collection;
20  import java.util.List;
21  
22  import net.sf.mud4j.character.Character;
23  import net.sf.mud4j.world.Room;
24  import net.sf.mud4j.world.item.Item;
25  
26  /**
27   * Area interface for different types of areas.
28   * 
29   * @author Matthew Purland
30   *
31   */
32  public interface Area {
33      
34      /**
35       * Get name of the area.
36       */
37      public String getAreaName();
38      
39      /**
40       * Retrieve list of rooms contained in the area.
41       */
42      public List<Room> getRooms();
43      
44      /**
45       * Retrieve list of players contained in the area.
46       */
47      public List<Character> getCharacters();
48      
49      /**
50       * Retrieve list of items contained in area.
51       */
52      public List<Item> getItems();
53  
54  }