org.nerd4j.csv.conf.mapping.CSVWriterConf 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 org.nerd4j.csv.writer.CSVWriter;


/**
 * Represents the configuration of the {@link CSVWriter}.
 * 
 * @author Nerd4j Team
 */
public class CSVWriterConf extends CSVHandlerConf implements Cloneable
{

    /** Tells if to write the CSV target first row as header. */
    private Boolean writeHeader;
    
    /** The name to reference the formatter configuration to use. */
    private String formatterRef;
    
    /** The formatter configuration embedded into the reader. */
    private CSVFormatterConf formatter;
    
    
    /**
     * Default constructor.
     * 
     */
    public CSVWriterConf()
    {

        super();
    
        this.writeHeader = null;
        
        this.formatter = null;
        this.formatterRef = null;
        
    }
   
    
    /* ******************* */
    /*  GETTERS & SETTERS  */
    /* ******************* */
    

    public Boolean getWriteHeader()
    {
        return writeHeader;
    }
    
    public void setWriteHeader( Boolean writeHeader )
    {
        this.writeHeader = writeHeader;
    }

    public String getFormatterRef()
    {
        return formatterRef;
    }
    
    public void setFormatterRef( String formatterRef )
    {
        this.formatterRef = formatterRef;
    }

    public CSVFormatterConf getFormatter()
    {
        return formatter;
    }
    
    public void setFormatter( CSVFormatterConf formatter )
    {
        this.formatter = formatter;
    }
    
    
    /* ******************* */
    /*  INTERFACE METHODS  */
    /* ******************* */
    
    
    /**
     * {@inheritDoc}
     */
    @Override
    public CSVWriterConf clone() throws CloneNotSupportedException
    {
        
        final CSVWriterConf clone = (CSVWriterConf) super.clone();
        
        clone.formatter = this.formatter != null ? this.formatter.clone() : null;
        
        return clone;
        
    }
    
}