Class CourseTime

java.lang.Object

CourseTime

All Implemented Interfaces:

java.lang.Comparable<CourseTime>

public class CourseTime
extends java.lang.Object
implements java.lang.Comparable<CourseTime>

An immutable encapsulation of a time (period) for a scheduled course at an educational institution. A CourseTime is defined by its particular start time (hh:mm in miilitary format) and by the properties of the CourseSchedule at the educational institution.

Constructor Summary

Constructors

Constructor and Description
CourseTime(CourseSchedule schedule) Construct the first valid CourseTime based on the given CourseSchedule.
CourseTime(CourseTime original) Copy Constructor.
CourseTime(int hh, int mm, CourseSchedule schedule) Construct a valid CourseTime (based on the given CourseSchedule) that occurs on (if possible) or in the first "slot" after the given time.

Method Summary

Modifier and Type	Method and Description
int	compareTo(CourseTime other) Compare this CourseTime to another CourseTime (required by Comparable).
static CourseTime	createLaterCourseTime(CourseTime original, int minutesLater) Construct a CourseTime that is the given number of minutes after a given CourseTime.
boolean	isFirst() Determine whether this CourseTime is the first possible.
boolean	isLast() Determine whether this CourseTime is the last possible.
java.lang.String	toString() Return a String representation this CourseTime (using "civilian" format).

Methods inherited from class java.lang.Object

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

Constructor Detail

CourseTime

public CourseTime(CourseSchedule schedule)

Construct the first valid CourseTime based on the given CourseSchedule.

Parameters:

schedule - The CourseSchedule to use

CourseTime

public CourseTime(int hh,
                  int mm,
                  CourseSchedule schedule)
           throws java.lang.IllegalArgumentException

Construct a valid CourseTime (based on the given CourseSchedule) that occurs on (if possible) or in the first "slot" after the given time. If the given time is out of bounds then the CourseTime will correspond to the first possible time (given the CourseSchedule).

Parameters:

hh - The hour of this CourseTime (military format)

mm - The minute of this CoursTime

schedule - The CourseSchedule being used

Throws:

java.lang.IllegalArgumentException - If the parameters are invalid

CourseTime

public CourseTime(CourseTime original)

Copy Constructor.

Parameters:

original - The CourseTime to copy

Method Detail

createLaterCourseTime

public static CourseTime createLaterCourseTime(CourseTime original,
                                               int minutesLater)

Construct a CourseTime that is the given number of minutes after a given CourseTime. If the time is out of bounds, this method returns the first scheduled CourseTime.

Parameters:

original - The original CourseTime

minutesLater - The difference (in minutes) between the two

Returns:

The CourseTime object

compareTo

public int compareTo(CourseTime other)

Compare this CourseTime to another CourseTime (required by Comparable).

Specified by:

compareTo in interface java.lang.Comparable<CourseTime>

Parameters:

other - The other CourseTime of interest

Returns:

-1/0/1 if this is before/same/after than other

isFirst

public boolean isFirst()

Determine whether this CourseTime is the first possible.

Returns:

true if this CourseTime is at the first time; false otherwise

isLast

public boolean isLast()

Determine whether this CourseTime is the last possible.

Returns:

true if this CourseTime is at (or after) the last time; false otherwise

toString

public java.lang.String toString()

Return a String representation this CourseTime (using "civilian" format).

Overrides:

toString in class java.lang.Object

Returns:

A String representation of this CourseTime