org.mpxj

Class LocalDateTimeRange

java.lang.Object

org.mpxj.LocalDateTimeRange

All Implemented Interfaces:

Comparable<LocalDateTimeRange>

public final class LocalDateTimeRange
extends Object
implements Comparable<LocalDateTimeRange>

This class represents a period of time.

Constructor Summary

Constructors

Constructor and Description
LocalDateTimeRange(LocalDateTime startDate, LocalDateTime endDate) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(LocalDateTime date) This method compares a target date with a date range.
int	compareTo(LocalDateTimeRange o)
boolean	equals(Object o)
LocalDateTime	getEnd() Retrieve the date at the end of the range.
LocalDateTime	getStart() Retrieve the date at the start of the range.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LocalDateTimeRange

public LocalDateTimeRange(LocalDateTime startDate,
                          LocalDateTime endDate)

Constructor.

Parameters:

startDate - start date

endDate - end date

Method Detail

getStart

public LocalDateTime getStart()

Retrieve the date at the start of the range.

Returns:

start date

getEnd

public LocalDateTime getEnd()

Retrieve the date at the end of the range.

Returns:

end date

compareTo

public int compareTo(LocalDateTime date)

This method compares a target date with a date range. The method will return 0 if the date is within the range, less than zero if the date is before the range starts, and greater than zero if the date is after the range ends.

Parameters:

date - target date

Returns:

comparison result

compareTo

public int compareTo(LocalDateTimeRange o)

Specified by:

compareTo in interface Comparable<LocalDateTimeRange>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object