Package com.planet_ink.coffee_mud.Libraries

Class CityCafe

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.CityCafe

All Implemented Interfaces:

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

public class CityCafe
extends StdLibrary
implements CityMap

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<Auctioneer>	auctionHouseList
protected java.util.List<Banker>	bankList
protected java.util.Map<java.lang.String,java.util.Set<Places>>	holyPlaces
protected java.util.List<Librarian>	libraryList
protected java.util.List<PostOffice>	postOfficeList

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

isDebugging, name, serviceClient, tickStatus

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

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
CityCafe()

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 newOne)	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.
protected java.util.Set<Places>	getHolyPlaces(java.lang.String deityName)
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.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
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	numAuctionHouses()
int	numBanks()
int	numLibraries()	Returns the number of cached Librarian objects
int	numPostOffices()
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, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick

Field Detail

postOfficeList

protected java.util.List<PostOffice> postOfficeList

auctionHouseList

protected java.util.List<Auctioneer> auctionHouseList

bankList

protected java.util.List<Banker> bankList

libraryList

protected java.util.List<Librarian> libraryList

holyPlaces

protected java.util.Map<java.lang.String,java.util.Set<Places>> holyPlaces

Constructor Detail

CityCafe

public CityCafe()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdLibrary

Returns:

the name of this class

numPostOffices

public int numPostOffices()

addPostOffice

public void addPostOffice(PostOffice newOne)

Description copied from interface: CityMap

Adds the given PostOffice object to the city cache

Specified by:

addPostOffice in interface CityMap

Parameters:

newOne - the PostOffice object to cache

See Also:

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

delPostOffice

public void delPostOffice(PostOffice oneToDel)

Description copied from interface: CityMap

Removes the given PostOffice object from the city cache

Specified by:

delPostOffice in interface CityMap

Parameters:

oneToDel - the PostOffice object to remove from the city cache

See Also:

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

getPostOffice

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

Description copied from interface: CityMap

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.

Specified by:

getPostOffice in interface CityMap

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:

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

postOffices

public java.util.Enumeration<PostOffice> postOffices()

Description copied from interface: CityMap

An enumeration of all PostOffice objects in the cache

Specified by:

postOffices in interface CityMap

Returns:

an enumeration of all PostOffice objects in the cache

See Also:

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

auctionHouses

public java.util.Enumeration<Auctioneer> auctionHouses()

Description copied from interface: CityMap

Returns an enumeration of all Auctioneer objects in the city cache

Specified by:

auctionHouses in interface CityMap

Returns:

an enumeration of all Auctioneer objects

See Also:

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

numAuctionHouses

public int numAuctionHouses()

addAuctionHouse

public void addAuctionHouse(Auctioneer newOne)

Description copied from interface: CityMap

Adds the given Auctioneer to the city cache

Specified by:

addAuctionHouse in interface CityMap

Parameters:

newOne - Auctioneer to add

See Also:

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

delAuctionHouse

public void delAuctionHouse(Auctioneer oneToDel)

Description copied from interface: CityMap

Deletes the given Auctioneer from the city cache

Specified by:

delAuctionHouse in interface CityMap

Parameters:

oneToDel - the Auctioneer to delete

See Also:

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

getAuctionHouse

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

Description copied from interface: CityMap

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.

Specified by:

getAuctionHouse in interface CityMap

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:

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

numBanks

public int numBanks()

addBank

public void addBank(Banker newOne)

Description copied from interface: CityMap

Adds the given Banker to this cache

Specified by:

addBank in interface CityMap

Parameters:

newOne - the Banker to add

See Also:

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

delBank

public void delBank(Banker oneToDel)

Description copied from interface: CityMap

Deletes the given Banker from the cache.

Specified by:

delBank in interface CityMap

Parameters:

oneToDel - the Banker to delete

See Also:

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

getBank

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

Description copied from interface: CityMap

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.

Specified by:

getBank in interface CityMap

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:

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

banks

public java.util.Enumeration<Banker> banks()

Description copied from interface: CityMap

Returns an enumeration of all Bankers in the cache

Specified by:

banks in interface CityMap

Returns:

an enumeration of all Bankers in the cache

See Also:

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

bankChains

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

Description copied from interface: CityMap

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

Specified by:

bankChains in interface CityMap

Parameters:

AreaOrNull - null or an Area to act as a filter

Returns:

an iterator of all bank chains

See Also:

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

getHolyPlaces

protected java.util.Set<Places> getHolyPlaces(java.lang.String deityName)

registerHolyPlace

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

Description copied from interface: CityMap

Register a particular room as infused to the given deity.

Specified by:

registerHolyPlace in interface CityMap

Parameters:

deityName - the deity to register

newOne - the new holy place

See Also:

CityMap.deregisterHolyPlace(String, Places), CityMap.holyPlaces(String)

deregisterHolyPlace

public void deregisterHolyPlace(java.lang.String deityName,
                                Places newOne)

Description copied from interface: CityMap

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

Specified by:

deregisterHolyPlace in interface CityMap

Parameters:

deityName - the deity to de-register

newOne - the old holy place for this deity

See Also:

CityMap.registerHolyPlace(String, Places), CityMap.holyPlaces(String)

holyPlaces

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

Description copied from interface: CityMap

Enumerate the holy places for the given deity.

Specified by:

holyPlaces in interface CityMap

Parameters:

deityName - the deity to list for

Returns:

the holy places for the deity.

See Also:

CityMap.registerHolyPlace(String, Places), CityMap.deregisterHolyPlace(String, Places)

numLibraries

public int numLibraries()

Description copied from interface: CityMap

Returns the number of cached Librarian objects

Specified by:

numLibraries in interface CityMap

Returns:

the number of cached Librarian objects

See Also:

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

addLibrary

public void addLibrary(Librarian newOne)

Description copied from interface: CityMap

Add a Librarian to the city cache

Specified by:

addLibrary in interface CityMap

Parameters:

newOne - the Librarian to add

See Also:

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

delLibrary

public void delLibrary(Librarian oneToDel)

Description copied from interface: CityMap

Delete a Librarian from the city cache.

Specified by:

delLibrary in interface CityMap

Parameters:

oneToDel - the Librarian to add

See Also:

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

getLibrary

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

Description copied from interface: CityMap

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.

Specified by:

getLibrary in interface CityMap

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:

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

libraries

public java.util.Enumeration<Librarian> libraries()

Description copied from interface: CityMap

Returns an enumeration of all Librarians in the cache.

Specified by:

libraries in interface CityMap

Returns:

an enumeration of all cached Librarians

See Also:

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

libraryChains

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

Description copied from interface: CityMap

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.

Specified by:

libraryChains in interface CityMap

Parameters:

areaOrNull - null, or an Area filter

Returns:

an iterator of library chains

See Also:

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