com.redhat.rhn.common.util

Class CSVWriter

java.lang.Object

java.io.Writer

java.io.BufferedWriter

com.redhat.rhn.common.util.CSVWriter

All Implemented Interfaces:

ExportWriter, java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class CSVWriter
extends java.io.BufferedWriter
implements ExportWriter

CSVWriter - util class for writing objects into CSV

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
CSVWriter(java.io.Writer out) Constructor
CSVWriter(java.io.Writer out, char separator) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContents() Get the String version of the values written so far.
java.lang.String	getFileExtension() Get the extension of the file to be exported.
java.lang.String	getHeaderText()
java.lang.String	getMimeType() Get the mime type of the output
void	setColumns(java.util.List<java.lang.String> columnsIn) Set columns
void	setHeaderText(java.lang.String headerIn) Sets an optional header string.
void	write(java.util.List listIn) Write the List of values to the contents of this Writer.
void	write(java.lang.String s) Write a string to the Writer
void	writeHeader() Write the header to the stream
void	writeSeparator() Write the separator to the Writer

Methods inherited from class java.io.BufferedWriter

close, flush, newLine, write, write, write

Methods inherited from class java.io.Writer

append, append, append, write

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVWriter

public CSVWriter(java.io.Writer out)

Constructor

Parameters:

out - Writer to send CSV to

CSVWriter

public CSVWriter(java.io.Writer out,
                 char separator)

Constructor

Parameters:

out - Writer to send CSV to

separator - Separator character to use

Method Detail

setColumns

public void setColumns(java.util.List<java.lang.String> columnsIn)

Set columns

Specified by:

setColumns in interface ExportWriter

Parameters:

columnsIn - List of Strings containing the names of the columns

setHeaderText

public void setHeaderText(java.lang.String headerIn)

Sets an optional header string.

Parameters:

headerIn - This will become the first line of the export CSV contents.

getHeaderText

public java.lang.String getHeaderText()

Returns:

String Description of exported data with commas appended to correspond to the number of columns being exported. Needed so it doesn't break applications which will be parsing this data.

writeHeader

public void writeHeader()

Write the header to the stream

write

public void write(java.util.List listIn)

Write the List of values to the contents of this Writer.

Specified by:

write in interface ExportWriter

Parameters:

listIn - that you want writen to the contents

write

public void write(java.lang.String s)
           throws java.io.IOException

Write a string to the Writer

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

writeSeparator

public void writeSeparator()
                    throws java.io.IOException

Write the separator to the Writer

Throws:

java.io.IOException - if there is a Writer error

getContents

public java.lang.String getContents()

Get the String version of the values written so far.

Specified by:

getContents in interface ExportWriter

Returns:

String version of the values

getMimeType

public java.lang.String getMimeType()

Get the mime type of the output

Specified by:

getMimeType in interface ExportWriter

Returns:

String mime type

getFileExtension

public java.lang.String getFileExtension()

Get the extension of the file to be exported.

Specified by:

getFileExtension in interface ExportWriter

Returns:

String extension.