Class RecruitingSubTree

java.lang.Object

net.sf.colossus.variant.RecruitingSubTree

All Implemented Interfaces:

IRecruiting

public class RecruitingSubTree
extends Object
implements IRecruiting

The recruiting sub-tree in a terrain (or several terrains)

Author:

Romain Dolbeau

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RecruitingSubTree.RecruiterAndRecruit

Field Summary

Fields

Modifier and Type	Field	Description
private final Set<ICustomRecruitBase>	allCustom
private final Set<CreatureType>	allRecruits
private final Map<CreatureType, Integer>	any
private final Map<CreatureType, Integer>	anyDemiLord
private final Map<CreatureType, Integer>	anyLord
private final Map<CreatureType, Integer>	anyNonLord
private boolean	completed
private final AllCreatureType	creatureTypes
private static final Logger	LOGGER
private final Map<RecruitingSubTree.RecruiterAndRecruit, Integer>	regular

Constructor Summary

Constructors

Constructor	Description
RecruitingSubTree(AllCreatureType creatureTypes)

Method Summary

Modifier and Type	Method	Description
void	addAny(CreatureType recruit, int number)
void	addCustom(ICustomRecruitBase crb)
void	addDemiLord(CreatureType recruit, int number)
void	addLord(CreatureType recruit, int number)
void	addNonLord(CreatureType recruit, int number)
void	addRegular(CreatureType recruiter, CreatureType recruit, int number)
void	complete(boolean regularRecruit)
private void	completeGraph()
static Set<CreatureType>	getAllInAllSubtreesIgnoringSpecials(Variant variant, CreatureType creature)
private static Set<CreatureType>	getAllInAllSubtreesIgnoringSpecialsRec(Variant variant, Map<MasterBoardTerrain, Set<CreatureType>> checked, CreatureType creature)
Set<CreatureType>	getPossibleRecruiters(MasterHex hex)	Return all the CreatureType that can be recruits (something) in the hex.
Set<CreatureType>	getPossibleRecruits(MasterHex hex)	WARNING: This function, trough the CustomRecruitBase, can cause a caretaker update.
static boolean	isADeadEnd(Variant variant, CreatureType creature)
private boolean	isRegularAncestorOf(CreatureType a, CreatureType b, Set<CreatureType> checked)
int	maximumNumberNeededOf(CreatureType ct, MasterHex hex)
int	numberOfRecruiterNeeded(CreatureType recruiter, CreatureType recruit, MasterHex hex)	Return the number of recruiter needed to obtain a recruit in hex
String	toString()

Methods inherited from class Object

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

Field Details

LOGGER

private static final Logger LOGGER

regular

private final Map<RecruitingSubTree.RecruiterAndRecruit, Integer> regular

any

private final Map<CreatureType, Integer> any

anyNonLord

private final Map<CreatureType, Integer> anyNonLord

anyLord

private final Map<CreatureType, Integer> anyLord

anyDemiLord

private final Map<CreatureType, Integer> anyDemiLord

allCustom

private final Set<ICustomRecruitBase> allCustom

allRecruits

private final Set<CreatureType> allRecruits

completed

private boolean completed

creatureTypes

private final AllCreatureType creatureTypes

Constructor Details

RecruitingSubTree

public RecruitingSubTree(AllCreatureType creatureTypes)

Method Details

toString

public String toString()

Overrides:

toString in class Object

isRegularAncestorOf

private boolean isRegularAncestorOf(CreatureType a,
 CreatureType b,
 Set<CreatureType> checked)

completeGraph

private void completeGraph()

complete

public void complete(boolean regularRecruit)

addRegular

public void addRegular(CreatureType recruiter,
 CreatureType recruit,
 int number)

addAny

public void addAny(CreatureType recruit,
 int number)

addNonLord

public void addNonLord(CreatureType recruit,
 int number)

addLord

public void addLord(CreatureType recruit,
 int number)

addDemiLord

public void addDemiLord(CreatureType recruit,
 int number)

addCustom

public void addCustom(ICustomRecruitBase crb)

numberOfRecruiterNeeded

public int numberOfRecruiterNeeded(CreatureType recruiter,
 CreatureType recruit,
 MasterHex hex)

Description copied from interface: IRecruiting

Return the number of recruiter needed to obtain a recruit in hex

Specified by:

numberOfRecruiterNeeded in interface IRecruiting

Parameters:

recruiter - The Recruiter

recruit - The Recruit

hex - The hexagon in which the recruiting occurs

Returns:

The number of recruiter needed to obtain a recruit in hex

getPossibleRecruits

public Set<CreatureType> getPossibleRecruits(MasterHex hex)

WARNING: This function, trough the CustomRecruitBase, can cause a caretaker update. It should not be called under circumstances where this update is bad.

Specified by:

getPossibleRecruits in interface IRecruiting

Parameters:

hex - The hexagon to consider

Returns:

All CreatureType that can be recruited in hex

getPossibleRecruiters

public Set<CreatureType> getPossibleRecruiters(MasterHex hex)

Description copied from interface: IRecruiting

Return all the CreatureType that can be recruits (something) in the hex.

Specified by:

getPossibleRecruiters in interface IRecruiting

Parameters:

hex - The hexagon to consider

Returns:

All CreatureType that can recruit in hex

maximumNumberNeededOf

public int maximumNumberNeededOf(CreatureType ct,
 MasterHex hex)

Specified by:

maximumNumberNeededOf in interface IRecruiting

isADeadEnd

public static boolean isADeadEnd(Variant variant,
 CreatureType creature)

getAllInAllSubtreesIgnoringSpecials

public static Set<CreatureType> getAllInAllSubtreesIgnoringSpecials(Variant variant,
 CreatureType creature)

getAllInAllSubtreesIgnoringSpecialsRec

private static Set<CreatureType> getAllInAllSubtreesIgnoringSpecialsRec(Variant variant,
 Map<MasterBoardTerrain, Set<CreatureType>> checked,
 CreatureType creature)