Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

recoin.util
Class TimeLog  view TimeLog download TimeLog.java

java.lang.Object
  extended byrecoin.util.TimeLog
All Implemented Interfaces:
java.io.Serializable

public class TimeLog
extends java.lang.Object
implements java.io.Serializable

A TimeLog can be used to record a sequence of phases or processes.

To do so an unlimitited number of DurationStamp objects can be added. The first DurationStamp added to the TimeLog should be used to represent the overall process. There is also a special constructor for this case.

Version:
0.2.9

Field Summary
static java.util.Calendar calendar
          A Calendar object.
private  java.util.Vector durationStamps
          The DurationStamp objects
 
Constructor Summary
TimeLog()
          Creates an empty TimeLog.
TimeLog(boolean init)
          Creates a TimeLog with a DurationStamp initiated to the current time if specified by the boolean parameter.
 
Method Summary
 void addDurationStamp(DurationStamp stamp)
          Adds the specified DurationStamp to the TimeLog.
 void closeTimeLog()
          Closes this TimeLog by setting the end time of the initial DurationStamp that represents the overall process.
 java.util.Vector getDurationStamps()
          Returns the DurationStamps in this TimeLog.
 DurationStamp getInitialStamp()
          Returns the first DurationStamp added to this TimeLog.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

durationStamps

private java.util.Vector durationStamps
The DurationStamp objects


calendar

public static java.util.Calendar calendar
A Calendar object. Static so everybody can use it without the need for a TimeLog object.

Constructor Detail

TimeLog

public TimeLog()
Creates an empty TimeLog.


TimeLog

public TimeLog(boolean init)
Creates a TimeLog with a DurationStamp initiated to the current time if specified by the boolean parameter. If the parameter is false, the constructor behaves just like the empty constructor.

Method Detail

addDurationStamp

public void addDurationStamp(DurationStamp stamp)
Adds the specified DurationStamp to the TimeLog.


getDurationStamps

public java.util.Vector getDurationStamps()
Returns the DurationStamps in this TimeLog.


getInitialStamp

public DurationStamp getInitialStamp()
                              throws java.util.NoSuchElementException
Returns the first DurationStamp added to this TimeLog.


closeTimeLog

public void closeTimeLog()
                  throws java.util.NoSuchElementException
Closes this TimeLog by setting the end time of the initial DurationStamp that represents the overall process.