org.nerd4j.csv.field.converter.StringToEnum 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 org.nerd4j.csv.field.CSVFieldConverter;


/**
 * Implementation of the {@link CSVFieldConverter} interface
 * that converts {@link String}s into {@link Enum}s.
 * 
 * 
 * @param  type of the {@link Enum} to be returned.
 * 
 * @author Nerd4j Team
 */
public final class StringToEnum> extends AbstractCSVFieldConverter
{

    /** The type of the {@link Enum} to be returned. */
    private final Class enumType;
    
    /**
     * Constructor with parameters.
     * 
     * @param enumType one of the accepted implementations of the {@link Number}.
     */
    public StringToEnum( final Class enumType )
    {

        super( "Unable to convert {1} into " + enumType );
        
        if( enumType == null )
            throw new NullPointerException( "The enum type is mandatory cannot be null" );
        
        this.enumType = enumType;
        
    }

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

        return Enum.valueOf( enumType, source );
        
    }
       
}