com.planet_ink.coffee_mud.Common
Class AuctionCoffeeShop

java.lang.Object
  com.planet_ink.coffee_mud.Common.AuctionCoffeeShop

All Implemented Interfaces:

CMCommon, CoffeeShop, CMObject, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class AuctionCoffeeShop
extends java.lang.Object
implements CoffeeShop

Field Summary

java.lang.String	auctionShop
static java.util.Vector	emptyV

Constructor Summary

AuctionCoffeeShop()

Method Summary

Environmental	addStoreInventory(Environmental thisThang, int number, int price, ShopKeeper shop) Adds a new item to the store inventory so the shopkeeper can sell it.
Environmental	addStoreInventory(Environmental thisThang, ShopKeeper shop) Adds a new item to the store inventory.
int	baseStockSize() Returns the number of items in the stores base inventory.
void	buildShopFromXML(java.lang.String text, ShopKeeper shop) Repopulates this shop inventory from a given xml document, restoring store inventory, base inventory, prices, and availability.
int	compareTo(CMObject o)
CMObject	copyOf() Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
void	delAllStoreInventory(Environmental thisThang, int whatISell) Removes all items like the given item from the base and store inventory.
boolean	doIHaveThisInStock(java.lang.String name, MOB mob, int whatISell, Room startRoom) Returns whether an item with the given name is presently in this stores stock inventory, and available for sale.
void	emptyAllShelves() Clears both the base and stock/store inventories.
java.util.Vector	getBaseInventory() Returns a Vector of all the Environmental objects this shop has in its base inventory.
Environmental	getStock(java.lang.String name, MOB mob, int whatISell, Room startRoom) Searches this shops stock of items for sale for one matching the given name.
java.util.Vector	getStoreInventory() Returns a Vector of all the Environmental objects this shop has for sale.
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
boolean	inBaseInventory(Environmental thisThang) Returns whether an item sufficiently like the given item originally existed in this shops inventory when it was created.
void	initializeClass() Called ONCE after all objects are loaded, but before the map is read in during initialization.
java.lang.String	makeXML(ShopKeeper shop) Generates an XML document of all available shop inventory, prices, and availability.
CMObject	newInstance() Returns a new instance of this class.
int	numberInStock(Environmental likeThis) Returns the number of items like the one given that the shopkeeper presently has in stock and available for sale.
java.util.Vector	removeSellableProduct(java.lang.String named, MOB mob, int whatISell, Room startRoom) Searches this shops stock of items for sale for one matching the given name.
Environmental	removeStock(java.lang.String name, MOB mob, int whatISell, Room startRoom) Searches this shops stock of items for sale for one matching the given name.
int	stockPrice(Environmental likeThis) Returns the base stock price (not the final price by any means) that the shop will use as a foundation for determining the given items price.
int	totalStockSize() Returns the number of items this shop currently has for sale.
int	totalStockSizeIncludingDuplicates() The number of items in the store inventory, taking number in stock into account.
int	totalStockWeight() Total weight, in pounds, of all items in the store inventory, taking number in stock into account.

Methods inherited from class java.lang.Object

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

Field Detail

emptyV

public static final java.util.Vector emptyV

auctionShop

public java.lang.String auctionShop

Constructor Detail

AuctionCoffeeShop

public AuctionCoffeeShop()

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, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Returns:

the name of this class

compareTo

public int compareTo(CMObject o)

Specified by:

compareTo in interface java.lang.Comparable<CMObject>

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Returns:

a clone of this object

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Returns:

a new instance of this class

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

inBaseInventory

public boolean inBaseInventory(Environmental thisThang)

Description copied from interface: CoffeeShop

Returns whether an item sufficiently like the given item originally existed in this shops inventory when it was created. Applies only to shops where their whatIsSold method returns ONLY_INVENTORY

Specified by:

inBaseInventory in interface CoffeeShop

Parameters:

thisThang - the thing to compare against the base inventory

Returns:

whether the item, or one just like it, is in the base inventory

See Also:

ShopKeeper.whatIsSold(), ShopKeeper.DEAL_INVENTORYONLY

addStoreInventory

public Environmental addStoreInventory(Environmental thisThang,
                                       ShopKeeper shop)

Description copied from interface: CoffeeShop

Adds a new item to the store inventory. Use this method when an item is sold to the store, as pricing and other information will have to be derived.

Specified by:

addStoreInventory in interface CoffeeShop

Parameters:

thisThang - the thing to sell

shop - the shop that's selling it

Returns:

the core store inventory item added

See Also:

CoffeeShop.addStoreInventory(Environmental, int, int, ShopKeeper)

baseStockSize

public int baseStockSize()

Description copied from interface: CoffeeShop

Returns the number of items in the stores base inventory. Only really useful for historical reasons, or if the shop sells inventory only.

Specified by:

baseStockSize in interface CoffeeShop

Returns:

the number of items in the base inventory

See Also:

ShopKeeper.whatIsSold(), ShopKeeper.DEAL_INVENTORYONLY

totalStockSize

public int totalStockSize()

Description copied from interface: CoffeeShop

Returns the number of items this shop currently has for sale. Does not take number of duplicates into account. For that call totalStockSize

Specified by:

totalStockSize in interface CoffeeShop

Returns:

the number of items for sale.

See Also:

CoffeeShop.totalStockSizeIncludingDuplicates()

getStoreInventory

public java.util.Vector getStoreInventory()

Description copied from interface: CoffeeShop

Returns a Vector of all the Environmental objects this shop has for sale. Will only return one of each item, even if multiple are available.

Specified by:

getStoreInventory in interface CoffeeShop

Returns:

a Vector of objects for sale.

getBaseInventory

public java.util.Vector getBaseInventory()

Description copied from interface: CoffeeShop

Returns a Vector of all the Environmental objects this shop has in its base inventory. Only useful for historical reasons, or if the shop sells inventory only.

Specified by:

getBaseInventory in interface CoffeeShop

Returns:

a Vector of objects in base inventory

See Also:

ShopKeeper.whatIsSold(), ShopKeeper.DEAL_INVENTORYONLY

addStoreInventory

public Environmental addStoreInventory(Environmental thisThang,
                                       int number,
                                       int price,
                                       ShopKeeper shop)

Description copied from interface: CoffeeShop

Adds a new item to the store inventory so the shopkeeper can sell it. All items added go cumulatively into the store inventory, and one copy is kept in the base inventory for historical reasons. The method is called when multiple items need to be added, or if the price is available. This method is usually used to build an original shop inventory.

Specified by:

addStoreInventory in interface CoffeeShop

Parameters:

thisThang - the item/mob/ability to sell

number - the number of items to sell

price - the price of the item (in base currency) or -1 to have it determined

shop - the shop selling the item

Returns:

the actual object stored in the inventory

totalStockWeight

public int totalStockWeight()

Description copied from interface: CoffeeShop

Total weight, in pounds, of all items in the store inventory, taking number in stock into account.

Specified by:

totalStockWeight in interface CoffeeShop

Returns:

the total weight in pounds

totalStockSizeIncludingDuplicates

public int totalStockSizeIncludingDuplicates()

Description copied from interface: CoffeeShop

The number of items in the store inventory, taking number in stock into account. Call this method to see how crowded the shop really is, as opposed to totalStockSize.

Specified by:

totalStockSizeIncludingDuplicates in interface CoffeeShop

Returns:

the total number of all items in stock

See Also:

CoffeeShop.totalStockSize()

delAllStoreInventory

public void delAllStoreInventory(Environmental thisThang,
                                 int whatISell)

Description copied from interface: CoffeeShop

Removes all items like the given item from the base and store inventory.

Specified by:

delAllStoreInventory in interface CoffeeShop

Parameters:

thisThang - the item like which to remove

whatISell - reference to what kind of stuff the store sells

See Also:

ShopKeeper.whatIsSold()

doIHaveThisInStock

public boolean doIHaveThisInStock(java.lang.String name,
                                  MOB mob,
                                  int whatISell,
                                  Room startRoom)

Description copied from interface: CoffeeShop

Returns whether an item with the given name is presently in this stores stock inventory, and available for sale.

Specified by:

doIHaveThisInStock in interface CoffeeShop

Parameters:

name - the name of the item to search for

mob - the mob who is interested (stock can differ depending on customer)

whatISell - reference to what kind of stuff the store sells

startRoom - the shops start room, for determining jurisdiction

Returns:

whether the item is available

See Also:

ShopKeeper.whatIsSold()

stockPrice

public int stockPrice(Environmental likeThis)

Description copied from interface: CoffeeShop

Returns the base stock price (not the final price by any means) that the shop will use as a foundation for determining the given items price. -1 would mean that the shopkeeper uses the valuation of the item as a basis, whereas another value is in base gold. Best to get likeThis item from the getStoreInventory()

Specified by:

stockPrice in interface CoffeeShop

Parameters:

likeThis - the item like which to compare

Returns:

the stock price of the item given.

See Also:

CoffeeShop.getStoreInventory()

numberInStock

public int numberInStock(Environmental likeThis)

Description copied from interface: CoffeeShop

Returns the number of items like the one given that the shopkeeper presently has in stock and available for sale.

Specified by:

numberInStock in interface CoffeeShop

Parameters:

likeThis - the item like which to compare

Returns:

the number currently in stock.

See Also:

CoffeeShop.getStoreInventory()

getStock

public Environmental getStock(java.lang.String name,
                              MOB mob,
                              int whatISell,
                              Room startRoom)

Description copied from interface: CoffeeShop

Searches this shops stock of items for sale for one matching the given name.

Specified by:

getStock in interface CoffeeShop

Parameters:

name - the name of the item to search for

mob - the mob who is interested (stock can differ depending on customer)

whatISell - reference to what kind of stuff the store sells

startRoom - the shops start room, for determining jurisdiction

Returns:

the available item, if found

See Also:

CoffeeShop.getStoreInventory()

removeStock

public Environmental removeStock(java.lang.String name,
                                 MOB mob,
                                 int whatISell,
                                 Room startRoom)

Description copied from interface: CoffeeShop

Searches this shops stock of items for sale for one matching the given name. If one is found, it copies the item, removes one from the available stock, and returns the copy.

Specified by:

removeStock in interface CoffeeShop

Parameters:

name - the name of the item to search for

mob - the mob who is interested (stock can differ depending on customer)

whatISell - reference to what kind of stuff the store sells

startRoom - the shops start room, for determining jurisdiction

Returns:

the available item, if found

See Also:

CoffeeShop.getStoreInventory()

emptyAllShelves

public void emptyAllShelves()

Description copied from interface: CoffeeShop

Clears both the base and stock/store inventories.

Specified by:

emptyAllShelves in interface CoffeeShop

removeSellableProduct

public java.util.Vector removeSellableProduct(java.lang.String named,
                                              MOB mob,
                                              int whatISell,
                                              Room startRoom)

Description copied from interface: CoffeeShop

Searches this shops stock of items for sale for one matching the given name. If one is found, it copies the item, removes one from the available stock, and prepares it for sale by adding it to a Vector along with any necessary accessories, such as necessary keys, or if a container, any contents of the container.

Specified by:

removeSellableProduct in interface CoffeeShop

Parameters:

named - the name of the item to search for

mob - the mob who is interested (stock can differ depending on customer)

whatISell - reference to what kind of stuff the store sells

startRoom - the shops start room, for determining jurisdiction

Returns:

the available items, if found, as a Vector of Environmental objects

See Also:

CoffeeShop.getStoreInventory()

makeXML

public java.lang.String makeXML(ShopKeeper shop)

Description copied from interface: CoffeeShop

Generates an XML document of all available shop inventory, prices, and availability.

Specified by:

makeXML in interface CoffeeShop

Parameters:

shop - the shopkeeper shop

Returns:

an XML document.

See Also:

CoffeeShop.getStoreInventory(), CoffeeShop.buildShopFromXML(String, ShopKeeper)

buildShopFromXML

public void buildShopFromXML(java.lang.String text,
                             ShopKeeper shop)

Description copied from interface: CoffeeShop

Repopulates this shop inventory from a given xml document, restoring store inventory, base inventory, prices, and availability.

Specified by:

buildShopFromXML in interface CoffeeShop

Parameters:

text - the xml document to restore from

shop - the shopkeeper shop

See Also:

CoffeeShop.makeXML(ShopKeeper)