test3

Class SimpleTime

java.lang.Object

test3.SimpleTime

All Implemented Interfaces:

Comparable<SimpleTime>

public class SimpleTime
extends Object
implements Comparable<SimpleTime>

A class that represents time in one day using hours and minutes. The time is based on a 24-hour clock: The start of each day is midnight or 0 hours and 0 minutes, noon is 12 hours and 0 minutes, and the end of the day is 23 hours and 59 minutes.

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:

EECS1030_2014_15_W

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINUTES_PER_HOUR The number of minutes in an hour
static int	NOON_HOUR The hour for noon.

Constructor Summary

Constructors

Constructor and Description
SimpleTime(int hour, int minute) 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 (0-23) 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.
static SimpleTime	noon() Returns the SimpleTime object equal to noon (12:00)
void	setHour(int hour) Set the hour of the day (0-23) 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

Field Detail

NOON_HOUR

public static final int NOON_HOUR

The hour for noon.

See Also:

Constant Field Values

MINUTES_PER_HOUR

public static final int MINUTES_PER_HOUR

The number of minutes in an hour

See Also:

Constant Field Values

Constructor Detail

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)

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

Throws:

IllegalArgumentException - if hour is not in the range 0-23

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

Parameters:

hour - the hour of the day

minute - the minute of the hour

Method Detail

getHour

public int getHour()

Get the hour of the day (0-23) represented by this object.

Returns:

the hour

setHour

public void setHour(int hour)

Set the hour of the day (0-23) represented by this object.

Throws:

IllegalArgumentException - if hour is not in the range 0-23

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

compareTo

public int compareTo(SimpleTime other)

Compares this SimpleTime object to another SimpleTime object.

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

Specified by:

compareTo in interface Comparable<SimpleTime>

Returns:

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

noon

public static SimpleTime noon()

Returns the SimpleTime object equal to noon (12:00)

Returns:

the SimpleTime object equal to noon (12:00)

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 hours and identical minutes).

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 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