Package com.planet_ink.coffee_mud.Libraries

Class CoffeeTables

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.CoffeeTables

All Implemented Interfaces:

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

public class CoffeeTables
extends StdLibrary
implements StatisticsLibrary

Field Summary

Fields

Modifier and Type	Field	Description
CoffeeTableRow	todays

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
CoffeeTables()

Method Summary

Modifier and Type	Method	Description
boolean	activate()	Activates the library.
void	bump(CMObject E, int type)	Add a new statistic by bumping its total.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
java.util.List<CoffeeTableRow>	readRawStats(long startDate, long endDate)	Returns all of the statistics rows between the given dates, with the end date usually being 0 for some reason.
boolean	shutdown()	Shuts down the library.
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.
void	update()	Flush any cached statistics to the database.

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

getServiceClient, L, propertiesLoaded

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

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

Field Detail

todays

public volatile CoffeeTableRow todays

Constructor Detail

CoffeeTables

public CoffeeTables()

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

update

public void update()

Description copied from interface: StatisticsLibrary

Flush any cached statistics to the database.

Specified by:

update in interface StatisticsLibrary

bump

public void bump(CMObject E,
                 int type)

Description copied from interface: StatisticsLibrary

Add a new statistic by bumping its total. See all the STAT_ constants in CoffeeTableRow

Specified by:

bump in interface StatisticsLibrary

Parameters:

E - the object that is having its stat bumped

type - the type of stat to bump

See Also:

CoffeeTableRow.STAT_ARRESTS

activate

public boolean activate()

Description copied from interface: CMLibrary

Activates the library. This is called after the mud is booted, but before connections are accepted.

Specified by:

activate in interface CMLibrary

Overrides:

activate in class StdLibrary

Returns:

true if activation was successful, false if you're screwed

See Also:

CMLibrary.shutdown()

tick

public boolean tick(Tickable ticking,
                    int tickID)

Description copied from interface: Tickable

this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.

Specified by:

tick in interface Tickable

Overrides:

tick in class StdLibrary

Parameters:

ticking - a reference to this Tickable object

tickID - the TICKID_ constant describing this periodic call, as defined in Tickable

Returns:

true always, unless this object no longer wishes to ever tick again, in which case false

See Also:

Tickable, ServiceEngine, TickableGroup

shutdown

public boolean shutdown()

Description copied from interface: CMLibrary

Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

Returns:

true if shutdown was successful, false if there's nothing you can do about it

See Also:

CMLibrary.activate()

readRawStats

public java.util.List<CoffeeTableRow> readRawStats(long startDate,
                                                   long endDate)

Description copied from interface: StatisticsLibrary

Returns all of the statistics rows between the given dates, with the end date usually being 0 for some reason.

Specified by:

readRawStats in interface StatisticsLibrary

Parameters:

startDate - the start date in milliseconds

endDate - 0 for 'up to the present', or an end date in milliseconds

Returns:

a list of all relevant rows