|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.csvreader.CsvWriter
public class CsvWriter
A stream based writer for writing delimited text data to a file or a stream.
Field Summary | |
---|---|
static int |
ESCAPE_MODE_BACKSLASH
Use a backslash character before the text qualifier to represent an occurance of the text qualifier. |
static int |
ESCAPE_MODE_DOUBLED
Double up the text qualifier to represent an occurance of the text qualifier. |
Constructor Summary | |
---|---|
CsvWriter(OutputStream outputStream,
char delimiter,
Charset charset)
Creates a CsvWriter object using an
OutputStream to write data to. |
|
CsvWriter(String fileName)
Creates a CsvWriter object using a file
as the data destination. Uses a comma as the column delimiter and
ISO-8859-1 as the Charset . |
|
CsvWriter(String fileName,
char delimiter,
Charset charset)
Creates a CsvWriter object using a file
as the data destination. |
|
CsvWriter(Writer outputStream,
char delimiter)
Creates a CsvWriter object using a Writer
to write data to. |
Method Summary | |
---|---|
void |
close()
Closes and releases all related resources. |
void |
endRecord()
Ends the current record by sending the record delimiter. |
void |
flush()
Clears all buffers for the current writer and causes any buffered data to be written to the underlying device. |
char |
getComment()
|
char |
getDelimiter()
Gets the character being used as the column delimiter. |
int |
getEscapeMode()
|
boolean |
getForceQualifier()
Whether fields will be surrounded by the text qualifier even if the qualifier is not necessarily needed to escape this field. |
char |
getRecordDelimiter()
|
char |
getTextQualifier()
Gets the character to use as a text qualifier in the data. |
boolean |
getUseTextQualifier()
Whether text qualifiers will be used while writing data or not. |
static String |
replace(String original,
String pattern,
String replace)
|
void |
setComment(char comment)
|
void |
setDelimiter(char delimiter)
Sets the character to use as the column delimiter. |
void |
setEscapeMode(int escapeMode)
|
void |
setForceQualifier(boolean forceQualifier)
Use this to force all fields to be surrounded by the text qualifier even if the qualifier is not necessarily needed to escape this field. |
void |
setRecordDelimiter(char recordDelimiter)
Sets the character to use as the record delimiter. |
void |
setTextQualifier(char textQualifier)
Sets the character to use as a text qualifier in the data. |
void |
setUseTextQualifier(boolean useTextQualifier)
Sets whether text qualifiers will be used while writing data or not. |
void |
write(String content)
Writes another column of data to this record. Does not preserve leading and trailing whitespace in this column of data. |
void |
write(String content,
boolean preserveSpaces)
Writes another column of data to this record. |
void |
writeComment(String commentText)
|
void |
writeRecord(String[] values)
Writes a new record using the passed in array of values. |
void |
writeRecord(String[] values,
boolean preserveSpaces)
Writes a new record using the passed in array of values. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ESCAPE_MODE_DOUBLED
public static final int ESCAPE_MODE_BACKSLASH
Constructor Detail |
---|
public CsvWriter(String fileName, char delimiter, Charset charset)
CsvWriter
object using a file
as the data destination.
fileName
- The path to the file to output the data.delimiter
- The character to use as the column delimiter.charset
- The Charset
to use while
writing the data.public CsvWriter(String fileName)
CsvWriter
object using a file
as the data destination. Uses a comma as the column delimiter and
ISO-8859-1 as the Charset
.
fileName
- The path to the file to output the data.public CsvWriter(Writer outputStream, char delimiter)
CsvWriter
object using a Writer
to write data to.
outputStream
- The stream to write the column delimited data to.delimiter
- The character to use as the column delimiter.public CsvWriter(OutputStream outputStream, char delimiter, Charset charset)
CsvWriter
object using an
OutputStream to write data to.
outputStream
- The stream to write the column delimited data to.delimiter
- The character to use as the column delimiter.charset
- The Charset
to use while
writing the data.Method Detail |
---|
public char getDelimiter()
public void setDelimiter(char delimiter)
delimiter
- The character to use as the column delimiter.public char getRecordDelimiter()
public void setRecordDelimiter(char recordDelimiter)
recordDelimiter
- The character to use as the record delimiter. Default is
combination of standard end of line characters for Windows,
Unix, or Mac.public char getTextQualifier()
public void setTextQualifier(char textQualifier)
textQualifier
- The character to use as a text qualifier in the data.public boolean getUseTextQualifier()
public void setUseTextQualifier(boolean useTextQualifier)
useTextQualifier
- Whether to use a text qualifier while writing data or not.public int getEscapeMode()
public void setEscapeMode(int escapeMode)
public void setComment(char comment)
public char getComment()
public boolean getForceQualifier()
public void setForceQualifier(boolean forceQualifier)
forceQualifier
- Whether to force the fields to be qualified or not.public void write(String content, boolean preserveSpaces) throws IOException
content
- The data for the new column.preserveSpaces
- Whether to preserve leading and trailing whitespace in this
column of data.
IOException
- Thrown if an error occurs while writing data to the
destination stream.public void write(String content) throws IOException
content
- The data for the new column.
IOException
- Thrown if an error occurs while writing data to the
destination stream.public void writeComment(String commentText) throws IOException
IOException
public void writeRecord(String[] values, boolean preserveSpaces) throws IOException
values
- Values to be written.preserveSpaces
- Whether to preserver leading and trailing spaces in columns
while writing out to the record or not.
IOException
- Thrown if an error occurs while writing data to the
destination stream.public void writeRecord(String[] values) throws IOException
values
- Values to be written.
IOException
- Thrown if an error occurs while writing data to the
destination stream.public void endRecord() throws IOException
IOException
- Thrown if an error occurs while writing data to the
destination stream.public void flush()
public void close()
public static String replace(String original, String pattern, String replace)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |