Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface CityMap

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

CityCafe

public interface CityMap
extends CMLibrary

For the sake of efficient look-ups, the engine keeps certain kinds of objects cached together, regardless of where they are in the world. The CityMap does this for objects normally found in cities, such as banks, post offices, auction houses, libraries, etc.

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
void	addAuctionHouse(Auctioneer newOne)	Adds the given Auctioneer to the city cache
void	addBank(Banker newOne)	Adds the given Banker to this cache
void	addLibrary(Librarian newOne)	Add a Librarian to the city cache
void	addPostOffice(PostOffice newOne)	Adds the given PostOffice object to the city cache
java.util.Enumeration<Auctioneer>	auctionHouses()	Returns an enumeration of all Auctioneer objects in the city cache
java.util.Enumeration<java.lang.String>	bankChains(Area areaOrNull)	Returns an iterator of all bank chains, with a given optional Area to act as a filter.
java.util.Enumeration<Banker>	banks()	Returns an enumeration of all Bankers in the cache
void	delAuctionHouse(Auctioneer oneToDel)	Deletes the given Auctioneer from the city cache
void	delBank(Banker oneToDel)	Deletes the given Banker from the cache.
void	delLibrary(Librarian oneToDel)	Delete a Librarian from the city cache.
void	delPostOffice(PostOffice oneToDel)	Removes the given PostOffice object from the city cache
void	deregisterHolyPlace(java.lang.String deityName, Places oldOne)	De-register a particular room that was probably infused to the given deity.
Auctioneer	getAuctionHouse(java.lang.String chain, java.lang.String areaNameOrBranch)	Returns a cached Auctioneer of the given chain, from the given area.
Banker	getBank(java.lang.String chain, java.lang.String areaNameOrBranch)	Returns a cached Banker of the given chain, from the given area.
Librarian	getLibrary(java.lang.String chain, java.lang.String areaNameOrBranch)	Returns a cached Librarian of the given chain, from the given area.
PostOffice	getPostOffice(java.lang.String chain, java.lang.String areaNameOrBranch)	Returns a cached PostOffice of the given chain, from the given area.
java.util.Enumeration<Places>	holyPlaces(java.lang.String deityName)	Enumerate the holy places for the given deity.
java.util.Enumeration<Librarian>	libraries()	Returns an enumeration of all Librarians in the cache.
java.util.Enumeration<java.lang.String>	libraryChains(Area areaOrNull)	Given an Area to act as filter, or null for no filter, this will return an iterator of library chain names.
int	numLibraries()	Returns the number of cached Librarian objects
java.util.Enumeration<PostOffice>	postOffices()	An enumeration of all PostOffice objects in the cache
void	registerHolyPlace(java.lang.String deityName, Places newOne)	Register a particular room as infused to the given deity.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getAuctionHouse

Auctioneer getAuctionHouse(java.lang.String chain,
                           java.lang.String areaNameOrBranch)

Returns a cached Auctioneer of the given chain, from the given area. If the area name is also the same as the chain, it just returns the first Auctioneer in that chain, otherwise, it only returns the first Auctioneer whose home is that area name.

Parameters:

chain - name of the chain to return a Auctioneer of

areaNameOrBranch - name of the area to return the chain Auctioneer in

Returns:

the cached Auctioneer, or null

See Also:

getAuctionHouse(String, String), auctionHouses(), addAuctionHouse(Auctioneer), delAuctionHouse(Auctioneer)

auctionHouses

java.util.Enumeration<Auctioneer> auctionHouses()

Returns an enumeration of all Auctioneer objects in the city cache

Returns:

an enumeration of all Auctioneer objects

See Also:

getAuctionHouse(String, String), auctionHouses(), addAuctionHouse(Auctioneer), delAuctionHouse(Auctioneer)

addAuctionHouse

void addAuctionHouse(Auctioneer newOne)

Adds the given Auctioneer to the city cache

Parameters:

newOne - Auctioneer to add

See Also:

getAuctionHouse(String, String), auctionHouses(), addAuctionHouse(Auctioneer), delAuctionHouse(Auctioneer)

delAuctionHouse

void delAuctionHouse(Auctioneer oneToDel)

Deletes the given Auctioneer from the city cache

Parameters:

oneToDel - the Auctioneer to delete

See Also:

getAuctionHouse(String, String), auctionHouses(), addAuctionHouse(Auctioneer), delAuctionHouse(Auctioneer)

getPostOffice

PostOffice getPostOffice(java.lang.String chain,
                         java.lang.String areaNameOrBranch)

Returns a cached PostOffice of the given chain, from the given area. If the area name is also the same as the chain, it just returns the first PostOffice in that chain, otherwise, it only returns the first PostOffice whose home is that area name.

Parameters:

chain - name of the postal chain to return a Banker of

areaNameOrBranch - name of the area to return the chain PostOffice in

Returns:

the cached PostOffice, or null

See Also:

getPostOffice(String, String), postOffices(), addPostOffice(PostOffice), delPostOffice(PostOffice)

postOffices

java.util.Enumeration<PostOffice> postOffices()

An enumeration of all PostOffice objects in the cache

Returns:

an enumeration of all PostOffice objects in the cache

See Also:

getPostOffice(String, String), postOffices(), addPostOffice(PostOffice), delPostOffice(PostOffice)

addPostOffice

void addPostOffice(PostOffice newOne)

Adds the given PostOffice object to the city cache

Parameters:

newOne - the PostOffice object to cache

See Also:

getPostOffice(String, String), postOffices(), addPostOffice(PostOffice), delPostOffice(PostOffice)

delPostOffice

void delPostOffice(PostOffice oneToDel)

Removes the given PostOffice object from the city cache

Parameters:

oneToDel - the PostOffice object to remove from the city cache

See Also:

getPostOffice(String, String), postOffices(), addPostOffice(PostOffice), delPostOffice(PostOffice)

getBank

Banker getBank(java.lang.String chain,
               java.lang.String areaNameOrBranch)

Returns a cached Banker of the given chain, from the given area. If the area name is also the same as the chain, it just returns the first Banker in that chain, otherwise, it only returns the first Banker whose home is that area name.

Parameters:

chain - name of the bank chain to return a Banker of

areaNameOrBranch - name of the area to return the chain Banker in

Returns:

the cached Banker, or null

See Also:

banks(), bankChains(Area), addBank(Banker), delBank(Banker)

banks

java.util.Enumeration<Banker> banks()

Returns an enumeration of all Bankers in the cache

Returns:

an enumeration of all Bankers in the cache

See Also:

getBank(String, String), bankChains(Area), addBank(Banker), delBank(Banker)

bankChains

java.util.Enumeration<java.lang.String> bankChains(Area areaOrNull)

Returns an iterator of all bank chains, with a given optional Area to act as a filter.

Parameters:

areaOrNull - null or an Area to act as a filter

Returns:

an iterator of all bank chains

See Also:

getBank(String, String), banks(), addBank(Banker), delBank(Banker)

addBank

void addBank(Banker newOne)

Adds the given Banker to this cache

Parameters:

newOne - the Banker to add

See Also:

getBank(String, String), banks(), bankChains(Area), delBank(Banker)

delBank

void delBank(Banker oneToDel)

Deletes the given Banker from the cache.

Parameters:

oneToDel - the Banker to delete

See Also:

getBank(String, String), banks(), bankChains(Area), addBank(Banker)

numLibraries

int numLibraries()

Returns the number of cached Librarian objects

Returns:

the number of cached Librarian objects

See Also:

getLibrary(String, String), libraries(), libraryChains(Area), addLibrary(Librarian), delLibrary(Librarian)

getLibrary

Librarian getLibrary(java.lang.String chain,
                     java.lang.String areaNameOrBranch)

Returns a cached Librarian of the given chain, from the given area. If the area name is also the same as the chain, it just returns the first Librarian in that chain, otherwise, it only returns the first Librarian whose home is that area name.

Parameters:

chain - name of the library chain to return a librarian of

areaNameOrBranch - name of the area to return the chain librarian in

Returns:

null, or the found Librarian

See Also:

numLibraries(), libraries(), libraryChains(Area), addLibrary(Librarian), delLibrary(Librarian)

libraries

java.util.Enumeration<Librarian> libraries()

Returns an enumeration of all Librarians in the cache.

Returns:

an enumeration of all cached Librarians

See Also:

numLibraries(), getLibrary(String, String), libraryChains(Area), addLibrary(Librarian), delLibrary(Librarian)

libraryChains

java.util.Enumeration<java.lang.String> libraryChains(Area areaOrNull)

Given an Area to act as filter, or null for no filter, this will return an iterator of library chain names. The Area filter also respects child areas.

Parameters:

areaOrNull - null, or an Area filter

Returns:

an iterator of library chains

See Also:

numLibraries(), getLibrary(String, String), libraries(), addLibrary(Librarian), delLibrary(Librarian)

addLibrary

void addLibrary(Librarian newOne)

Add a Librarian to the city cache

Parameters:

newOne - the Librarian to add

See Also:

numLibraries(), getLibrary(String, String), libraries(), libraryChains(Area), delLibrary(Librarian)

delLibrary

void delLibrary(Librarian oneToDel)

Delete a Librarian from the city cache.

Parameters:

oneToDel - the Librarian to add

See Also:

numLibraries(), getLibrary(String, String), libraries(), libraryChains(Area), addLibrary(Librarian)

registerHolyPlace

void registerHolyPlace(java.lang.String deityName,
                       Places newOne)

Register a particular room as infused to the given deity.

Parameters:

deityName - the deity to register

newOne - the new holy place

See Also:

deregisterHolyPlace(String, Places), holyPlaces(String)

deregisterHolyPlace

void deregisterHolyPlace(java.lang.String deityName,
                         Places oldOne)

De-register a particular room that was probably infused to the given deity.

Parameters:

deityName - the deity to de-register

oldOne - the old holy place for this deity

See Also:

registerHolyPlace(String, Places), holyPlaces(String)

holyPlaces

java.util.Enumeration<Places> holyPlaces(java.lang.String deityName)

Enumerate the holy places for the given deity.

Parameters:

deityName - the deity to list for

Returns:

the holy places for the deity.

See Also:

registerHolyPlace(String, Places), deregisterHolyPlace(String, Places)