Package org.progettoedids.labyrinth

Class Labyrinth.Builder

java.lang.Object

org.progettoedids.labyrinth.Labyrinth.Builder

Enclosing class:

Labyrinth

public static class Labyrinth.Builder
extends Object

It's the class responsible for Building a fully configured Labyrinth in a valid state.

It can be obtained using the Labyrinth method newBuilder() and then needs to be properly configured in order for the Labyrinth to be built. A "properly configured" Labyrinth.Builder must verify the following conditions: - It has a name set - It has a difficulty set - It has a random number generator seed set - It has its dimensions set - A number of Room(s) all located at different Position(s) must be added. Such a number must match Dimensions.getWidth()*Dimensions.getHeight() of the Dimensions set - One and only one Player has been added

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
void	addEntity(Position position, Entity entity)	Adds an Entity to the Room located at the supplied Position
void	addRoom(Position position, Room room)	Adds a Room to the Room matrix at the specified Position
Labyrinth	build()	Builds and returns the Labyrinth based on the state set by calling the set-/add- method families of the Builder.
Difficulty	getDifficulty()
Dimensions	getDimensions()
String	getName()
Long	getRandomGeneratorSeed()
void	setDifficulty(Difficulty difficulty)	Sets the Difficulty enumerator of the Labyrinth If the Difficulty was already set it's overwritten with the new one.
void	setDimensions(Dimensions dimensions)	Sets the Dimensions of the Labyrinth If the Dimensions object was already set it's overwritten with the new one.
void	setName(String name)	Sets the name of the Labyrinth.
void	setRandomGeneratorSeed(long randomGeneratorSeed)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Method Details

setName

public void setName(String name)

Sets the name of the Labyrinth. If the name was already set it's overwritten with the new one.

Parameters:

name - String with the name to set. Must not be null

setDifficulty

public void setDifficulty(Difficulty difficulty)

Sets the Difficulty enumerator of the Labyrinth If the Difficulty was already set it's overwritten with the new one.

Parameters:

difficulty - the Difficulty enumerator to set. Must not be null

setRandomGeneratorSeed

public void setRandomGeneratorSeed(long randomGeneratorSeed)

setDimensions

public void setDimensions(Dimensions dimensions)

Sets the Dimensions of the Labyrinth If the Dimensions object was already set it's overwritten with the new one.

Parameters:

dimensions - the Dimensions object to set. Must not be null

addRoom

public void addRoom(Position position,
 Room room)

Adds a Room to the Room matrix at the specified Position

Parameters:

position - the Position of the Room to add. Must not be null

room - the Room to add. Must not be null

addEntity

public void addEntity(Position position,
 Entity entity)

Adds an Entity to the Room located at the supplied Position

Parameters:

position - the Position at which to place the Entity. Must not be null

entity - the Entity to add. Must not be null

getName

public String getName()

getDifficulty

public Difficulty getDifficulty()

getRandomGeneratorSeed

public Long getRandomGeneratorSeed()

getDimensions

public Dimensions getDimensions()

build

public Labyrinth build()

Builds and returns the Labyrinth based on the state set by calling the set-/add- method families of the Builder.

Returns:

a configured and legal Labyrinth