Module be.yildizgames.feature.construction.shared

Package be.yildizgames.engine.feature.construction

Class ConstructionQueue<R extends be.yildizgames.engine.feature.entity.construction.EntityConstructionStatus>

java.lang.Object

be.yildizgames.engine.feature.construction.ConstructionQueue<R>

public final class ConstructionQueue<R extends be.yildizgames.engine.feature.entity.construction.EntityConstructionStatus>
extends Object

Simple list of representation for entities in a queue waiting for construction.

Author:

Grégory Van den Borre

Constructor Summary

Constructors

Constructor	Description
ConstructionQueue(be.yildizgames.common.model.EntityId builderId, int maxSize)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	add(R e)	Add a new entity to build in the queue.
be.yildizgames.common.model.EntityId	getBuilderId()
List<R>	getList()
int	getNumberOfEntities(be.yildizgames.engine.feature.entity.data.EntityType type)	Compute the number of entities for a given type.
boolean	hasOnlyOneElement()
boolean	isEmpty()
boolean	remove(int request)
void	set(List<R> list)	Reset the construction list with new values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstructionQueue

public ConstructionQueue(be.yildizgames.common.model.EntityId builderId,
                         int maxSize)

Create a new instance.

Parameters:

builderId - Id of the builder holding this queue.

maxSize - Maximum size for the queue.

Throws:

NullPointerException - If builderId is null.

Method Detail

add

public void add(R e)

Add a new entity to build in the queue.

Parameters:

e - Entity data.

isEmpty

public boolean isEmpty()

set

public void set(List<R> list)

Reset the construction list with new values.

Parameters:

list - New values to set in the list.

Throws:

ConstructionQueueFullException - If the list size is bigger than the max size.

getList

public List<R> getList()

remove

public boolean remove(int request)

getNumberOfEntities

public int getNumberOfEntities(be.yildizgames.engine.feature.entity.data.EntityType type)

Compute the number of entities for a given type.

Parameters:

type - Type to check.

Returns:

The number of entities in the list matching the type.

hasOnlyOneElement

public boolean hasOnlyOneElement()

getBuilderId

public be.yildizgames.common.model.EntityId getBuilderId()