appointmentplanner.api.LocalDay Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of appointmentplanner_api Show documentation
The newest version!
package appointmentplanner.api;

import java.time.Instant;
import java.time.LocalDate;
import java.time.LocalTime;
import java.time.ZoneId;
import java.util.Objects;

/**
 * Utility class to do zoned time conversion.
 * @param zone the time zone for this day
 * @param date the date of this day
 *
 * @author Pieter van den Hombergh {@code [email protected]}
 */
public record LocalDay(ZoneId zone, LocalDate date) {

    /**
     * Default constructor. Make sure zone and date are not null.
     * @param zone the zoneId
     * @param date the date
     */
    public LocalDay {
        Objects.requireNonNull(zone, "zone cannot be null");
        Objects.requireNonNull(date, "date cannot be null");
    }

    /**
     * Create a LocalDay based on the system default timezone and the current date.
     */
    public LocalDay() {
        this(ZoneId.systemDefault(), LocalDate.now());
    }

    /**
     * Get the time as instant.
     *
     * @param localTime the local time
     * @return the time as an instant at this date and timezone
     */
    public Instant ofLocalTime(LocalTime localTime) {
        return localTime.atDate(date).atZone(zone).toInstant();
    }

    /**
     * Get the LocalTime of an instant according to this day.
     *
     * @param instant to convert to LocalTime
     * @return the LocalTime of the given instant
     */
    public LocalTime timeOfInstant(Instant instant) {
        return instant.atZone(zone).toLocalTime();
    }

    /**
     * Get the LocalDate of an instant according to this timezone.
     *
     * @param instant to convert to LocalDate
     * @return the LocalDate of the given instant
     */
    public LocalDate dateOfInstant(Instant instant) {
        return instant.atZone(zone).toLocalDate();
    }

    /**
     * Add x numbers of days to this LocalDay.
     *
     * @param days to add
     * @return the new LocalDay shifted forward or backward in time.
     */
    public LocalDay plusDays(int days) {
        return new LocalDay(zone, date.plusDays(days));
    }

    /**
     * Get the instant at the given hours and minutes.
     *
     * @param hm the hours
     * @param m the minutes
     * @return Instant at the given ours and minutes
     */
    public Instant at(int hm, int m) {
        return ofLocalTime(LocalTime.of(hm, m, 0));
    }

    /**
     * Return the LocalDay for the default time zone at the current date.
     *
     * @return the day
     */
    public static LocalDay now() {
        return new LocalDay();
    }
}