br.com.nordestefomento.jrimum.utilix.DateUtil.java Source code

Java tutorial

Introduction

Here is the source code for br.com.nordestefomento.jrimum.utilix.DateUtil.java

Source

/*
 * Copyright 2008 JRimum Project
 * 
 * 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.
 * 
 * Created at: 30/03/2008 - 18:17:40
 * 
 * ================================================================================
 * 
 * Direitos autorais 2008 JRimum Project
 * 
 * Licenciado sob a Licena Apache, Verso 2.0 ("LICENA"); voc no pode usar
 * esse arquivo exceto em conformidade com a esta LICENA. Voc pode obter uma
 * cpia desta LICENA em http://www.apache.org/licenses/LICENSE-2.0 A menos que
 * haja exigncia legal ou acordo por escrito, a distribuio de software sob
 * esta LICENA se dar COMO EST??, SEM GARANTIAS OU CONDIES DE QUALQUER
 * TIPO, sejam expressas ou tcitas. Veja a LICENA para a redao especfica a
 * reger permisses e limitaes sob esta LICENA.
 * 
 * Criado em: 30/03/2008 - 18:17:40
 * 
 */

package br.com.nordestefomento.jrimum.utilix;

import static br.com.nordestefomento.jrimum.utilix.ObjectUtil.isNotNull;

import java.io.Serializable;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;

import org.apache.commons.lang.time.DateUtils;

/**
 * 
 * <p>
 * Servios utilitrios relacionados a manipulao de Objetos
 * <code>Date, Calendar, GregorianCalendar.</code>
 * </p>
 * 
 * 
 * 
 * @author <a href="http://gilmatryx.googlepages.com/">Gilmar P.S.L</a>
 * @author Misael Barreto
 * @author Rmulo Augusto
 * @author <a href="http://www.nordeste-fomento.com.br">Nordeste Fomento
 *         Mercantil</a>
 * 
 * @since 0.2
 * 
 * @version 0.2
 */
public class DateUtil implements Serializable {

    /**
     * 
     */
    private static final long serialVersionUID = 4339951860440604914L;

    /**
     * <p>
     * Formatador de datas no padro <tt>dd/MM/yyyy</tt>.
     * </p>
     */
    public static final DateFormat FORMAT_DD_MM_YYYY = new SimpleDateFormat("dd/MM/yyyy");

    /**
     * <p>
     * Formatador de datas no padro <tt>ddMMyy</tt>.
     * </p>
     */
    public static final DateFormat FORMAT_DDMMYY = new SimpleDateFormat("ddMMyy");

    /**
     * <p>
     * Formatador de datas no padro <tt>yyMMdd</tt>.
     * </p>
     */
    public static final DateFormat FORMAT_YYMMDD = new SimpleDateFormat("yyMMdd");

    /**
     * <p>
     * Formatador de datas no padro <tt>yyyyMMdd</tt>.
     * </p>
     */
    public static final DateFormat FORMAT_YYYYMMDD = new SimpleDateFormat("yyyyMMdd");

    /**
     * <p>
     * Representa uma data inexistente, pode ser usada em casos que no se pode
     * usar <code>null</code> [ <em> obtida da seguinte forma:
     * <code>new GregorianCalendar(1, 0, 1).getTime()</code></em> ]
     * </p>
     */
    public static final Date DATE_NULL;

    static {

        Calendar calendar = Calendar.getInstance();
        calendar.set(1, 0, 1);
        calendar.setLenient(false);
        DATE_NULL = DateUtils.truncate(calendar.getTime(), Calendar.YEAR);
    }

    /**
     * <p>
     * Converte um objeto <code>String</code> em um objeto
     * <code>java.util.Date</code> no formato de data padro brasileiro:
     * <tt>dd/MM/yyyy</tt>.
     * </p>
     * <p>
     * Utiliza a sobrecarca
     * <code>parse(String dateAsString, DateFormat dateFormat)</code> para
     * realizar a converso.
     * </p>
     * 
     * @param dateAsString
     *            - um valor de data em forma de <code>String</code>.
     * @return Objeto <code>java.util.Date</code> convertido a partir do objeto
     *         <code>String</code>
     * 
     * @throws IllegalArgumentException
     *             caso o objeto <code>String</code> no seja um valor vlido de
     *             data suportado pelo formato.
     * @since 0.2
     */
    public static Date parse(String dateAsString) {

        return parse(dateAsString, FORMAT_DD_MM_YYYY);
    }

    /**
     * <p>
     * Converte um objeto <code>String</code> em um objeto
     * <code>java.util.Date</code> a partir do formato de data especificado.
     * </p>
     * <p>
     * Utiliza a sobrecarca
     * <code>parse(String dateAsString, DateFormat dateFormat)</code> para
     * realizar a converso.
     * </p>
     * 
     * @param dateAsString
     *            - um valor de data em forma de <code>String</code>.
     * @param dateFormat
     *            - formato de data
     * @return Objeto <code>java.util.Date</code> convertido a partir do objeto
     *         <code>String</code>
     * 
     * @throws IllegalArgumentException
     *             caso o objeto <code>String</code> no seja um valor vlido de
     *             data suportado pelo formato.
     * @since 0.2
     */
    public static Date parse(String dateAsString, String dateFormat) {

        if (dateFormat == null) {
            throw new NullPointerException("O formato da data no pode ter valor [null].");
        }

        return parse(dateAsString, new SimpleDateFormat(dateFormat));
    }

    /**
     * <p>
     * Converte um objeto <code>String</code> em um objeto
     * <code>java.util.Date</code> atravs do objeto
     * <code>java.text.DateFormat</code> especificado.
     * </p>
     * 
     * @param dateAsString
     *            - um valor de data em forma de <code>String</code>.
     * @param dateFormat
     *            - formatador para objetos <code>java.util.Date</code>.
     * @return Objeto <code>java.util.Date</code> convertido a partir do objeto
     *         <code>String</code>
     * 
     * @throws IllegalArgumentException
     *             caso o objeto <code>String</code> no seja um valor vlido de
     *             data suportado pelo formatador.
     * @since 0.2
     */
    public static Date parse(String dateAsString, DateFormat dateFormat) {

        Date date = null;

        if (dateAsString == null) {
            throw new NullPointerException("A String a ser convertida no pode ter valor [null].");
        }

        if (dateFormat == null) {
            throw new NullPointerException("O formatador no pode ter valor [null].");
        }

        try {

            date = dateFormat.parse(dateAsString);

        } catch (ParseException e) {

            String msg = "A String [" + dateAsString + "] deve ser uma data vlida no formato";
            if (dateFormat instanceof SimpleDateFormat) {
                SimpleDateFormat sdf = (SimpleDateFormat) dateFormat;
                msg += " [" + sdf.toPattern() + "].";

            } else {
                msg += " especificado.";
            }

            IllegalArgumentException iae = new IllegalArgumentException(msg);
            iae.initCause(e);
            throw iae;
        }

        return date;
    }

    /**
     * <p>
     * Calcula a diferena de dias entre duas datas. O resultado  modular, ou
     * seja, maior ou igual a zero, logo a data final no precisa ser
     * necessariamente maior que a data inicial.
     * </p>
     * 
     * @param dataInicial
     *            - data inicial do intervalo.
     * @param dataFinal
     *            - data final do intervalo.
     * @return nmero(mdulo) de dias entre as datas.
     * 
     * @throws IllegalArgumentException
     *             Caso pelo menos uma das duas datas seja <code>null</code>.
     * @since 0.2
     */
    public static long calculeDiferencaEmDias(final Date dataInicial, final Date dataFinal) {

        long fator = 0;
        Date dataInicialTruncada, dataFinalTruncada;

        if (isNotNull(dataInicial) && isNotNull(dataFinal)) {

            dataInicialTruncada = DateUtils.truncate(dataInicial, Calendar.DATE);
            dataFinalTruncada = DateUtils.truncate(dataFinal, Calendar.DATE);

            fator = ((dataFinalTruncada.getTime() - dataInicialTruncada.getTime()) / DateUtils.MILLIS_PER_DAY);

            if (fator < 0) {
                fator *= -1;
            }
        } else {
            throw new IllegalArgumentException("A data inicial [" + dataInicial + "] e a data final [" + dataFinal
                    + "] " + "no podem ter valor 'null'.");
        }

        return fator;
    }

    /**
     * <p>
     * Retorna um objeto <code>java.util.Date</code> somente com a informao
     * do dia, mes e ano. A informao sobre hora, minuto, segundo e millesegundos
     *  zerada. Isto  altamente recomendado em rotinas nas quais datas so 
     * comparadas.
     * </p>
     * 
     * @param date
     *            - um data em forma de <code>java.util.Date</code>.
     *            
     * @return Objeto <code>java.util.Date</code> truncado a partir do objeto 
     * <code>java.util.Date</code> informado como parmetro.
     * 
     * @throws NullPointerException
     *             Caso o objeto <code>java.util.Date</code> esteja nulo
     * @since 0.3
     */
    public static Date truncarData(Date date) {
        if (date == null) {
            throw new NullPointerException(
                    "O data no pode ser nula. Impossvel realizar o truncamento da data.");
        }

        return DateUtils.truncate(date, Calendar.DATE);
    }

}