cse1030

Class SimpleTime

java.lang.Object

cse1030.SimpleTime

All Implemented Interfaces:

Comparable<SimpleTime>

public class SimpleTime
extends Object
implements Comparable<SimpleTime>

A class that represents a time using hours and minutes. The time is based on a 12-hour clock. The time represented by SimpleTime does not automatically change with the passing of time; a client is able to manually set the time using the provided mutator methods.

Author:

CSE1030

Constructor Summary

Constructors

Constructor and Description
SimpleTime() Create a SimpleTime representing midnight (12:00 AM).
SimpleTime(int hour, int minute, boolean am) Create a SimpleTime representing the time with the given hour and minute.
SimpleTime(SimpleTime other) Create a SimpleTime object that represents the same time as another SimpleTime object.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(SimpleTime other) Compares this SimpleTime object to another SimpleTime object.
boolean	equals(Object obj) Compare this SimpleTime to an object for equality.
int	getHour() Get the hour of the day (1-12) represented by this object.
int	getMinute() Get the minute of the hour (0-59) represented by this object.
int	hashCode() Generate a hash code for this object.
boolean	isAM() Returns true if the time represented by this object is in the AM, and false otherwise.
void	setAM(boolean am) Set the time to AM or PM.
void	setHour(int hour) Set the hour of the day (1-12) represented by this object.
void	setMinute(int minute) Set the minute of the hour (0-59) represented by this object.
String	toString() Returns a string representation of the time of day.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleTime

public SimpleTime()

Create a SimpleTime representing midnight (12:00 AM).

Throws:

IllegalArgumentException - if hour is not in the range 1-12

IllegalArgumentException - if minute is not in the range 0-59

SimpleTime

public SimpleTime(SimpleTime other)

Create a SimpleTime object that represents the same time as another SimpleTime object.

Parameters:

other - the SimpleTime object to copy

SimpleTime

public SimpleTime(int hour,
          int minute,
          boolean am)

Create a SimpleTime representing the time with the given hour and minute.

If isAM is true then the object represents a time that is between midnight and just before noon (12:00 AM-11:59 AM), otherwise the object represents a time that is between noon and just before midnight (12:00 PM-11:59 PM).

Throws:

IllegalArgumentException - if hour is not in the range 1-12

IllegalArgumentException - if minute is not in the range 0-59

Parameters:

hour - the hour of the day

minute - the minute of the hour

am - use true to indicate a time in the AM; use false to indicate a time in the PM.

Method Detail

getHour

public int getHour()

Get the hour of the day (1-12) represented by this object.

Returns:

the hour

setHour

public void setHour(int hour)

Set the hour of the day (1-12) represented by this object.

Throws:

IllegalArgumentException - if hour is not in the range 1-12

Parameters:

hour - the hour to set

getMinute

public int getMinute()

Get the minute of the hour (0-59) represented by this object.

Returns:

the minute

setMinute

public void setMinute(int minute)

Set the minute of the hour (0-59) represented by this object.

Throws:

IllegalArgumentException - if minute is not in the range 0-59

Parameters:

minute - the minute to set

isAM

public boolean isAM()

Returns true if the time represented by this object is in the AM, and false otherwise.

Returns:

true if the time represented by this object is in the AM, and false otherwise.

setAM

public void setAM(boolean am)

Set the time to AM or PM.

Parameters:

am - use true to indicate a time between midnight and just before noon (12:00 AM-11:59 AM), and false to represent a time that is between noon and just before midnight (12:00 PM-11:59 PM).

hashCode

public int hashCode()

Generate a hash code for this object.

Overrides:

hashCode in class Object

Returns:

a hash code for this object

equals

public boolean equals(Object obj)

Compare this SimpleTime to an object for equality.

The result is true if and only if obj is a SimpleTime object, and both objects represent the same time of day (i.e., identical hour, minute, and AM/PM).

Overrides:

equals in class Object

Returns:

true if both SimpleTime objects represent the same time of day.

toString

public String toString()

Returns a string representation of the time of day. The string has the format XX:YY AM or XX:YY PM where XX is the hour of the day and YY is the minute of the day. Both the hour and minute fields are always two characters wide.

Overrides:

toString in class Object

Returns:

the time of day represented by this object as a string

compareTo

public int compareTo(SimpleTime other)

Compares this SimpleTime object to another SimpleTime object.

The result is the difference in minutes between this object and the other object. For example, if the time represented by this object is 11:00 AM and the time represented by the other object is 1:05 PM then this.compareTo(other) returns -125.

Specified by:

compareTo in interface Comparable<SimpleTime>

Returns:

the difference in minutes between this object and the other object.