org.nerd4j.csv.conf.mapping.CSVFormatterConf 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.conf.mapping;

import java.util.HashSet;
import java.util.Set;

import org.nerd4j.csv.formatter.CSVFormatter;


/**
 * Represents the configuration of the {@link CSVFormatter}.
 * 
 * @author Nerd4j Team
 */
public class CSVFormatterConf extends CSVCharSetConf implements Cloneable
{
    
    /**
     * Set of characters to be escaped.
     * (by default this set is empty).
     */
    private Set charsToEscape;
    
    /**
     * Set of characters that forces the whole field to be quoted.
     * (by default this set is: {[ ],[,],[\t],[\n]}).
     */
    private Set charsThatForceQuoting;
    
    
    /**
     * Default constructor.
     * 
     */
    public CSVFormatterConf()
    {

        super();
    
        this.charsToEscape         = null;
        this.charsThatForceQuoting = null;
        
    }
    
    
    /* ******************* */
    /*  GETTERS & SETTERS  */
    /* ******************* */
    
    
    public Set getCharsToEscape()
    {
        return charsToEscape;
    }
    
    public void setCharsToEscape( Set charsToEscape )
    {
        this.charsToEscape = charsToEscape;
    }
    
    public Set getCharsThatForceQuoting()
    {
        return charsThatForceQuoting;
    }
    
    public void setCharsThatForceQuoting( Set charsThatForceQuoting )
    {
        this.charsThatForceQuoting = charsThatForceQuoting;
    }
    
    
    /* ******************* */
    /*  INTERFACE METHODS  */
    /* ******************* */
    
    
    /**
     * {@inheritDoc}
     */
    @Override
    public CSVFormatterConf clone() throws CloneNotSupportedException
    {
        
        final CSVFormatterConf clone = (CSVFormatterConf) super.clone();
        
        if( this.charsToEscape != null )
            clone.charsToEscape = new HashSet( this.charsToEscape );
        
        if( this.charsThatForceQuoting != null )
            clone.charsThatForceQuoting = new HashSet( this.charsThatForceQuoting );
        
        return clone;
        
    }
    
}