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

import org.nerd4j.csv.CSVProcessOperation;



/**
 * Represents a converter able to convert the CSV field
 * in {@link String} into is object oriented representation
 * and vice versa.
 * 
 * @param  type of the source field format.
 * @param  type of the target field format.
 * 
 * @author Nerd4j Team
 */
public interface CSVFieldConverter extends CSVProcessOperation
{

    /**
     * Applies the conversion of the field in source
     * format and returns the field in target format.
     * 
     *  If the conversion fails it modifies the context
     *  accordingly with the framework policies.
     * 
     * 
     * @param source the CSV field to convert.
     * @param context the field process execution context.
     * @return the CSV field in converted format.
     */
    public T convert( S source, CSVFieldProcessContext context );
    
}