DateUtil.java
/*
* Copyright (c) 2002-2022, City of Paris
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright notice
* and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice
* and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* License 1.0
*/
package fr.paris.lutece.util.date;
import java.sql.Timestamp;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import org.apache.commons.lang3.StringUtils;
import fr.paris.lutece.portal.service.i18n.I18nService;
import fr.paris.lutece.portal.web.l10n.LocaleService;
/**
* This class provides date utils.
*/
public final class DateUtil
{
public static final String ISO_PATTERN_DATE = "yyyy-MM-dd HH:mm:ss";
private static final String CONSTANTE_PATTERN_DATE = "dd/MM/yyyy";
private static final long CONSTANT_NUMBER_MILISECONDS_IN_DAY = 86400000;
/**
* Creates a new DateUtil object
*/
private DateUtil( )
{
}
/**
* Get the date from String date The format pattern is specified internaly
*
* @param strDate
* the date to format
* @param locale
* The Locale
* @return The Date or null else
*/
public static Date formatDate( String strDate, Locale locale )
{
Date date = null;
if ( strDate != null )
{
DateFormat dateFormat = getDateFormat( locale );
try
{
date = dateFormat.parse( strDate );
}
catch( ParseException e )
{
return null;
}
}
return date;
}
/**
* Get the date from String date
*
* @param strDate
* the date to format
* @param locale
* The Locale
* @return The Date or null else
*/
public static Date formatDateLongYear( String strDate, Locale locale )
{
Date date = null;
if ( ( strDate != null ) && ( strDate.trim( ).length( ) == CONSTANTE_PATTERN_DATE.length( ) ) )
{
date = formatDate( strDate, locale );
}
return date;
}
/**
* Get the {@link Timestamp} from String date The format pattern is specified internaly
*
* @param strDate
* the date to format
* @param locale
* The Locale
* @return The {@link Timestamp} or null else
*/
public static Timestamp formatTimestamp( String strDate, Locale locale )
{
Date date = formatDate( strDate, locale );
if ( date == null )
{
return null;
}
return new Timestamp( date.getTime( ) );
}
/**
* Get the {@link java.sql.Date} from String date The format pattern is specified internaly
*
* @param strDate
* the date to format
* @param locale
* The Locale
* @return The {@link java.sql.Date} or null else
*/
public static java.sql.Date formatDateSql( String strDate, Locale locale )
{
Date date = formatDate( strDate, locale );
if ( date == null )
{
return null;
}
return new java.sql.Date( date.getTime( ) );
}
/**
* Convert the date to String with a standard pattern
*
* @param date
* The date to convert
* @param locale
* The Locale
* @return The formated String
*/
public static String getDateString( Date date, Locale locale )
{
DateFormat dateFormat = null;
if ( locale != null )
{
String strLocalizedDateFormat = I18nService.getDateFormatShortPattern( locale );
if ( ( strLocalizedDateFormat != null ) && !strLocalizedDateFormat.equals( "" ) )
{
dateFormat = new SimpleDateFormat( strLocalizedDateFormat );
}
else
{
dateFormat = DateFormat.getDateInstance( DateFormat.SHORT, locale );
}
}
else
{
dateFormat = DateFormat.getDateInstance( DateFormat.SHORT, LocaleService.getDefault( ) );
}
return dateFormat.format( date );
}
/**
* Converts a long value to a String date
*
* @param lTime
* The long value to convert
* @param locale
* the locale
* @return The formatted string
*/
public static String getDateString( long lTime, Locale locale )
{
return getDateString( new Date( lTime ), locale );
}
/**
* Converts a Timestamp value to a String date
*
* @param date
* The date
* @param locale
* the locale
* @return The formatted string
*/
public static String getDateString( java.sql.Timestamp date, Locale locale )
{
if ( date == null )
{
return "";
}
return getDateString( new Date( date.getTime( ) ), locale );
}
/**
* Converts the current Date to a String date
*
* @param locale
* the locale
* @return The formatted string
*/
public static String getCurrentDateString( Locale locale )
{
return getDateString( new Date( ), locale );
}
/**
* Return the pattern for date
*
* @param locale
* the Locale
* @return The pattern as a String
*/
public static String getDefaultPattern( Locale locale )
{
if ( locale != null )
{
String strLocalizedDateFormat = I18nService.getDateFormatShortPattern( locale );
if ( ( strLocalizedDateFormat != null ) && !strLocalizedDateFormat.equals( "" ) )
{
return strLocalizedDateFormat;
}
DateFormat df = DateFormat.getDateInstance( DateFormat.SHORT, locale );
if ( df instanceof SimpleDateFormat )
{
SimpleDateFormat sdf = (SimpleDateFormat) df;
return sdf.toPattern( );
}
}
DateFormat df = DateFormat.getDateInstance( DateFormat.SHORT, LocaleService.getDefault( ) );
if ( df instanceof SimpleDateFormat )
{
SimpleDateFormat sdf = (SimpleDateFormat) df;
return sdf.toPattern( );
}
return null;
}
/**
* Get the number of milliseconds in a given number of days
*
* @param lDays
* The number of days
* @return The number of milliseconds in the given number of days
*/
public static long convertDaysInMiliseconds( long lDays )
{
return CONSTANT_NUMBER_MILISECONDS_IN_DAY * lDays;
}
/**
* Get the Date format for the locale
*
* @param locale
* @return
*/
public static DateFormat getDateFormat( Locale locale )
{
DateFormat dateFormat = null;
if ( locale != null )
{
String strLocalizedDateFormat = I18nService.getDateFormatShortPattern( locale );
if ( StringUtils.isNotEmpty( strLocalizedDateFormat ) )
{
dateFormat = new SimpleDateFormat( strLocalizedDateFormat );
}
else
{
dateFormat = DateFormat.getDateInstance( DateFormat.SHORT, locale );
}
}
else
{
dateFormat = DateFormat.getDateInstance( DateFormat.SHORT, LocaleService.getDefault( ) );
}
dateFormat.setLenient( false );
return dateFormat;
}
/**
* Parse a date from ISO format ( yyyy-MM-dd HH:mm:ss )
*
* @param strDate
* @since 7.0.1
* @return parsed {@link Date} or null if the string can't be parsed
*/
public static Date parseIsoDate( String strDate )
{
Date date = null;
if ( StringUtils.isNotBlank( strDate ) )
{
SimpleDateFormat format = new SimpleDateFormat( ISO_PATTERN_DATE );
try
{
date = format.parse( strDate );
}
catch( ParseException e )
{
return null;
}
}
return date;
}
/**
* Get the ISO format ( yyyy-MM-dd HH:mm:ss ) of a date
*
* @param date
* @since 7.0.1
* @return string of the date in iso format, or null if param is null
*/
public static String getIsoDateString( Date date )
{
String strDate = null;
if ( date != null )
{
SimpleDateFormat format = new SimpleDateFormat( ISO_PATTERN_DATE );
strDate = format.format( date );
}
return strDate;
}
}