com.databasesandlife.util.YearMonthDay Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-common Show documentation
Utility classes developed at Adrian Smith Software (A.S.S.)
There is a newer version: 21.0.1
package com.databasesandlife.util;

import java.io.Serializable;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.time.LocalDate;
import java.util.Date;
import java.util.TimeZone;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Represents a date (year, month, day).
 *
 * @deprecated use {@link LocalDate} instead.
 * @author This source is copyright Adrian Smith and licensed under the LGPL 3.
 * @see Project on GitHub
 */
@Deprecated
@SuppressWarnings("serial")
public class YearMonthDay implements Serializable, Comparable {
    
    public int year, month, day;
    
    protected YearMonthDay() { }
    
    public YearMonthDay(int year, int month, int day) {
        this.year = year;
        this.month = month;
        this.day = day;
    }
        
    public YearMonthDay(LocalDate date) {
        this.year = date.getYear();
        this.month = date.getMonthValue();
        this.day = date.getDayOfMonth();
    }
        
    /** @param date "YYYY-MM-DD", not null */
    public static YearMonthDay newForYYYYMMDD(String date) {
        var m = Pattern.compile("(\\d{4})-(\\d{2})-(\\d{2})").matcher(date);
        if (!m.matches()) throw new IllegalArgumentException("Date '" + date + "' is not 'YYYY-MM-DD' format");
        var result = new YearMonthDay();
        result.year = Integer.parseInt(m.group(1));
        result.month = Integer.parseInt(m.group(2));
        result.day = Integer.parseInt(m.group(3));
        return result;
    }
    
    /** @return "YYYY-MM-DD" */
    public String toYYYYMMDD() {
        return String.format("%04d-%02d-%02d", year, month, day);
    }
    
    @Override public String toString() {
        return toYYYYMMDD();
    }
    
    @SuppressWarnings("RedundantIfStatement")
    @Override public boolean equals(Object other) {
        if (other == null) return false;
        if ( ! (other instanceof YearMonthDay)) return false;
        var o = (YearMonthDay) other;
        if (year != o.year) return false;
        if (month != o.month) return false;
        if (day != o.day) return false;
        return true;
    }
    
    @Override public int hashCode() {
        return 384745 + toYYYYMMDD().hashCode();
    }
    
    public static YearMonthDay newTodayUtc() {
        var format = new SimpleDateFormat("yyyy-MM-dd");
        format.setTimeZone(TimeZone.getTimeZone("UTC"));
        return newForYYYYMMDD(format.format(new Date()));
    }
    
    public Date getMidnightUtcAtStart() {
        try {
            var f = new SimpleDateFormat("yyyy-MM-dd");
            f.setTimeZone(TimeZone.getTimeZone("UTC"));
            return f.parse(toYYYYMMDD());
        }
        catch (ParseException e) { throw new RuntimeException(e); }
    }
    
    protected YearMonthDay getDelta(long millisDelta) {
        var result = new Date(getMidnightUtcAtStart().getTime() + millisDelta);
        var f = new SimpleDateFormat("yyyy-MM-dd");
        f.setTimeZone(TimeZone.getTimeZone("UTC"));
        return newForYYYYMMDD(f.format(result));
    }
    
    public YearMonthDay getPrevious() {
        return getDelta(-24*60*60*1000L);
    }
    
    public YearMonthDay getNext() {
        return getDelta(+24*60*60*1000L);
    }

    public Date getMidnightUtcAtEnd() {
        return getNext().getMidnightUtcAtStart();
    }

    @SuppressWarnings("UseCompareMethod")
    @Override public int compareTo(YearMonthDay other) {
        if (this.year < other.year) return -1;
        if (this.year > other.year) return +1;
        if (this.month < other.month) return -1;
        if (this.month > other.month) return +1;
        if (this.day < other.day) return -1;
        if (this.day > other.day) return +1;
        return 0;
    }

    public YearMonthDay subtractDays(int dayCount) {
        return getDelta(-dayCount*24*60*60*1000L);
    }

    public static YearMonthDay newMinusInfinity() {
        return newForYYYYMMDD("1970-01-01");
    }
    
    public static YearMonthDay max(YearMonthDay a,YearMonthDay b) {
        return a.isAfter(b) ? a : b;
    }
    
    public static YearMonthDay min(YearMonthDay a,YearMonthDay b) {
        return a.isAfter(b) ? b : a;
    }
    
    public int calculateYearsDifference(YearMonthDay other){
        var diff = (int)Math.floor(Math.abs((this.year*12 + this.month) - (other.year*12 + other.month))/12);
        return this.month == other.month && min(this,other).day > max(this,other).day ? diff -1 : diff;
    }
    
    public boolean isBefore(YearMonthDay other) { return compareTo(other) < 0; }
    public boolean isAfter(YearMonthDay other) { return compareTo(other) > 0; }
    public boolean isBeforeOrEqual(YearMonthDay other) { return compareTo(other) <= 0; }
    public boolean isAfterOrEqual(YearMonthDay other) { return compareTo(other) >= 0; }

    /** @param formatString Can contain "yyyy" "MM" "dd" */
    public String format(String formatString) {
        formatString = formatString.replace("yyyy", String.format("%04d", year));
        formatString = formatString.replace("MM", String.format("%02d", month));
        formatString = formatString.replace("dd", String.format("%02d", day));
        return formatString;
    }

    public LocalDate toLocalDate() {
        return LocalDate.of(year, month, day);
    }
}