ch.bfh.due1.time

Interface TimeSlot

All Superinterfaces:

Comparable<TimeSlot>, Serializable

All Known Implementing Classes:

TimeSlotImpl

public interface TimeSlot
extends Serializable, Comparable<TimeSlot>

Represent a period or time slot of date-and-time values. See http://www.martinfowler.com/ap2/range.html

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY Denotes the empty time slot.

Method Summary

Modifier and Type	Method and Description
int	compareTo(TimeSlot ts) Compares this time slot with another one.
boolean	endsAfter(TimeSlot ts) Checks if this time slot ends after the given time slot.
boolean	endsBefore(TimeSlot ts) Checks if this time slot ends before the given time slot.
boolean	exactlyMatches(TimeSlot ts) 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.
boolean	includes(LocalDateTime dateTime) Returns true iff NOT (dateTime < this.start() AND dateTime < this.end()).
boolean	includes(TimeSlot ts) Returns true iff this.includes(ts.start()) && this.includes(ts.end()).
boolean	isEmpty() Returns true iff start >= end.
boolean	overlaps(TimeSlot ts) Returns true iff ts.includes(this.getStart()) OR ts.includes(this.getFinish()) OR this.includes(ts).
boolean	startsAfter(TimeSlot ts) Checks if this time slot starts after the given time slot.
boolean	startsBefore(TimeSlot ts) Checks if this date range starts before the given date range.
boolean	strictlyIncludes(TimeSlot ts) Checks if this time slot strictly includes the given time slot.

Field Detail

EMPTY

static final String EMPTY

Denotes the empty time slot.

See Also:

Constant Field Values

Method Detail

getFinish

LocalDateTime getFinish()

Returns the end of the time slot.

Returns:

the end of the time slot

getStart

LocalDateTime getStart()

Returns the start of the time slot.

Returns:

the start of the time slot

isEmpty

boolean isEmpty()

Returns true iff start >= end.

Returns:

returns true iff start >= end

includes

boolean includes(LocalDateTime dateTime)

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

Parameters:

dateTime - a date-time to check.

Returns:

whether the date-time is within the time slot

includes

boolean includes(TimeSlot ts)

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

Parameters:

ts - the time slot to check

Returns:

whether the argument is within the time slot

overlaps

boolean overlaps(TimeSlot ts)

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

Parameters:

ts - the time slot to check

Returns:

whether the ts is within the time slot

compareTo

int compareTo(TimeSlot ts)

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

Parameters:

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

boolean startsBefore(TimeSlot ts)

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

Parameters:

ts - the given date range

Returns:

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

startsAfter

boolean startsAfter(TimeSlot ts)

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

Parameters:

ts - the given time slot

Returns:

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

endsBefore

boolean endsBefore(TimeSlot ts)

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

Parameters:

ts - the given time slot

Returns:

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

endsAfter

boolean endsAfter(TimeSlot ts)

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

Parameters:

ts - the given time slot.

Returns:

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

strictlyIncludes

boolean strictlyIncludes(TimeSlot ts)

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

Parameters:

ts - the given time slot

Returns:

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

exactlyMatches

boolean exactlyMatches(TimeSlot ts)

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

Parameters:

ts - the given time slot.

Returns:

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