Package za.co.wethinkcode.robots.server.world

Class WorldMap

java.lang.Object

za.co.wethinkcode.robots.server.world.WorldMap

public class WorldMap
extends Object

WorldMap answers questions about a single location in the world: is it in bounds, is it a wall, is it an obstacle, is a robot standing there, and is it therefore a valid place for a robot to be. This logic used to live directly on World as isValidPosition and its supporting methods.

Constructor Summary

Constructors

Constructor	Description
WorldMap(int width, int height, List<Position> obstacles, Supplier<Collection<Robot>> robots)
WorldMap(SavedWorld savedWorld)	Create a new worldMap from a previously saved world

Method Summary

Modifier and Type	Method	Description
void	addObstacleToMap(Obstacle obstacle, Position position)	Add a Obstacle somewhere on the map
void	addRobot(Robot robot)	Find the spawn of a robot, if viable, and add
void	addRobotToMap(Robot robot, Position position)	Add a Robot to the WorldMap at a given Position
Optional<Position>	findRandomValidPosition(Random random, int attempts)	Searches for a random position that is valid for a robot to occupy
org.apache.commons.collections4.bidimap.DualHashBidiMap<Position,WorldObject>	getAllObstacles()
org.apache.commons.collections4.bidimap.DualHashBidiMap<Position,WorldObject>	getAllWorldObjects()
Position	getPositionFromWorldObject(WorldObject obj)	Given a WorldObject return the Position there
Optional<Position>	getRandomSpawn()
Robot	getRobotAt(int x, int y)	Given an x and y int, create a new Position and see if a Robot is there.
String	getSymbolFromPosition(Position position, String fillerSymbol)
WorldObject	getWorldObjectFromPosition(Position position)	Given a Position return the world Object that is found there
boolean	isObstacleAt(int x, int y)	Check if the position that corresponds with these contains an Obstacle or WorldEdge
boolean	isValidPosition(Position p)	A position is valid for a Robot to occupy if it is within the bounds of the World, is not WorldEdge, is not Obstacle, and is not already occupied by another Robot.
boolean	isValidSpawn(Position p)
boolean	isWallAt(int x, int y)	A position out of bounds counts as a wall so that callers don't need to separately bounds-check before asking about walls.
boolean	isWallAt(Position p)
void	removeAllObstacles()	Utility method to remove all obstacles
void	removeRobotFromMap(Robot robot)	Given a Robot remove it from the WorldMap
Robot	safelyMoveRobot(Robot robot, Position newPosition)	Move a Robot on the WorldMap, and change any of the state that needs to be changed
void	setWhereEverythingIs(org.apache.commons.collections4.bidimap.DualHashBidiMap map)
void	updateRobotPositionOnMap(Robot robot, Position nextPosition)	Update the Position of a Robot in the WorldMap

Methods inherited from class java.lang.Object

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

Constructor Details

WorldMap

public WorldMap(int width,
 int height,
 List<Position> obstacles,
 Supplier<Collection<Robot>> robots)

Parameters:

width - width of the world, in steps

height - height of the world, in steps

obstacles - the list of obstacle positions in the world

robots - supplies the current collection of robots in the world. A Supplier is used (rather than a plain Collection) so this class always sees the up-to-date set of robots, even though robots come and go.

WorldMap

public WorldMap(SavedWorld savedWorld)

Create a new worldMap from a previously saved world

Method Details

isValidPosition

public boolean isValidPosition(Position p)

A position is valid for a Robot to occupy if it is within the bounds of the World, is not WorldEdge, is not Obstacle, and is not already occupied by another Robot.

isValidSpawn

public boolean isValidSpawn(Position p)

isWallAt

public boolean isWallAt(int x,
 int y)

A position out of bounds counts as a wall so that callers don't need to separately bounds-check before asking about walls.

isWallAt

public boolean isWallAt(Position p)

isObstacleAt

public boolean isObstacleAt(int x,
 int y)

Check if the position that corresponds with these contains an Obstacle or WorldEdge

Parameters:

x - x coord of position

y - y coord of position

Returns:

if there is an obstacle there

getRobotAt

public Robot getRobotAt(int x,
 int y)
                 throws MissingWorldObjectException

Given an x and y int, create a new Position and see if a Robot is there.

Parameters:

x - coord of the robot

y - coord of the robot

Returns:

the Robot at that Position

Throws:

MissingWorldObjectException - thrown if a robot is not found at this position

findRandomValidPosition

public Optional<Position> findRandomValidPosition(Random random,
 int attempts)

Searches for a random position that is valid for a robot to occupy

Parameters:

random - source of randomness for picking candidate positions

attempts - how many random positions to try before giving up

Returns:

a valid random Position or Optional empty() if none was found within attempts tries

getWorldObjectFromPosition

public WorldObject getWorldObjectFromPosition(Position position)
                                       throws MissingWorldObjectException

Given a Position return the world Object that is found there

Parameters:

position - the position to search for

Returns:

the WorldObject found there

Throws:

MissingWorldObjectException

getPositionFromWorldObject

public Position getPositionFromWorldObject(WorldObject obj)
                                    throws MissingWorldObjectException

Given a WorldObject return the Position there

Parameters:

obj - the WorldObject to search For

Returns:

the Position of the WorldObject

Throws:

MissingWorldObjectException

addRobotToMap

public void addRobotToMap(Robot robot,
 Position position)
                   throws ObstructionException,
TooManyOfYouException

Add a Robot to the WorldMap at a given Position

Please note that this is a distinct method from updateRobotPositionOnMap(Robot, Position)

Parameters:

robot - the robot being added to the map

position - where the Robot is being added

Throws:

MissingWorldObjectException

ObstructionException

TooManyOfYouException

addObstacleToMap

public void addObstacleToMap(Obstacle obstacle,
 Position position)

Add a Obstacle somewhere on the map

Parameters:

obstacle - the obstacle being added

position - where its being added

getSymbolFromPosition

public String getSymbolFromPosition(Position position,
 String fillerSymbol)

updateRobotPositionOnMap

public void updateRobotPositionOnMap(Robot robot,
 Position nextPosition)
                              throws MissingWorldObjectException

Update the Position of a Robot in the WorldMap

Parameters:

robot - the Robot being moved

nextPosition - the Position that the robot is being moved to.

Throws:

MissingWorldObjectException - if Robot is not currently in the world}

removeRobotFromMap

public void removeRobotFromMap(Robot robot)
                        throws MissingWorldObjectException

Given a Robot remove it from the WorldMap

If it doesn't exist, throw a MissingWorldObjectException

Parameters:

robot - the Robot being removed

Throws:

MissingWorldObjectException - if the Robot is not found

safelyMoveRobot

public Robot safelyMoveRobot(Robot robot,
 Position newPosition)
                      throws MissingWorldObjectException,
BeyondBoundryException

Move a Robot on the WorldMap, and change any of the state that needs to be changed

Parameters:

robot - the Robot being moved

newPosition - where the Robot is being moved to

Returns:

Robot with it's changed state

Throws:

MissingWorldObjectException

BeyondBoundryException

getAllWorldObjects

public org.apache.commons.collections4.bidimap.DualHashBidiMap<Position,WorldObject> getAllWorldObjects()

setWhereEverythingIs

public void setWhereEverythingIs(org.apache.commons.collections4.bidimap.DualHashBidiMap map)

addRobot

public void addRobot(Robot robot)
              throws WorldFullException,
TooManyOfYouException

Find the spawn of a robot, if viable, and add

Throws:

WorldFullException

TooManyOfYouException

getRandomSpawn

public Optional<Position> getRandomSpawn()

getAllObstacles

public org.apache.commons.collections4.bidimap.DualHashBidiMap<Position,WorldObject> getAllObstacles()

removeAllObstacles

public void removeAllObstacles()

Utility method to remove all obstacles