io.buybrain.util.time

Class Periods

java.lang.Object

io.buybrain.util.time.Periods

public class Periods
extends Object

Operations that can be applied to Period instances

Constructor Summary

Constructors

Constructor and Description
Periods()

Method Summary

Modifier and Type	Method and Description
static List<Period>	intersect(List<Period> a, List<Period> b) Get the intersection between two lists of periods.
static Optional<Period>	intersect(Period a, Period b) Get the intersection (overlapping period) of two periods
static List<Period>	merge(List<Period> periods) Merge a list of periods such that periods that are overlapping or adjacent are collapsed into a single period
static List<Period>	merge(List<Period> a, List<Period> b) Merge two lists of periods such that periods that are overlapping or adjacent are collapsed into a single period
static List<Period>	subtract(List<Period> subjects, Period toSubtract) Remove one period from a list of periods according to subtract(Period, Period)
static List<Period>	subtract(Period subject, Period toSubtract) Remove one period from another period.

Methods inherited from class java.lang.Object

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

Constructor Detail

Periods

public Periods()

Method Detail

merge

public static List<Period> merge(@NonNull
                                 List<Period> a,
                                 @NonNull
                                 List<Period> b)

Merge two lists of periods such that periods that are overlapping or adjacent are collapsed into a single period

Parameters:

a - first list of periods to merge

b - second list of periods to merge

Returns:

the list of merged periods, sorted ascending

merge

public static List<Period> merge(@NonNull
                                 List<Period> periods)

Merge a list of periods such that periods that are overlapping or adjacent are collapsed into a single period

Parameters:

periods - the periods to merge

Returns:

the list of merged periods, sorted ascending

subtract

public static List<Period> subtract(@NonNull
                                    List<Period> subjects,
                                    @NonNull
                                    Period toSubtract)

Remove one period from a list of periods according to subtract(Period, Period)

Parameters:

subjects - the periods to subtract from

toSubtract - the period to subtract

Returns:

the results of the subtraction

subtract

public static List<Period> subtract(@NonNull
                                    Period subject,
                                    @NonNull
                                    Period toSubtract)

Remove one period from another period. This operation can yield 0, 1 or 2 resulting periods. If the subject is fully covered by the subtracted period, there is no period left. If part of the inside of the subject is subtracted (but not the start and end), it will be cut into 2 periods. Otherwise, one period is returned.

Parameters:

subject - the period to subtract from

toSubtract - the period to subtract

Returns:

the result of the subtraction

intersect

public static Optional<Period> intersect(@NonNull
                                         Period a,
                                         @NonNull
                                         Period b)

Get the intersection (overlapping period) of two periods

Parameters:

a - first period

b - second period

Returns:

Optional with the overlapping period or empty if the periods do not overlap

intersect

public static List<Period> intersect(@NonNull
                                     List<Period> a,
                                     @NonNull
                                     List<Period> b)

Get the intersection between two lists of periods. The lists themselves are expected to contain no overlapping periods. If they might, sanitize them with merge(List) first.

Parameters:

a - first periods

b - second periods

Returns:

list of periods of time where both a and b have an active periods