GridLab
Grid Application Toolkit

A simple API for Grid Applications
GAT

Menu



Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

util::TimePeriod Class Reference

An instance of this class represents a time period. More...

Inheritance diagram for util::TimePeriod:

Inheritance graph
[legend]
Collaboration diagram for util::TimePeriod:

Collaboration graph
[legend]
List of all members.

Public Methods

 TimePeriod (long startTime, long stopTime)
 This method constructs a TimePeriod instance corresponding to the passed StartTime and StopTime.

boolean equals (Object object)
 Tests this TimePeriod for equality with the passed Object.

long getStartTime ()
 This method returns the number of milliseconds after January 1, 1970, 00:00:00 GMT when the time period starts, a long.

long getStopTime ()
 This method returns the number of milliseconds after January 1, 1970, 00:00:00 GMT when the time period stops, a long.


Private Attributes

long startTime
 This member variable represents the start time of this TimePeriod.

long stopTime
 This member variable represents the stop time of this TimePeriod.


Detailed Description

An instance of this class represents a time period.

A time period is an period of time.

Definition at line 7 of file TimePeriod.java.


Constructor & Destructor Documentation

util::TimePeriod::TimePeriod long    startTime,
long    stopTime
[inline]
 

This method constructs a TimePeriod instance corresponding to the passed StartTime and StopTime.

Parameters:
startTime  The number of milliseconds after January 1, 1970, 00:00:00 GMT when the time period starts, a long
stopTime  The number of milliseconds after January 1, 1970, 00:00:00 GMT when the time period stops, a long

Definition at line 27 of file TimePeriod.java.

References util::TimePeriod::startTime, and util::TimePeriod::stopTime.


Member Function Documentation

boolean util::TimePeriod::equals Object    object [inline]
 

Tests this TimePeriod for equality with the passed Object.

If the given object is not a TimePeriod, then this method immediately returns false.

If the passed object is a TimePeriod, then it is deemed equal if it has a numerically equivalent start time and a numerically equivalent stop time to the passed TimePeriod instance.

Parameters:
object  The Object to test for equality
Returns:
A boolean indicating equality

Definition at line 45 of file TimePeriod.java.

References util::TimePeriod::startTime, and util::TimePeriod::stopTime.

long util::TimePeriod::getStartTime   [inline]
 

This method returns the number of milliseconds after January 1, 1970, 00:00:00 GMT when the time period starts, a long.

Returns:
The number of milliseconds after January 1, 1970, 00:00:00 GMT when the time period starts, a long

Definition at line 68 of file TimePeriod.java.

References util::TimePeriod::startTime.

long util::TimePeriod::getStopTime   [inline]
 

This method returns the number of milliseconds after January 1, 1970, 00:00:00 GMT when the time period stops, a long.

Returns:
The number of milliseconds after January 1, 1970, 00:00:00 GMT when the time period stops, a long

Definition at line 79 of file TimePeriod.java.

References util::TimePeriod::stopTime.


Member Data Documentation

long util::TimePeriod::startTime [private]
 

This member variable represents the start time of this TimePeriod.

Definition at line 11 of file TimePeriod.java.

Referenced by util::TimePeriod::equals(), util::TimePeriod::getStartTime(), and util::TimePeriod::TimePeriod().

long util::TimePeriod::stopTime [private]
 

This member variable represents the stop time of this TimePeriod.

Definition at line 16 of file TimePeriod.java.

Referenced by util::TimePeriod::equals(), util::TimePeriod::getStopTime(), and util::TimePeriod::TimePeriod().


The documentation for this class was generated from the following file: