com.palmergames.bukkit.towny.object

Class Nation

java.lang.Object

java.util.Observable

com.palmergames.bukkit.towny.object.TownyObject

com.palmergames.bukkit.towny.object.TownyEconomyObject

com.palmergames.bukkit.towny.object.Nation

All Implemented Interfaces:

ResidentList

public class Nation
extends TownyEconomyObject
implements ResidentList

Constructor Summary

Constructors

Constructor and Description
Nation(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlly(Nation nation)
void	addEnemy(Nation nation)
void	addTown(Town town)
void	clear()
void	collect(double amount)
java.util.List<Nation>	getAllies()
java.util.List<Resident>	getAssistants()
Town	getCapital()
java.lang.String	getEconomyName() Get a valid economy account name for this object.
java.util.List<Nation>	getEnemies()
int	getNumResidents()
int	getNumTowns()
java.util.List<Resident>	getResidents()
java.lang.String	getTag()
double	getTaxes()
java.util.List<Town>	getTowns()
java.util.List<java.lang.String>	getTreeString(int depth)
boolean	hasAlly(Nation nation)
boolean	hasAssistant(Resident resident)
boolean	hasCapital()
boolean	hasEnemy(Nation nation)
boolean	hasResident(Resident resident)
boolean	hasResident(java.lang.String name)
boolean	hasTag()
boolean	hasTown(java.lang.String name)
boolean	hasTown(Town town)
boolean	isCapital(Town town)
boolean	isKing(Resident resident)
boolean	isNeutral()
boolean	removeAllAllies()
boolean	removeAllEnemies()
boolean	removeAlly(Nation nation)
boolean	removeEnemy(Nation nation)
void	removeTown(Town town)
boolean	setAllegiance(java.lang.String type, Nation nation)
void	setAllies(java.util.List<Nation> allies)
void	setCapital(Town capital)
void	setEnemies(java.util.List<Nation> enemies)
void	setKing(Resident king)
void	setNeutral(boolean neutral)
void	setTag(java.lang.String text)
void	setTaxes(double taxes)
void	withdrawFromBank(Resident resident, int amount)

Methods inherited from class com.palmergames.bukkit.towny.object.TownyEconomyObject

canPayFromHoldings, collect, getHoldingBalance, getHoldingFormattedBalance, pay, payTo, removeAccount, setBalance

Methods inherited from class com.palmergames.bukkit.towny.object.TownyObject

getFormattedName, getName, getTreeDepth, getUID, isChangedName, setChangedName, setName, setUID, toString

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Nation

public Nation(java.lang.String name)

Method Detail

setTag

public void setTag(java.lang.String text)
            throws TownyException

Throws:

TownyException

getTag

public java.lang.String getTag()

hasTag

public boolean hasTag()

addAlly

public void addAlly(Nation nation)
             throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

removeAlly

public boolean removeAlly(Nation nation)
                   throws NotRegisteredException

Throws:

NotRegisteredException

removeAllAllies

public boolean removeAllAllies()

hasAlly

public boolean hasAlly(Nation nation)

addEnemy

public void addEnemy(Nation nation)
              throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

removeEnemy

public boolean removeEnemy(Nation nation)
                    throws NotRegisteredException

Throws:

NotRegisteredException

removeAllEnemies

public boolean removeAllEnemies()

hasEnemy

public boolean hasEnemy(Nation nation)

getTowns

public java.util.List<Town> getTowns()

isKing

public boolean isKing(Resident resident)

hasCapital

public boolean hasCapital()

hasAssistant

public boolean hasAssistant(Resident resident)

isCapital

public boolean isCapital(Town town)

hasTown

public boolean hasTown(java.lang.String name)

hasTown

public boolean hasTown(Town town)

addTown

public void addTown(Town town)
             throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

setCapital

public void setCapital(Town capital)

getCapital

public Town getCapital()

setAllegiance

public boolean setAllegiance(java.lang.String type,
                    Nation nation)

getAssistants

public java.util.List<Resident> getAssistants()

setEnemies

public void setEnemies(java.util.List<Nation> enemies)

getEnemies

public java.util.List<Nation> getEnemies()

setAllies

public void setAllies(java.util.List<Nation> allies)

getAllies

public java.util.List<Nation> getAllies()

getNumTowns

public int getNumTowns()

getNumResidents

public int getNumResidents()

removeTown

public void removeTown(Town town)
                throws EmptyNationException,
                       NotRegisteredException

Throws:

EmptyNationException

NotRegisteredException

setTaxes

public void setTaxes(double taxes)

getTaxes

public double getTaxes()

clear

public void clear()

setNeutral

public void setNeutral(boolean neutral)
                throws TownyException

Throws:

TownyException

isNeutral

public boolean isNeutral()

setKing

public void setKing(Resident king)
             throws TownyException

Throws:

TownyException

hasResident

public boolean hasResident(Resident resident)

collect

public void collect(double amount)
             throws EconomyException

Throws:

EconomyException

withdrawFromBank

public void withdrawFromBank(Resident resident,
                    int amount)
                      throws EconomyException,
                             TownyException

Throws:

EconomyException

TownyException

getResidents

public java.util.List<Resident> getResidents()

Specified by:

getResidents in interface ResidentList

getTreeString

public java.util.List<java.lang.String> getTreeString(int depth)

Overrides:

getTreeString in class TownyObject

hasResident

public boolean hasResident(java.lang.String name)

Specified by:

hasResident in interface ResidentList

getEconomyName

public java.lang.String getEconomyName()

Description copied from class: TownyEconomyObject

Get a valid economy account name for this object.

Overrides:

getEconomyName in class TownyEconomyObject

Returns:

account name