Package org.progettoedids.rooms

Class Room

java.lang.Object

org.progettoedids.rooms.Room

Direct Known Subclasses:

BlockedRoom, DoorlessRoom, RoomWithDoors, TeleportRoom, VictoryRoom

public abstract class Room
extends Object

A Room a container of Entity(ies) that is characterized by a character symbol.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Room(char charSymbol)

Method Summary

Modifier and Type	Method	Description
void	addEntity(Entity entity)	Adds an Entity to the Room.
char	getCharSymbol()	Returns the character symbol characterizing the type of this instance of Room.
Entity[]	getEntities()	Returns all the Entity(ies) held in the Room
<T> Entity[]	getEntities(Class<T> entityClass)
Entity	getEntity(UUID entityUUID)	Returns an Entity matching the supplied UUID held in the Room.
abstract boolean	isLocked()	Returns whether the Room is locked or not.
Entity	removeEntity(UUID entityUUID)	Removes the Entity matching the specified UUID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Room

protected Room(char charSymbol)

Method Details

isLocked

public abstract boolean isLocked()

Returns whether the Room is locked or not.

A locked Room cannot be crossed by other Entity(ies). Depending on subtype implementation it might be possible the Room can be unlocked in some way.

Returns:

true if the Room is locked, false otherwise

getEntity

public Entity getEntity(UUID entityUUID)

Returns an Entity matching the supplied UUID held in the Room.

Parameters:

entityUUID - the UUID of the Entity to return. Must not be null

Returns:

the Entity corresponding to the UUID or null if not found

getEntities

public <T> Entity[] getEntities(Class<T> entityClass)

getEntities

public Entity[] getEntities()

Returns all the Entity(ies) held in the Room

Returns:

an array holding all the Entities in the Room, can be empty

addEntity

public void addEntity(Entity entity)

Adds an Entity to the Room.

Parameters:

entity - the Entity to add

removeEntity

public Entity removeEntity(UUID entityUUID)

Removes the Entity matching the specified UUID.

Parameters:

entityUUID - the UUID identifying an Entity

Returns:

the Entity that has been removed

Throws:

IllegalArgumentException - if an Entity corresponding to the UUID couldn't be found

getCharSymbol

public char getCharSymbol()

Returns the character symbol characterizing the type of this instance of Room.

Returns:

a character symbol