org.nerd4j.csv.field.converter.StringToDate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nerd4j-csv Show documentation
CSV manipulation library.
There is a newer version: 1.2.0
/*
 * #%L
 * Nerd4j CSV
 * %%
 * Copyright (C) 2013 Nerd4j
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */
package org.nerd4j.csv.field.converter;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;

import org.nerd4j.csv.field.CSVFieldConverter;


/**
 * Implementation of the {@link CSVFieldConverter} interface
 * that converts {@link String}s into {@link Date}s.
 * 
 * 
 *  This converter uses a {@link DateFormat} to perform the
 *  conversion. Therefore it requires the pattern to use
 *  during the parsing. All the informations on how to
 *  write the date pattern can be found in the javadoc of
 *  the {@link DateFormat} class.
 * 
 * 
 * @author Nerd4j Team
 */
public final class StringToDate extends AbstractCSVFieldConverter
{

    /** The date format to use for parsing dates. */
    private final DateFormat dateFormat;
    
    
    /**
     * Constructor with parameter.
     * 
     * @param datePattern the pattern that describes the date format.
     */
    public StringToDate( final String datePattern )
    {

        this( datePattern, null );
        
    }
    
    /**
     * Constructor with parameter.
     * 
     * @param datePattern the pattern that describes the date format.
     * @param timeZone    (Optional) date time zone different from default one.
     */
    public StringToDate( final String datePattern, final TimeZone timeZone )
    {

        super( "Unable to convert {1} into Date" );
        
        this.dateFormat = datePattern != null && ! datePattern.isEmpty()
        		        ? new SimpleDateFormat( datePattern )
        		        : new SimpleDateFormat();
        
        /* Change formatter default timezone if requested. */
        if ( timeZone != null ) dateFormat.setTimeZone( timeZone );
        
    }

    
    /* ***************** */
    /*  EXTENSION HOOKS  */
    /* ***************** */
    
    
    /**
     * {@inheritDoc}
     */
    @Override
    protected Date performConversion( final String source ) throws Exception
    {
        
        return dateFormat.parse( source );
        
    }

}