Package com.planet_ink.coffee_mud.core.threads

Class StdTickClient

java.lang.Object

com.planet_ink.coffee_mud.core.threads.StdTickClient

All Implemented Interfaces:

TickClient, java.lang.Comparable<TickClient>

public class StdTickClient
extends java.lang.Object
implements TickClient

Field Summary

Fields

Modifier and Type	Field	Description
Tickable	clientObject
long	lastStart
long	lastStop
long	milliTotal
long	nanoTotal
int	reTickDown
java.lang.String	status
boolean	suspended
int	tickDown
int	tickID
int	tickTotal

Constructor Summary

Constructors

Constructor	Description
StdTickClient(Tickable newClientObject, int newTickDown, int newTickID)

Method Summary

Modifier and Type	Method	Description
int	compareTo(TickClient arg0)
boolean	equals(java.lang.Object obj)
Tickable	getClientObject()	Returns the ticking object that this client encapsulates
int	getCurrentTickDown()	Returns the number of ticks remaining before the internal object is allowed to get thread time.
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.
long	getMilliTotal()	Returns the number of ms that this object has ticked in total
java.lang.String	getName()	Returns the name of this ticking client as a displayable String, usually just a translation of the Tickable.name()
java.lang.String	getStatus()	Returns the status of this ticking client as a displayable String, usually just a translation of the Tickable.getTickStatus()
int	getTickID()	Returns the TICKID_ constant assigned to this object
long	getTickTotal()	Returns the number of times that this object has ticked in total
long	getTimeMSToNextTick()	Gets the number of total milliseconds before another tick will occur., or -1.
int	getTotalTickDown()	Returns the number of ticks total before the internal object is allowed to get thread time.
int	hashCode()
boolean	isAwake()	Returns true if this is currently getting thread time
boolean	isSuspended()	Returns true if this object is currently suspended
void	setCurrentTickDownPending()	Sets the number of ticks remaining before the internal object is allowed to get thread time to 1.
void	setStatus(java.lang.String status)	Sets the status of this ticking client as a displayable String
void	setSuspended(boolean trueFalse)	Sets whether this object is suspended from getting thread time
boolean	tickTicker(boolean forceTickDown)	Potentially allows the internal object to be ticked.

Methods inherited from class java.lang.Object

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

Field Detail

clientObject

public final Tickable clientObject

tickID

public final int tickID

reTickDown

public final int reTickDown

tickDown

public volatile int tickDown

suspended

public boolean suspended

lastStart

public volatile long lastStart

lastStop

public volatile long lastStop

milliTotal

public volatile long milliTotal

nanoTotal

public volatile long nanoTotal

tickTotal

public volatile int tickTotal

status

public volatile java.lang.String status

Constructor Detail

StdTickClient

public StdTickClient(Tickable newClientObject,
                     int newTickDown,
                     int newTickID)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: TickClient

Returns the name of this ticking client as a displayable String, usually just a translation of the Tickable.name()

Specified by:

getName in interface TickClient

Returns:

the TICKID_ constant assigned to this object

getClientObject

public final Tickable getClientObject()

Description copied from interface: TickClient

Returns the ticking object that this client encapsulates

Specified by:

getClientObject in interface TickClient

Returns:

the ticking object that this client encapsulates

See Also:

Tickable

getTickID

public final int getTickID()

Description copied from interface: TickClient

Returns the TICKID_ constant assigned to this object

Specified by:

getTickID in interface TickClient

Returns:

the TICKID_ constant assigned to this object

See Also:

Tickable.TICKID_AREA

getTotalTickDown

public int getTotalTickDown()

Description copied from interface: TickClient

Returns the number of ticks total before the internal object is allowed to get thread time.

Specified by:

getTotalTickDown in interface TickClient

Returns:

the number of ticks total

getCurrentTickDown

public int getCurrentTickDown()

Description copied from interface: TickClient

Returns the number of ticks remaining before the internal object is allowed to get thread time.

Specified by:

getCurrentTickDown in interface TickClient

Returns:

the number of ticks remaining

getStatus

public java.lang.String getStatus()

Description copied from interface: TickClient

Returns the status of this ticking client as a displayable String, usually just a translation of the Tickable.getTickStatus()

Specified by:

getStatus in interface TickClient

Returns:

the TICKID_ constant assigned to this object

See Also:

Tickable.getTickStatus()

setStatus

public void setStatus(java.lang.String status)

Description copied from interface: TickClient

Sets the status of this ticking client as a displayable String

Specified by:

setStatus in interface TickClient

Parameters:

status - the new status to set this client to

See Also:

TickClient.getStatus()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(TickClient arg0)

Specified by:

compareTo in interface java.lang.Comparable<TickClient>

setCurrentTickDownPending

public void setCurrentTickDownPending()

Description copied from interface: TickClient

Sets the number of ticks remaining before the internal object is allowed to get thread time to 1.

Specified by:

setCurrentTickDownPending in interface TickClient

getTimeMSToNextTick

public long getTimeMSToNextTick()

Description copied from interface: TickClient

Gets the number of total milliseconds before another tick will occur., or -1.

Specified by:

getTimeMSToNextTick in interface TickClient

Returns:

the number of ms to go

tickTicker

public boolean tickTicker(boolean forceTickDown)

Description copied from interface: TickClient

Potentially allows the internal object to be ticked. This will cause the current tick down, which starts at totaltickdown to be decremented by one. When it reaches 0, the internal object will be "ticked".

Specified by:

tickTicker in interface TickClient

Parameters:

forceTickDown - true to override the currentTickDown

Returns:

true if the object is done ticking forever, false to keep going

See Also:

Tickable.tick(Tickable, int)

getLastStartTime

public long getLastStartTime()

Description copied from interface: TickClient

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

Specified by:

getLastStartTime in interface TickClient

Returns:

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

getLastStopTime

public long getLastStopTime()

Description copied from interface: TickClient

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

Specified by:

getLastStopTime in interface TickClient

Returns:

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

getMilliTotal

public long getMilliTotal()

Description copied from interface: TickClient

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

Specified by:

getMilliTotal in interface TickClient

Returns:

the number of ms that this object has ticked in total

getTickTotal

public long getTickTotal()

Description copied from interface: TickClient

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

Specified by:

getTickTotal in interface TickClient

Returns:

the number of times that this object has ticked in total

isAwake

public boolean isAwake()

Description copied from interface: TickClient

Returns true if this is currently getting thread time

Specified by:

isAwake in interface TickClient

Returns:

true if this is currently getting thread time

isSuspended

public boolean isSuspended()

Description copied from interface: TickClient

Returns true if this object is currently suspended

Specified by:

isSuspended in interface TickClient

Returns:

true if this object is currently suspended

setSuspended

public void setSuspended(boolean trueFalse)

Description copied from interface: TickClient

Sets whether this object is suspended from getting thread time

Specified by:

setSuspended in interface TickClient

Parameters:

trueFalse - true to suspend it, false to unsuspend it