Record Class DateRange

java.lang.Object
java.lang.Record
nl.colorize.util.DateRange
All Implemented Interfaces:
Comparable<DateRange>, Predicate<Date>
public record DateRange(Date start, Date end) extends Record implements Predicate<Date>, Comparable<DateRange>
Defines a range between two Dates, with the start date being inclusive and the end date being exclusive. Although the name of this class implies a date range, this is technically a date/time range since Date instances always include a time.

If dates do not specify an explicit time zone, the default time zone will be used. See Platform.getDefaultTimeZone() for how to configure the default time zone.

  • Constructor Details

    • DateRange

      public DateRange(Date start, Date end)
      Creates an instance of a DateRange record class.
      Parameters:
      start - the value for the start record component
      end - the value for the end record component

    • DateRange

      public DateRange(String start, String end)
      Secondary constructor that uses DateParser.parse(String) to parse the specified start and end date.

  • Method Details

    • contains

      public boolean contains(Date date)
      Returns true if this date range contains the specified date. Note the start date is considered inclusive but the end date is considered exclusive, so this method will return false if the argument matches the end date exactly.

    • test

      public boolean test(Date date)
      Returns true if this date range contains the specified date.
      Specified by:
      test in interface Predicate<Date>
      See Also:

    • splitWeeks

      public List<DateRange> splitWeeks()
      Splits this date range into weekly intervals. This might include partial weeks, depending on the start and end date of this date range. Using this method is equivalent to DateRange.weekly(start, end).

    • splitMonths

      public List<DateRange> splitMonths()
      Splits this date range into monthly intervals. This might include partial months, depending on the start and end date of this date range. Using this method is equivalent to DateRange.monthly(start, end).

    • splitYears

      public List<DateRange> splitYears()
      Splits this date range into yearly intervals. This might include partial years, depending on the start and end date of this date range. Using this method is equivalent to DateRange.yearly(start, end).

    • span

      public DateRange span(DateRange other)
      Creates a new date range that represents the smallest possible period that includes both this date range and the specified other date range.

    • compareTo

      public int compareTo(DateRange other)
      Specified by:
      compareTo in interface Comparable<DateRange>

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • daily

      public static List<DateRange> daily(Date start, Date end)
      Factory method that returns a list of DateRanges for every day between the specified start date (inclusive) and end date (exclusive).

    • weekly

      public static List<DateRange> weekly(Date start, Date end)
      Factory method that returns a list of DateRanges for every week between the specified start date (inclusive) and end date (exclusive). Weeks are assumed to start on Monday. The result may include partial weeks if the start and end date do not align to week boundaries.

    • monthly

      public static List<DateRange> monthly(Date start, Date end)
      Factory method that returns a list of DateRanges for every month between the specified start date (inclusive) and end date (exclusive). The result may include partial months if the start and end date do not align to month boundaries.

    • quarterly

      public static List<DateRange> quarterly(Date start, Date end)
      Factory method that returns a list of DateRanges for every quarter between the specified start date (inclusive) and end date (exclusive). The result may include partial quarters if the start and end date do not align to quarter boundaries.

    • yearly

      public static List<DateRange> yearly(Date start, Date end)
      Factory method that returns a list of DateRanges for every year between the specified start date (inclusive) and end date (exclusive). The result may include partial years if the start and end date do not align to year boundaries.

    • match

      public static Optional<DateRange> match(Date needle, List<DateRange> haystack)
      Returns the first matching DateRange containing the specified date. Returns an empty date if none of the options match.

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • start

      public Date start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component

    • end

      public Date end()
      Returns the value of the end record component.
      Returns:
      the value of the end record component