Package com.planet_ink.coffee_mud.core.threads

Class StdTickGroup

java.lang.Object

com.planet_ink.coffee_mud.core.threads.StdTickGroup

All Implemented Interfaces:

TickableGroup, CMRunnable, java.lang.Cloneable, java.lang.Runnable

public class StdTickGroup
extends java.lang.Object
implements TickableGroup, java.lang.Cloneable

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.TickableGroup

TickableGroup.LocalType

Constructor Summary

Constructors

Constructor	Description
StdTickGroup(long sleep, java.lang.String threadGroupName, boolean isSolitary)
StdTickGroup(ThreadEngine theEngine, long sleep, java.lang.String threadGroupName, boolean isSolitary)
StdTickGroup(java.lang.String a_name, long sleep, java.lang.String threadGroupName, boolean isSolitary)

Method Summary

Modifier and Type	Method	Description
long	activeTimeMillis()	Returns the number of milliseconds this runnable has been running.
void	addTicker(TickClient C)	Adds another ticking object to this group
boolean	contains(Tickable T, int tickID)	Returns true if this group contains the given ticking object with the given tickID.
StdTickGroup	copyOf()
boolean	delTicker(TickClient C)	Removes the given ticking object from this group
TickClient	fetchTickerByIndex(int i)	Returns the tickclient at the given index from 0 to numTickers
int	getCounter()
java.lang.Thread	getCurrentThread()	If this group is currently getting thread time, this will return a reference to that thread object, or null otherwise.
int	getGroupID()	The group identifier for this runnable, which may be used for executor selection
long	getLastStartTime()	Returns the time, in ms, that this object last ticked.
long	getLastStopTime()	Returns the time, in ms, that this object last stopped ticking.
TickClient	getLastTicked()	Returns the current or last TickClient object which this thread made a tick(Tickable,int) method call to.
java.util.Iterator<TickClient>	getLocalItems(TickableGroup.LocalType itemTypes, Room R)	Returns an iterator of all the items of the given type in the given room.
long	getMilliTotal()	Returns the number of ms that this object has ticked in total
java.lang.String	getName()	Returns the name of this group
long	getNextTickTime()	Returns the next time, in ms, when this group should tick.
long	getStartTime()	Either the time this runnable did start running, or will start running, depending on whether it's scheduled
java.lang.String	getStatus()	Returns the displayable status of this ticking object
java.lang.String	getThreadGroupName()	Returns the name of the thread group that this ticking group belongs to (and thus, under which it should run later)
long	getTickInterval()	Returns the amount of time, in ms, between calls to this group
java.util.Iterator<TickClient>	getTickSet(Tickable T, int tickID)	Returns an iterator of all clients matching the given criteria
long	getTickTotal()	Returns the number of times that this object has ticked in total
boolean	isAwake()	Returns true if this group currently is getting thread time
boolean	isSolitaryTicker()	Returns whether this group is only permitted a single object
int	numTickers()	Returns the number of ticking objects in this group
void	run()
void	shutdown()	Orders this group to do any necessary cleanup before going away.
java.util.Iterator<TickClient>	tickers()	Returns an iterator of all the ticking objects

Methods inherited from class java.lang.Object

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

Constructor Detail

StdTickGroup

public StdTickGroup(long sleep,
                    java.lang.String threadGroupName,
                    boolean isSolitary)

StdTickGroup

public StdTickGroup(java.lang.String a_name,
                    long sleep,
                    java.lang.String threadGroupName,
                    boolean isSolitary)

StdTickGroup

public StdTickGroup(ThreadEngine theEngine,
                    long sleep,
                    java.lang.String threadGroupName,
                    boolean isSolitary)

Method Detail

copyOf

public StdTickGroup copyOf()

getStartTime

public long getStartTime()

Description copied from interface: CMRunnable

Either the time this runnable did start running, or will start running, depending on whether it's scheduled

Specified by:

getStartTime in interface CMRunnable

Returns:

the time in millis

getGroupID

public int getGroupID()

Description copied from interface: CMRunnable

The group identifier for this runnable, which may be used for executor selection

Specified by:

getGroupID in interface CMRunnable

Returns:

the identifier for this runnable

fetchTickerByIndex

public TickClient fetchTickerByIndex(int i)

Description copied from interface: TickableGroup

Returns the tickclient at the given index from 0 to numTickers

Specified by:

fetchTickerByIndex in interface TickableGroup

Parameters:

i - the index

Returns:

the tickclient, or null

See Also:

TickableGroup.numTickers()

getCurrentThread

public java.lang.Thread getCurrentThread()

Description copied from interface: TickableGroup

If this group is currently getting thread time, this will return a reference to that thread object, or null otherwise.

Specified by:

getCurrentThread in interface TickableGroup

Returns:

the thread currently giving this group time, or null

getThreadGroupName

public java.lang.String getThreadGroupName()

Description copied from interface: TickableGroup

Returns the name of the thread group that this ticking group belongs to (and thus, under which it should run later)

Specified by:

getThreadGroupName in interface TickableGroup

Returns:

the name of the thread group

getLastStartTime

public long getLastStartTime()

Description copied from interface: TickableGroup

Returns the time, in ms, that this object last ticked.

Specified by:

getLastStartTime in interface TickableGroup

Returns:

the time, in ms, that this object last ticked.

getLastStopTime

public long getLastStopTime()

Description copied from interface: TickableGroup

Returns the time, in ms, that this object last stopped ticking.

Specified by:

getLastStopTime in interface TickableGroup

Returns:

the time, in ms, that this object last stopped ticking

getMilliTotal

public long getMilliTotal()

Description copied from interface: TickableGroup

Returns the number of ms that this object has ticked in total

Specified by:

getMilliTotal in interface TickableGroup

Returns:

the number of ms that this object has ticked in total

getTickTotal

public long getTickTotal()

Description copied from interface: TickableGroup

Returns the number of times that this object has ticked in total

Specified by:

getTickTotal in interface TickableGroup

Returns:

the number of times that this object has ticked in total

isSolitaryTicker

public boolean isSolitaryTicker()

Description copied from interface: TickableGroup

Returns whether this group is only permitted a single object

Specified by:

isSolitaryTicker in interface TickableGroup

Returns:

true if this group is only permitted a single object

isAwake

public boolean isAwake()

Description copied from interface: TickableGroup

Returns true if this group currently is getting thread time

Specified by:

isAwake in interface TickableGroup

Returns:

true if this group currently is getting thread time

tickers

public java.util.Iterator<TickClient> tickers()

Description copied from interface: TickableGroup

Returns an iterator of all the ticking objects

Specified by:

tickers in interface TickableGroup

Returns:

an iterator of all the ticking objects

numTickers

public int numTickers()

Description copied from interface: TickableGroup

Returns the number of ticking objects in this group

Specified by:

numTickers in interface TickableGroup

Returns:

the number of ticking objects in this group

getTickSet

public java.util.Iterator<TickClient> getTickSet(Tickable T,
                                                 int tickID)

Description copied from interface: TickableGroup

Returns an iterator of all clients matching the given criteria

Specified by:

getTickSet in interface TickableGroup

Parameters:

T - the tickable object to look for

tickID - the tickid to match, or -1 for all

Returns:

an iterator of all clients matching the given criteria

getLocalItems

public java.util.Iterator<TickClient> getLocalItems(TickableGroup.LocalType itemTypes,
                                                    Room R)

Description copied from interface: TickableGroup

Returns an iterator of all the items of the given type in the given room.

Specified by:

getLocalItems in interface TickableGroup

Parameters:

itemTypes - 0=mobs or items, 1=items, 2=mobs

R - the room to look in

Returns:

an iterator of all the items of the given type in the given room.

getName

public java.lang.String getName()

Description copied from interface: TickableGroup

Returns the name of this group

Specified by:

getName in interface TickableGroup

Returns:

the name

getTickInterval

public long getTickInterval()

Description copied from interface: TickableGroup

Returns the amount of time, in ms, between calls to this group

Specified by:

getTickInterval in interface TickableGroup

Returns:

the time between ticks

getNextTickTime

public long getNextTickTime()

Description copied from interface: TickableGroup

Returns the next time, in ms, when this group should tick.

Specified by:

getNextTickTime in interface TickableGroup

Returns:

the next time, in ms, when this group should tick.

contains

public boolean contains(Tickable T,
                        int tickID)

Description copied from interface: TickableGroup

Returns true if this group contains the given ticking object with the given tickID.

Specified by:

contains in interface TickableGroup

Parameters:

T - the tickable object

tickID - the tickid to match, or -1 for any

Returns:

true if its in here, false otherwise

getCounter

public int getCounter()

delTicker

public boolean delTicker(TickClient C)

Description copied from interface: TickableGroup

Removes the given ticking object from this group

Specified by:

delTicker in interface TickableGroup

Parameters:

C - the client to remove

Returns:

whether anything was deleted.

See Also:

TickClient

addTicker

public void addTicker(TickClient C)

Description copied from interface: TickableGroup

Adds another ticking object to this group

Specified by:

addTicker in interface TickableGroup

Parameters:

C - the client to add

See Also:

TickClient

getLastTicked

public TickClient getLastTicked()

Description copied from interface: TickableGroup

Returns the current or last TickClient object which this thread made a tick(Tickable,int) method call to.

Specified by:

getLastTicked in interface TickableGroup

Returns:

the TickClient object last accessed

See Also:

Tickable, Tickable.tick(Tickable, int)

getStatus

public java.lang.String getStatus()

Description copied from interface: TickableGroup

Returns the displayable status of this ticking object

Specified by:

getStatus in interface TickableGroup

Returns:

the displayable status of this ticking object

shutdown

public void shutdown()

Description copied from interface: TickableGroup

Orders this group to do any necessary cleanup before going away.

Specified by:

shutdown in interface TickableGroup

run

public void run()

Specified by:

run in interface java.lang.Runnable

activeTimeMillis

public long activeTimeMillis()

Description copied from interface: CMRunnable

Returns the number of milliseconds this runnable has been running.

Specified by:

activeTimeMillis in interface CMRunnable

Returns:

the time in millis