util
Interface TimeStamp

All Known Implementing Classes:

RegularTimeStamp

public interface TimeStamp

This class is intended to be a marker for object creation. Specifically objects from the world package can use it to compare creation times as well as have other components know about how long it has been since a certain object was created (i.e. knowledge deprecation).

Version:

$Revision: 1.5 $

Author:

Dave Jurgens

Method Summary

boolean	equals(Object time) Returns whether the two stamps are at the same point in time.
long	getMilliseconds() Return the milliseconds component of this time.
int	getNanoseconds() Return the nanosecond component of this time.
long	getTimeSince(util.TimeStamp time) Return the value in milliseconds between the two objects.
boolean	isBefore(util.TimeStamp time) If this TimeStamp was created before the TimeStamp passed in.

Method Detail

equals

public boolean equals(Object time)

Returns whether the two stamps are at the same point in time.

Overrides:

equals in class Object

getMilliseconds

public long getMilliseconds()

Return the milliseconds component of this time.

getNanoseconds

public int getNanoseconds()

Return the nanosecond component of this time.

getTimeSince

public long getTimeSince(util.TimeStamp time)

Return the value in milliseconds between the two objects. All values returned should be positive.

isBefore

public boolean isBefore(util.TimeStamp time)

If this TimeStamp was created before the TimeStamp passed in.