public class CsvWriter extends Object
限定符和类型 | 字段和说明 |
---|---|
static int |
ESCAPE_MODE_BACKSLASH
Use a backslash character before the text qualifier to represent an
occurrence of the text qualifier.
|
static int |
ESCAPE_MODE_DOUBLED
Double up the text qualifier to represent an occurrence of the text
qualifier.
|
构造器和说明 |
---|
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. |
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. |
限定符和类型 | 方法和说明 |
---|---|
void |
close()
Closes and releases all related resources.
|
void |
endRecord()
Ends the current record by sending the record delimiter.
|
protected void |
finalize() |
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.
|
String |
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(String 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.
|
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.
|
void |
writeRecord(String[] values,
boolean preserveSpaces,
boolean preserveReturn)
Writes a new record using the passed in array of values.
|
public static final int ESCAPE_MODE_DOUBLED
public static final int ESCAPE_MODE_BACKSLASH
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.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(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 void close()
public void endRecord() throws IOException
IOException
- Thrown if an error occurs while writing data to the
destination stream.public void flush() throws IOException
IOException
- Thrown if an error occurs while writing data to the
destination stream.public char getComment()
public char getDelimiter()
public int getEscapeMode()
public boolean getForceQualifier()
public String getRecordDelimiter()
public char getTextQualifier()
public boolean getUseTextQualifier()
public void setComment(char comment)
public void setDelimiter(char delimiter)
delimiter
- The character to use as the column delimiter.public void setEscapeMode(int escapeMode)
public void setForceQualifier(boolean forceQualifier)
forceQualifier
- Whether to force the fields to be qualified or not.public void setRecordDelimiter(String 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 void setTextQualifier(char textQualifier)
textQualifier
- The character to use as a text qualifier in the data.public void setUseTextQualifier(boolean useTextQualifier)
useTextQualifier
- Whether to use a text qualifier while writing data or not.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 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 writeComment(String commentText) throws IOException
IOException
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 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, boolean preserveSpaces, boolean preserveReturn) 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.preserveReturn
- Whether to preserver return char after data lineIOException
- Thrown if an error occurs while writing data to the
destination stream.Copyright © 2015 jiucai.org. All rights reserved.