game.interfaces
Interface AreaAdministration

All Superinterfaces:

Administration

All Known Subinterfaces:

Government, ProvinceAdministration

All Known Implementing Classes:

AreaAdministrationClass, GovernmentClass, ProvinceAdministrationClass

public interface AreaAdministration

extends Administration

Base class for administrations that have subordinates.

Method Summary

void	addSubordinate(Administration value) Add a subordinate administration.
Square	getLargestCity() Return the largest city in this administration.
Square	getLargestSquare() Return the largest square (most populated) in this administration.
int	getNumberOfSquares() Return the number of squares controlled.
float	getPopulation() Return the population.
java.util.Iterator	iterator() Iterate over subordinates.
void	moveCapital(Square square) Move capital if old capital lost.
boolean	removeRecruits(float recruits) Remove recruits (for building a unit).
void	removeSubordinate(Administration value) Remove a subordinate.
int	size() Number of immediate subordinates.
java.util.Iterator	squareIterator() Iterator over squares.

Methods inherited from interface game.interfaces.Administration

addEthnicPopulation, economicsTurn, getCapital, getCivilization, getEconomy, getEthnicDiscrimination, getGovernment, getGovtEconOrders, getIsolation, getName, getPort, getReligionEffect, getReligiousDiscrimination, getSquare, getSuperior, getTaxRate, isGovernment, setEconomy, setName, setPort, setSquare, setSuperior, setTaxRate, setupEthnicPopulations, updateGovernmentPolicies

Method Detail

addSubordinate

public void addSubordinate(Administration value)

Add a subordinate administration.

Parameters:

value - the subordinate to add.

removeSubordinate

public void removeSubordinate(Administration value)

Remove a subordinate.

Parameters:

value - the subordinate to remove.

iterator

public java.util.Iterator iterator()

Iterate over subordinates.

Specified by:

iterator in interface Administration

Returns:

iterator over subordinates.

squareIterator

public java.util.Iterator squareIterator()

Iterator over squares.

Specified by:

squareIterator in interface Administration

Returns:

iterator over squares.

size

public int size()

Number of immediate subordinates.

Specified by:

size in interface Administration

Returns:

number of immediate subordinates.

getPopulation

public float getPopulation()

Return the population.

Specified by:

getPopulation in interface Administration

Returns:

the population.

removeRecruits

public boolean removeRecruits(float recruits)

Remove recruits (for building a unit).

Specified by:

removeRecruits in interface Administration

Parameters:

recruits - the population to remove.

Returns:

true if there is enough population, if not, none is removed and false is returned.0

getNumberOfSquares

public int getNumberOfSquares()

Return the number of squares controlled.

Specified by:

getNumberOfSquares in interface Administration

Returns:

the number of squares controlled.

getLargestCity

public Square getLargestCity()

Return the largest city in this administration. Used when a capital is lost.

getLargestSquare

public Square getLargestSquare()

Return the largest square (most populated) in this administration. Used when a capital is lost and there are no cities.

moveCapital

public void moveCapital(Square square)

Move capital if old capital lost. Does not apply at this level.