org.nerd4j.csv.field.converter.NumberToString 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.DecimalFormat;
import java.text.DecimalFormatSymbols;
import java.text.NumberFormat;
import java.util.Locale;

import org.nerd4j.csv.field.CSVFieldConverter;


/**
 * Implementation of the {@link CSVFieldConverter} interface
 * that converts {@link Number}s into {@link String}s.
 * 
 * 
 *  This converter accepts all the Java standard implementations
 *  of the {@link java.lang.Number} interface i.e.:
 *  

 *   {@link java.lang.Byte}
 *   {@link java.lang.Short}
 *   {@link java.lang.Integer}
 *   {@link java.lang.Long}
 *   
 *   {@link java.lang.Float}
 *   {@link java.lang.Double}
 *   
 *   {@link java.math.BigInteger}
 *   {@link java.math.BigDecimal}
 *   
 *   {@link java.util.concurrent.atomic.AtomicInteger}
 *   {@link java.util.concurrent.atomic.AtomicLong}
 *  
 * 
 * 
 * @param  type of the {@link Number} to convert.
 * 
 * @author Nerd4j Team
 */
public final class NumberToString extends AbstractCSVFieldConverter
{

    /** The number format to use to format the number. */
    private final NumberFormat numberFormat;
    

    /**
     * Default constructor.
     * 
     */
    public NumberToString()
    {

        this( null, null );
        
    }

    
    /**
     * Constructor with parameters.
     * 
     * @param numberPattern the pattern that describes the number format.
     */
    public NumberToString( final String numberPattern )
    {
        
    	this( numberPattern, null );
        
    }
    
    /**
     * Constructor with parameters.
     * 
     * @param numberPattern the pattern that describes the number format.
     * @param numberLocale locale for formatter symbols, ignored if no pattern
     */
    public NumberToString( final String numberPattern, final Locale numberLocale )
    {
        
        super( "Unable to convert {1} into String" );
        
        if( numberPattern == null || numberPattern.isEmpty() )
            this.numberFormat = null;
        else
        {
        	if ( numberLocale == null )
        		this.numberFormat = new DecimalFormat( numberPattern );
        	else
        		this.numberFormat = new DecimalFormat( numberPattern,
        				DecimalFormatSymbols.getInstance( numberLocale ) );
        }
        
    }

    
    /* ***************** */
    /*  EXTENSION HOOKS  */
    /* ***************** */
    
    
    /**
     * {@inheritDoc}
     */
    @Override
    protected String performConversion( final N source ) throws Exception
    {

        if( numberFormat != null )
            return numberFormat.format( source );
        else
            return source.toString();
        
    }
    
}