Room.java

import java.util.Set;
import java.util.HashMap;
import java.util.Iterator;
import java.util.ArrayList;
import java.util.Random;

/**
 * Class Room - a room in an adventure game.
 *
 * This class is part of the "World of Zuul" application. 
 * "World of Zuul" is a very simple, text based adventure game.  
 *
 * A "Room" represents one location in the scenery of the game.  It is 
 * connected to other rooms via exits.  For each existing exit, the room 
 * stores a reference to the neighboring room.
 * 
 * @author  Michael Kolling and David J. Barnes
 * @version 2006.03.30
 * 
 * @author Lynn Marshall
 * @version October 21, 2012
 * 
 * @author Erin Mccombe 
 * @version March 20, 2026
 */

public class Room 
{
    private String description;
    private HashMap<String, Room> exits;// stores exits of this room.
    private ArrayList<Item> items; // stores items in the room
    private static ArrayList<Room> allRooms = new ArrayList<Room>();
    /**
     * Create a room described "description". Initially, it has
     * no exits. "description" is something like "a kitchen" or
     * "an open court yard".
     * 
     * @param description The room's description.
     */
    public Room(String description) 
    {
        this.description = description;
        exits = new HashMap<String, Room>();
        items = new ArrayList<Item>();
        allRooms.add(this);
    }

    /**
     * Define an exit from this room.
     * 
     * @param direction The direction of the exit
     * @param neighbour The room to which the exit leads
     */
    public void setExit(String direction, Room neighbour) 
    {
        exits.put(direction, neighbour);
    }

    /**
     * Returns a short description of the room, i.e. the one that
     * was defined in the constructor
     * 
     * @return The short description of the room
     */
    public String getShortDescription()
    {
        return description;
    }

    /**
     * Return a long description of the room in the form:
     *     You are in the kitchen.
     *     Items in this room are: table with a weight of 11.
     *     Exits: north west
     *     
     * @return A long description of this room
     */
    public String getLongDescription()
    {
        return "You are " + description + ".\nItems in this room are " + itemString() + ".\n" + getExitString();
    }

    /**
     * Return a string describing the room's exits, for example
     * "Exits: north west".
     * 
     * @return Details of the room's exits
     */
    private String getExitString()
    {
        String returnString = "Exits:";
        Set<String> keys = exits.keySet();
        for(String exit : keys) {
            returnString += " " + exit;
        }
        return returnString;
    }

    /**
     * Return the room that is reached if we go from this room in direction
     * "direction". If there is no room in that direction, return null.
     * 
     * @param direction The exit's direction
     * @return The room in the given direction
     */
    public Room getExit(String direction) 
    {
        return exits.get(direction);
    }
    
    /**
     * Add a new item inside the room
     * 
     * @param item The item to be added to room
     */
    
    public void addItem (Item item)
    {
        items.add(item);
    }
    
    /**
     * Return a string of each item in the room 
     * 
     * @return a string of each item
     */
    
    private String itemString ()
    {
        String itemsString = "";
        for (Item item : items)
        {
           // add commas between
            if (!itemsString.isEmpty())
            {
                itemsString += ", ";
            }
            itemsString += item.getDescription(); 
        }
        return itemsString;
    }
        
    /**
     * Remove an item from the room.
     *
     * @param item The item to remove
     * @return true if removed, false otherwise
     */
    public boolean removeItem(Item item)
    {
        return items.remove(item);
    }
    
    /**
     * return Arraylist of items in current room
     *
     * @return an ArrayList of all items in the room
     */ 
    public ArrayList getItems() 
    { 
        return items; 
    }
    
    /**
     * Return the list of all rooms created in the game.
     *
     * @return ArrayList of all rooms
     */
    public static ArrayList<Room> getAllRooms()
    {
        return allRooms;
    }
}