net.degreedays.time

Class DayRanges

java.lang.Object

net.degreedays.time.MaybeEmptyDayRanges

net.degreedays.time.DayRanges

All Implemented Interfaces:

java.lang.Iterable<DayRange>

public abstract class DayRanges
extends MaybeEmptyDayRanges

A chronologically-ordered set of one or more non-overlapping DayRange objects.

This abstract class is not designed to be extended by third-party code, which is why it does not have an accessible constructor.

All concrete subclasses of this abstract class are immutable. You can safely reuse them and call them from multiple threads at once.

Method Summary

Modifier and Type	Method and Description
abstract DayRange	fullRange() Returns the non-null DayRange extending from the first day of the first DayRange to the last day of the last DayRange in this chronologically-ordered set.
abstract boolean	isContiguous() Returns true if each contained DayRange starts the day after the previous DayRange ended (i.e. no gaps); false otherwise.
static DayRanges	of(java.util.Collection<DayRange> dayRangeObjects) Returns a non-null DayRanges object containing the specified DayRange objects.
static DayRanges	of(DayRange[] dayRangeObjects) Returns a non-null DayRanges object containing the specified DayRange objects.
static DayRanges	of(DayRange firstDayRangeObject, DayRange... additionalDayRangeObjects) Returns a non-null DayRanges object containing the specified DayRange objects.
static DayRanges	of(java.lang.Iterable<DayRange> dayRangeObjects) Returns a non-null DayRanges object containing the specified DayRange objects.

Methods inherited from class net.degreedays.time.MaybeEmptyDayRanges

count, equals, fullRangeOrNull, get, getEmpty, hashCode, indexOf, indexOf, isEmpty, iterator, notEmpty, subRanges, subRangesWithin, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

fullRange

public abstract DayRange fullRange()

Returns the non-null DayRange extending from the first day of the first DayRange to the last day of the last DayRange in this chronologically-ordered set.

Unlike MaybeEmptyDayRanges.fullRangeOrNull() this will never return null because a DayRanges object will always contain at least one DayRange.

isContiguous

public abstract boolean isContiguous()

Returns true if each contained DayRange starts the day after the previous DayRange ended (i.e. no gaps); false otherwise.

of

public static DayRanges of(DayRange[] dayRangeObjects)

Returns a non-null DayRanges object containing the specified DayRange objects.

Parameters:

dayRangeObjects - a chronologically-ordered array of non-overlapping DayRange objects. Cannot be null, cannot contain null, and cannot be empty.

Throws:

java.lang.NullPointerException - if dayRangeObjects is null or contains null.

java.lang.IllegalArgumentException - if dayRangeObjects is empty, or if any of the DayRange objects within it overlap or are not in chronological order.

Since:

1.2

See Also:

of(DayRange, DayRange...), of(Iterable)

of

public static DayRanges of(java.util.Collection<DayRange> dayRangeObjects)

Returns a non-null DayRanges object containing the specified DayRange objects.

Parameters:

dayRangeObjects - a chronologically-ordered collection of non-overlapping DayRange objects. Cannot be null, cannot contain null, and cannot be empty.

Throws:

java.lang.NullPointerException - if dayRangeObjects is null or contains null.

java.lang.IllegalArgumentException - if dayRangeObjects is empty, or if any of the DayRange objects within it overlap or are not in chronological order.

Since:

1.2

See Also:

of(DayRange[]), of(DayRange, DayRange...), of(Iterable)

of

public static DayRanges of(java.lang.Iterable<DayRange> dayRangeObjects)

Returns a non-null DayRanges object containing the specified DayRange objects.

Parameters:

dayRangeObjects - a chronologically-ordered collection of non-overlapping DayRange objects. Cannot be null, cannot contain null, and cannot be empty.

Throws:

java.lang.NullPointerException - if dayRangeObjects is null or contains null.

java.lang.IllegalArgumentException - if dayRangeObjects is empty, or if any of the DayRange objects within it overlap or are not in chronological order.

Since:

1.4

See Also:

of(DayRange[]), of(DayRange, DayRange...)

of

public static DayRanges of(DayRange firstDayRangeObject,
                           DayRange... additionalDayRangeObjects)

Returns a non-null DayRanges object containing the specified DayRange objects.

Parameters:

firstDayRangeObject - the first DayRange object to go in the returned DayRanges object. Cannot be null.

additionalDayRangeObjects - the DayRange objects to follow firstDayRangeObject in the returned DayRanges object. Together with firstDayRangeObject these must be chronologically-ordered and non-overlapping. Cannot be null, and cannot contain null.

Throws:

java.lang.NullPointerException - if firstDayRangeObject or additionalDayRangeObjects is null, or if additionalDayRangeObjects contains a null value.

java.lang.IllegalArgumentException - if any of the supplied DayRange objects overlap or are not in chronological order.

Since:

1.4

See Also:

of(DayRange[]), of(Iterable)