org.hisp.dhis.util.DateTimeUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dhis2-java-client Show documentation
DHIS 2 API client for Java.
There is a newer version: 2.0.4
package org.hisp.dhis.util;

import java.text.SimpleDateFormat;
import java.time.DateTimeException;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.util.Date;

import lombok.AccessLevel;
import lombok.NoArgsConstructor;

import org.apache.commons.lang3.StringUtils;

@NoArgsConstructor( access = AccessLevel.PRIVATE )
public class DateTimeUtils
{
    private static final String DATE_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSS";

    private static final String DATE_FORMAT = "yyyy-MM-dd";

    /**
     * Returns a date.
     *
     * @param year the year.
     * @param month the month, from 1.
     * @param dayOfMonth, from 1 to 31.
     * @return a {@link Date}.
     */
    public static Date getDate( int year, int month, int dayOfMonth )
    {
        LocalDate localDate = LocalDate.of( year, month, dayOfMonth );

        return Date.from( localDate.atStartOfDay( ZoneId.systemDefault() ).toInstant() );
    }

    /**
     * Returns a date string on the format: yyyy-MM-dd.
     *
     * @param date the {@link Date}.
     * @return a date string.
     */
    public static String getDateString( Date date )
    {
        return new SimpleDateFormat( DATE_FORMAT ).format( date );
    }

    /**
     * Returns a {@link LocalDate} based on the given string. The string must be
     * on the ISO local date format, e.g. 2007-12-03.
     *
     * @param string the date string.
     * @return a {@link LocalDate}.
     */
    public static LocalDate getLocalDate( String string )
    {
        return LocalDate.parse( string );
    }

    /**
     * Returns a date string on the format: yyyy-MM-dd.
     *
     * @param date the {@link LocalDate}.
     * @return a date time string.
     */
    public static String getLocalDateString( LocalDate date )
    {
        return DateTimeFormatter.ISO_LOCAL_DATE.format( date );
    }

    /**
     * Indicates whether the given string can be parsed to a local date, i.e. is
     * in a valid ISO date format, e.g. 2007-12-03.
     *
     * @param string the date string.
     * @return true if the given string can be parsed to a local date, false
     *         otherwise.
     */
    public static boolean isValidLocalDate( String string )
    {
        try
        {
            return string != null && getLocalDate( string ) != null;
        }
        catch ( DateTimeException ex )
        {
            return false;
        }
    }

    /**
     * Returns a {@link LocalDateTime} based on the given string using the UTC
     * time zone. The string must be on the ISO local date time format, e.g.
     * 2007-12-03T10:15:30.00 or
     * 2007-12-03T10:15:30.00Z. A trailing 'Z' indicating Zulu/UTC
     * time will be ignored.
     *
     * @param string the instant string.
     * @return a {@link LocalDateTime}.
     */
    public static LocalDateTime getLocalDateTime( String string )
    {
        string = StringUtils.removeEndIgnoreCase( string, "z" );

        return LocalDateTime.parse( string );
    }

    /**
     * Returns a {@link LocalDate} based on the given string using the UTC time
     * zone. The string must be on the ISO local date time format, e.g.
     * 2007-12-03T10:15:30.00 or
     * 2007-12-03T10:15:30.00Z. A trailing 'Z' indicating Zulu/UTC
     * time will be ignored.
     *
     * @param string the instant string.
     * @return a {@link LocalDateTime}.
     */
    public static LocalDate getLocalDateTimeAsDate( String string )
    {
        return getLocalDateTime( string ).toLocalDate();
    }

    /**
     * Indicates whether the given string can be parsed to a local date time,
     * i.e. is in a valid ISO date time format, e.g.
     * 2007-12-03T10:15:30.00Z.
     *
     * @param string the instant string.
     * @return true if the given string can be parsed to a local date time,
     *         false otherwise.
     */
    public static boolean isValidLocalDateTime( String string )
    {
        try
        {
            return string != null && getLocalDateTime( string ) != null;
        }
        catch ( DateTimeException ex )
        {
            return false;
        }
    }

    /**
     * Returns a date time string on the format:
     * yyyy-MM-dd'T'HH:mm:ss.SSS.
     *
     * @param dateTime the {@link LocalDateTime}.
     * @return a date time string.
     */
    public static String getLocalDateTimeString( LocalDateTime dateTime )
    {
        return DateTimeFormatter.ISO_LOCAL_DATE_TIME.format( dateTime );
    }

    /**
     * Returns a date time string on the format:
     * yyyy-MM-dd'T'HH:mm:ss.SSS.
     *
     * @param dateTime the {@link Date}.
     * @return a date time string.
     */
    public static String getDateTimeString( Date dateTime )
    {
        return new SimpleDateFormat( DATE_TIME_FORMAT ).format( dateTime );
    }

    /**
     * Returns a date time string on the format:
     * yyyy-MM-dd'T'HH:mm:ss.SSSZ.
     *
     * @param dateTime the {@link LocalDateTime}.
     * @return a date time string.
     */
    public static String getUtcDateTimeString( LocalDateTime dateTime )
    {
        return String.format( "%sZ", DateTimeFormatter.ISO_LOCAL_DATE_TIME.format( dateTime ) );
    }

    /**
     * Returns a date time string on the format:
     * yyyy-MM-dd'T'HH:mm:ss.SSSZ.
     *
     * @param dateTime the {@link Date}.
     * @return a date time string.
     */
    public static String getUtcDateTimeString( Date dateTime )
    {
        return String.format( "%sZ", new SimpleDateFormat( DATE_TIME_FORMAT ).format( dateTime ) );
    }
}