com.helger.datetime.period.ILocalDatePeriod Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-datetime Show documentation
Show all versions of ph-datetime Show documentation
Java date time library based on joda time
/*
* Copyright (C) 2014-2024 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.datetime.period;
import java.time.LocalDate;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.datetime.PDTFactory;
import com.helger.datetime.domain.IHasStartAndEnd;
/**
* Base interface for a period consisting of 2 local date periods.
*
* @author Philip Helger
*/
public interface ILocalDatePeriod extends IHasStartAndEnd
{
/**
* Check if the provided query date is between start and end. A
* null start means "since forever". A null end
* means "until eternity and beyond".
*
* @param aStart
* Start date. May be null.
* @param bInclStart
* true if "start date" = "query date" should be a match,
* false if not.
* @param aEnd
* End date may be null.
* @param bInclEnd
* true if "end date" = "query date" should be a match,
* false if not.
* @param aQuery
* Date to query whether it is inside or not. May not be
* null.
* @return true if query date ≥ start date and ≤ end date
* @since 10.0.0
*/
static boolean isInside (@Nullable final LocalDate aStart,
final boolean bInclStart,
@Nullable final LocalDate aEnd,
final boolean bInclEnd,
@Nonnull final LocalDate aQuery)
{
ValueEnforcer.notNull (aQuery, "QueryDT");
if (aStart != null && (bInclStart ? aQuery.compareTo (aStart) < 0 : aQuery.compareTo (aStart) <= 0))
return false;
if (aEnd != null && (bInclEnd ? aQuery.compareTo (aEnd) > 0 : aQuery.compareTo (aEnd) >= 0))
return false;
return true;
}
/**
* Check if the provided date is inside this period, assuming that start and
* end are included in/part of the range.
*
* @param bInclBoundaries
* true if "start date" = "query date" should be a match
* i.e. if "end date" = "query date" should be a match,
* false if this should not be a match.
* @param aDate
* Date to check. May not be null.
* @return true if it is contained, false otherwise.
* @see #isInside(LocalDate, boolean, LocalDate, boolean, LocalDate)
* @since 10.0.0
*/
default boolean isInPeriod (final boolean bInclBoundaries, @Nonnull final LocalDate aDate)
{
return isInside (getStart (), bInclBoundaries, getEnd (), bInclBoundaries, aDate);
}
/**
* Check if the provided date is inside this period, assuming that start and
* end are included in/part of the range.
*
* @param aDate
* Date to check. May not be null.
* @return true if it is contained, false otherwise.
* @see #isInPeriod(boolean, LocalDate)
* @see #isNowInPeriodIncl()
* @since 8.6.5
*/
default boolean isInPeriodIncl (@Nonnull final LocalDate aDate)
{
return isInPeriod (true, aDate);
}
/**
* Check if the current date is inside this period, assuming that start and
* end are included in/part of the range.
*
* @return true if the current date is contained,
* false otherwise.
* @see #isInPeriod(boolean, LocalDate)
* @see #isInPeriodIncl(LocalDate)
* @since 8.6.5
*/
default boolean isNowInPeriodIncl ()
{
return isInPeriodIncl (PDTFactory.getCurrentLocalDate ());
}
/**
* Check if the provided date is inside this period, assuming that start and
* end are excluded from/not part of the range.
*
* @param aDate
* Date to check. May not be null.
* @return true if it is contained, false otherwise.
* @see #isInPeriod(boolean, LocalDate)
* @see #isNowInPeriodExcl()
* @since 8.6.5
*/
default boolean isInPeriodExcl (@Nonnull final LocalDate aDate)
{
return isInPeriod (false, aDate);
}
/**
* Check if the current date is inside this period, assuming that start and
* end are excluded from/not part of the range.
*
* @return true if the current date is contained,
* false otherwise.
* @see #isInPeriod(boolean, LocalDate)
* @see #isInPeriodExcl(LocalDate)
* @since 8.6.5
*/
default boolean isNowInPeriodExcl ()
{
return isInPeriodExcl (PDTFactory.getCurrentLocalDate ());
}
/**
* Check if the provided range 1 has an overlap with the provided range 2.
*
* @param aStart1
* Start date of the first range. May be null.
* @param aEnd1
* End date of the first range. May be null meaning it's
* validity is "until eternity and beyond".
* @param aStart2
* Start date of the second range. May be null.
* @param aEnd2
* End date of the second range. May be null meaning it's
* validity is "until eternity and beyond".
* @param bInclBoundaries
* true if "start date" = "query date" should be a match
* i.e. if "end date" = "query date" should be a match,
* false if this should not be a match.
* @return true if the 2 ranges have at least one point in time
* (with duration 0) that they share.
* @since 10.0.0
*/
static boolean hasOverlap (@Nullable final LocalDate aStart1,
@Nullable final LocalDate aEnd1,
@Nullable final LocalDate aStart2,
@Nullable final LocalDate aEnd2,
final boolean bInclBoundaries)
{
if (aStart2 != null && isInside (aStart1, bInclBoundaries, aEnd1, bInclBoundaries, aStart2))
{
// New start date is in valid range
return true;
}
// New start date is out of range
if (aEnd2 != null && isInside (aStart1, bInclBoundaries, aEnd1, bInclBoundaries, aEnd2))
{
// New end date is in valid range
return true;
}
// start1 - end1: 5.1. - 15.1.
// start2 - end2: 1.1. - 31.1.
if (aStart1 != null && isInside (aStart2, bInclBoundaries, aEnd2, bInclBoundaries, aStart1))
return true;
if (aEnd1 != null && isInside (aStart2, bInclBoundaries, aEnd2, bInclBoundaries, aEnd1))
return true;
return false;
}
default boolean isOverlappingWith (@Nonnull final ILocalDatePeriod aPeriod, final boolean bInclBoundaries)
{
return hasOverlap (getStart (), getEnd (), aPeriod.getStart (), aPeriod.getEnd (), bInclBoundaries);
}
default boolean isOverlappingWithIncl (@Nonnull final ILocalDatePeriod aPeriod)
{
return isOverlappingWith (aPeriod, true);
}
default boolean isOverlappingWithExcl (@Nonnull final ILocalDatePeriod aPeriod)
{
return isOverlappingWith (aPeriod, false);
}
}