javatools.filehandlers

Class CSVFile

java.lang.Object

javatools.filehandlers.CSVFile

All Implemented Interfaces:

Closeable, AutoCloseable

public class CSVFile
extends Object
implements Closeable

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The class allows writing data to a CSV file.

Field Summary

Fields

Modifier and Type	Field and Description
protected Writer	out The output writer
protected boolean	quoteAll quote all components
protected boolean	quoteNever never quote
protected String	separator Holds the separator

Constructor Summary

Constructors

Constructor and Description
CSVFile(File f)
CSVFile(File f, boolean append)
CSVFile(File f, boolean append, List<String> columns)
CSVFile(File f, boolean append, String... columns)
CSVFile(File f, boolean append, String separator, List<String> columns)
CSVFile(File f, List<String> columns)
CSVFile(File f, String... columns)
CSVFile(String f)
CSVFile(String f, boolean append)
CSVFile(String f, boolean append, List<String> columns)
CSVFile(String f, boolean append, String... columns)
CSVFile(String f, List<String> columns)
CSVFile(String f, String... columns)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the file
protected String	column(Object c) Formats an entry
static void	main(String[] args) Test method
void	neverQuote(boolean q) Sets quoting on/off (off by default)
void	setQuoting(boolean q) Sets optional quoting on/off (off by default)
void	write(List<? extends Object> columns) Writes the columns to the file
void	write(Object... columns) Writes the columns to the file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

out

protected Writer out

The output writer

separator

protected String separator

Holds the separator

quoteAll

protected boolean quoteAll

quote all components

quoteNever

protected boolean quoteNever

never quote

Constructor Detail

CSVFile

public CSVFile(File f,
               boolean append,
               String separator,
               List<String> columns)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(File f,
               boolean append,
               List<String> columns)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(File f,
               boolean append,
               String... columns)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(File f,
               boolean append)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(String f,
               boolean append)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(File f)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(String f)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(String f,
               boolean append,
               List<String> columns)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(String f,
               boolean append,
               String... columns)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(String f,
               List<String> columns)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(String f,
               String... columns)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(File f,
               List<String> columns)
        throws IOException

Throws:

IOException

CSVFile

public CSVFile(File f,
               String... columns)
        throws IOException

Throws:

IOException

Method Detail

setQuoting

public void setQuoting(boolean q)

Sets optional quoting on/off (off by default)

neverQuote

public void neverQuote(boolean q)

Sets quoting on/off (off by default)

write

public void write(List<? extends Object> columns)
           throws IOException

Writes the columns to the file

Throws:

IOException

write

public void write(Object... columns)
           throws IOException

Writes the columns to the file

Throws:

IOException

column

protected String column(Object c)

Formats an entry

close

public void close()

Closes the file

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

main

public static void main(String[] args)
                 throws Exception

Test method

Throws:

Exception