ch.bfh.due1.time.pojo

Class TimeSlotImpl

java.lang.Object

ch.bfh.due1.time.pojo.TimeSlotImpl

All Implemented Interfaces:

TimeSlot, Serializable, Comparable<TimeSlot>

public class TimeSlotImpl
extends Object
implements TimeSlot

See Also:

Serialized Form

Field Summary

Fields inherited from interface ch.bfh.due1.time.TimeSlot

EMPTY

Constructor Summary

Constructors

Constructor and Description
TimeSlotImpl(LocalDateTime start, LocalDateTime finish) Constructs a time slot object.

Method Summary

Modifier and Type	Method and Description
int	compareTo(TimeSlot other) Compares this time slot with another one.
boolean	endsAfter(TimeSlot other) Checks if this time slot ends after the given time slot.
boolean	endsBefore(TimeSlot other) Checks if this time slot ends before the given time slot.
boolean	equals(Object other) Tests another time slot object for equality.
boolean	exactlyMatches(TimeSlot other) Checks if this time slot exactly matches the given time slot.
LocalDateTime	getFinish() Returns the end of the time slot.
LocalDateTime	getStart() Returns the start of the time slot.
int	hashCode() Returns the hash code of this object.
boolean	includes(LocalDateTime dateTime) Returns true iff NOT (dateTime < this.start() AND dateTime < this.end()).
boolean	includes(TimeSlot other) Returns true iff this.includes(ts.start()) && this.includes(ts.end()).
boolean	isEmpty() Returns true iff start >= end.
boolean	overlaps(TimeSlot other) Returns true iff ts.includes(this.getStart()) OR ts.includes(this.getFinish()) OR this.includes(ts).
boolean	startsAfter(TimeSlot other) Checks if this time slot starts after the given time slot.
boolean	startsBefore(TimeSlot other) Checks if this date range starts before the given date range.
boolean	strictlyIncludes(TimeSlot other) Checks if this time slot strictly includes the given time slot.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSlotImpl

public TimeSlotImpl(LocalDateTime start,
                    LocalDateTime finish)

Constructs a time slot object.

Parameters:

start - the start of the time slot where the condition start <= end must be true

finish - the end of the time slot

Method Detail

getFinish

public LocalDateTime getFinish()

Returns the end of the time slot.

Specified by:

getFinish in interface TimeSlot

Returns:

the end of the time slot

getStart

public LocalDateTime getStart()

Returns the start of the time slot.

Specified by:

getStart in interface TimeSlot

Returns:

the start of the time slot

isEmpty

public boolean isEmpty()

Returns true iff start >= end.

Specified by:

isEmpty in interface TimeSlot

Returns:

returns true iff start >= end

includes

public boolean includes(LocalDateTime dateTime)

Returns true iff NOT (dateTime < this.start() AND dateTime < this.end()).

Specified by:

includes in interface TimeSlot

Parameters:

dateTime - a date-time to check.

Returns:

whether the date-time is within the time slot

includes

public boolean includes(TimeSlot other)

Returns true iff this.includes(ts.start()) && this.includes(ts.end()).

Specified by:

includes in interface TimeSlot

Parameters:

other - the time slot to check

Returns:

whether the argument is within the time slot

overlaps

public boolean overlaps(TimeSlot other)

Returns true iff ts.includes(this.getStart()) OR ts.includes(this.getFinish()) OR this.includes(ts).

Specified by:

overlaps in interface TimeSlot

Parameters:

other - the time slot to check

Returns:

whether the ts is within the time slot

equals

public boolean equals(Object other)

Tests another time slot object for equality. Two time slot objects are equal iff their start time and end time are equal.

Overrides:

equals in class Object

Parameters:

other - the object to compare

Returns:

true iff other is a time slot object and the the start time and end time are equal.

hashCode

public int hashCode()

Returns the hash code of this object.

Overrides:

hashCode in class Object

Returns:

The hash code.

compareTo

public int compareTo(TimeSlot other)

Description copied from interface: TimeSlot

Compares this time slot with another one. Returns -1 if the start time of this time slot is smaller than the start time of the other time slot, or if the two start times are equal but the finish time of this time slot is smaller than the finish time of the other. Returns 0 if the start time of this time slot equals the start time of the other and the finish time of this time slot equals the finish time of the other. Returns +1 otherwise.

Specified by:

compareTo in interface TimeSlot

Specified by:

compareTo in interface Comparable<TimeSlot>

Parameters:

other - another time slot

Returns:

-1 iff this time slot is smaller than the given time slot, 0 iff this time slot is equal to the given time slot, +1 otherwise

See Also:

Comparable.compareTo(java.lang.Object)

startsBefore

public boolean startsBefore(TimeSlot other)

Description copied from interface: TimeSlot

Checks if this date range starts before the given date range.

Specified by:

startsBefore in interface TimeSlot

Parameters:

other - the given date range

Returns:

true if this time slot starts before the given time slot, false otherwise

startsAfter

public boolean startsAfter(TimeSlot other)

Description copied from interface: TimeSlot

Checks if this time slot starts after the given time slot.

Specified by:

startsAfter in interface TimeSlot

Parameters:

other - the given time slot

Returns:

true if this time slot starts after the given time slot, false otherwise

endsBefore

public boolean endsBefore(TimeSlot other)

Description copied from interface: TimeSlot

Checks if this time slot ends before the given time slot.

Specified by:

endsBefore in interface TimeSlot

Parameters:

other - the given time slot

Returns:

true if this time slot ends before the given time slot, false otherwise

endsAfter

public boolean endsAfter(TimeSlot other)

Description copied from interface: TimeSlot

Checks if this time slot ends after the given time slot.

Specified by:

endsAfter in interface TimeSlot

Parameters:

other - the given time slot.

Returns:

true if this time slot ends after the given time slot, false otherwise

strictlyIncludes

public boolean strictlyIncludes(TimeSlot other)

Description copied from interface: TimeSlot

Checks if this time slot strictly includes the given time slot.

Specified by:

strictlyIncludes in interface TimeSlot

Parameters:

other - the given time slot

Returns:

true if this.includes(ts) and this.startsBefore(ts) and this.endsAfter(ts), false otherwise.

exactlyMatches

public boolean exactlyMatches(TimeSlot other)

Description copied from interface: TimeSlot

Checks if this time slot exactly matches the given time slot.

Specified by:

exactlyMatches in interface TimeSlot

Parameters:

other - the given time slot.

Returns:

true if this.includes(ts) and not startsBefore(ts) and not endsAfter(ts), false otherwise.