-
Notifications
You must be signed in to change notification settings - Fork 93
/
CsvWriterBuilder.java
140 lines (122 loc) · 4.84 KB
/
CsvWriterBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*
* Copyright 2015 Oliver Siegmar
*
* 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.
*/
package de.siegmar.fastcsv.writer;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.OpenOption;
import java.nio.file.Path;
import java.util.Objects;
/**
* This builder is used to create configured instances of {@link CsvWriter}. The default
* configuration of this class complies with RFC 4180.
*/
public final class CsvWriterBuilder {
/**
* Field separator character (default: ',' - comma).
*/
private char fieldSeparator = ',';
/**
* The character for enclosing fields (default: '"' - double quotes).
*/
private char quoteCharacter = '"';
/**
* The strategy when fields should be enclosed by the {@link #quoteCharacter}
* (default: {@link QuoteStrategy#REQUIRED}).
*/
private QuoteStrategy quoteStrategy = QuoteStrategy.REQUIRED;
/**
* The line delimiter to be used (default: {@link LineDelimiter#CRLF}).
*/
private LineDelimiter lineDelimiter = LineDelimiter.CRLF;
CsvWriterBuilder() {
}
/**
* Sets the character that is used to separate columns (default: ',' - comma).
*
* @param fieldSeparator the field separator character.
* @return This updated object, so that additional method calls can be chained together.
*/
public CsvWriterBuilder fieldSeparator(final char fieldSeparator) {
this.fieldSeparator = fieldSeparator;
return this;
}
/**
* Sets the character that is used to quote values (default: '"' - double quotes).
*
* @param quoteCharacter the character for enclosing fields.
* @return This updated object, so that additional method calls can be chained together.
*/
public CsvWriterBuilder quoteCharacter(final char quoteCharacter) {
this.quoteCharacter = quoteCharacter;
return this;
}
/**
* Sets the strategy that defines when quoting has to be performed
* (default: {@link QuoteStrategy#REQUIRED}).
*
* @param quoteStrategy the strategy when fields should be enclosed using the.
* @return This updated object, so that additional method calls can be chained together.
*/
public CsvWriterBuilder quoteStrategy(final QuoteStrategy quoteStrategy) {
this.quoteStrategy = quoteStrategy;
return this;
}
/**
* Sets the delimiter that is used to separate lines (default: {@link LineDelimiter#CRLF}).
*
* @param lineDelimiter the line delimiter to be used.
* @return This updated object, so that additional method calls can be chained together.
*/
public CsvWriterBuilder lineDelimiter(final LineDelimiter lineDelimiter) {
this.lineDelimiter = lineDelimiter;
return this;
}
/**
* Constructs a {@link CsvWriter} for the specified Writer.
*
* @param writer the Writer to use for writing CSV data.
* @return a new CsvWriter instance
* @throws NullPointerException if writer is null
*/
public CsvWriter build(final Writer writer) {
Objects.requireNonNull(writer, "writer must not be null");
return new CsvWriter(writer, fieldSeparator, quoteCharacter, quoteStrategy,
lineDelimiter, true);
}
/**
* Constructs a {@link CsvWriter} for the specified Path.
*
* @param path the Path (file) to write data to.
* @param charset the character set to be used for writing data to the file.
* @param openOptions options specifying how the file is opened.
* See {@link Files#newOutputStream(Path, OpenOption...)} for defaults.
* @return a new CsvWriter instance
* @throws IOException if a write error occurs
* @throws NullPointerException if path or charset is null
*/
public CsvWriter build(final Path path, final Charset charset,
final OpenOption... openOptions)
throws IOException {
Objects.requireNonNull(path, "path must not be null");
Objects.requireNonNull(charset, "charset must not be null");
return new CsvWriter(new OutputStreamWriter(Files.newOutputStream(path, openOptions),
charset),
fieldSeparator, quoteCharacter, quoteStrategy, lineDelimiter, false);
}
}