2424
2525/**
2626 * The format specification of a CSV file.
27- *
27+ *
2828 * This class is immutable.
2929 */
3030public class CSVFormat implements Serializable {
@@ -95,7 +95,7 @@ public class CSVFormat implements Serializable {
9595 * locale dependent, it might be necessary to customize this format to accomodate to your regional settings.
9696 * <p/>
9797 * For example for parsing or generating a CSV file on a French system the following format will be used:
98- *
98+ *
9999 * <pre>
100100 * CSVFormat fmt = CSVFormat.EXCEL.withDelimiter(';');
101101 * </pre>
@@ -120,8 +120,8 @@ public class CSVFormat implements Serializable {
120120 * a tab-delimited format with a LF character as the line separator. Values are not quoted and special characters
121121 * are escaped with '\'.
122122 *
123- * @see <a
124- * href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html"> http://dev.mysql.com/doc/refman/5.1/en/load-data.html</a>
123+ * @see <a href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html">
124+ * http://dev.mysql.com/doc/refman/5.1/en/load-data.html</a>
125125 */
126126 public static final CSVFormat MYSQL =
127127 PRISTINE
@@ -132,7 +132,7 @@ public class CSVFormat implements Serializable {
132132
133133 /**
134134 * Creates a customized CSV format.
135- *
135+ *
136136 * @param delimiter
137137 * the char used for value separation
138138 * @param encapsulator
@@ -167,10 +167,10 @@ public class CSVFormat implements Serializable {
167167
168168 /**
169169 * Returns true if the given character is a line break character.
170- *
170+ *
171171 * @param c
172172 * the character to check
173- *
173+ *
174174 * @return true if <code>c</code> is a line break character
175175 */
176176 private static boolean isLineBreak (char c ) {
@@ -209,7 +209,7 @@ void validate() throws IllegalArgumentException {
209209
210210 /**
211211 * Returns the character delimiting the values (typically ';', ',' or '\t').
212- *
212+ *
213213 * @return the delimiter character
214214 */
215215 public char getDelimiter () {
@@ -218,7 +218,7 @@ public char getDelimiter() {
218218
219219 /**
220220 * Returns a copy of this format using the specified delimiter character.
221- *
221+ *
222222 * @param delimiter
223223 * the delimiter character
224224 * @return A copy of this format using the specified delimiter character
@@ -236,7 +236,7 @@ public CSVFormat withDelimiter(char delimiter) {
236236
237237 /**
238238 * Returns the character used to encapsulate values containing special characters.
239- *
239+ *
240240 * @return the encapsulator character
241241 */
242242 public char getEncapsulator () {
@@ -245,7 +245,7 @@ public char getEncapsulator() {
245245
246246 /**
247247 * Returns a copy of this format using the specified encapsulator character.
248- *
248+ *
249249 * @param encapsulator
250250 * the encapsulator character
251251 * @return A copy of this format using the specified encapsulator character
@@ -263,7 +263,7 @@ public CSVFormat withEncapsulator(char encapsulator) {
263263
264264 /**
265265 * Returns whether an encapsulator has been defined.
266- *
266+ *
267267 * @return {@code true} if an encapsulator is defined
268268 */
269269 public boolean isEncapsulating () {
@@ -272,7 +272,7 @@ public boolean isEncapsulating() {
272272
273273 /**
274274 * Returns the character marking the start of a line comment.
275- *
275+ *
276276 * @return the comment start marker.
277277 */
278278 public char getCommentStart () {
@@ -281,9 +281,9 @@ public char getCommentStart() {
281281
282282 /**
283283 * Returns a copy of this format using the specified character as the comment start marker.
284- *
284+ *
285285 * Note that the comment introducer character is only recognised at the start of a line.
286- *
286+ *
287287 * @param commentStart
288288 * the comment start marker
289289 * @return A copy of this format using the specified character as the comment start marker
@@ -301,9 +301,9 @@ public CSVFormat withCommentStart(char commentStart) {
301301
302302 /**
303303 * Specifies whether comments are supported by this format.
304- *
304+ *
305305 * Note that the comment introducer character is only recognised at the start of a line.
306- *
306+ *
307307 * @return <tt>true</tt> is comments are supported, <tt>false</tt> otherwise
308308 */
309309 public boolean isCommentingEnabled () {
@@ -312,7 +312,7 @@ public boolean isCommentingEnabled() {
312312
313313 /**
314314 * Returns the escape character.
315- *
315+ *
316316 * @return the escape character
317317 */
318318 public char getEscape () {
@@ -321,7 +321,7 @@ public char getEscape() {
321321
322322 /**
323323 * Returns a copy of this format using the specified escape character.
324- *
324+ *
325325 * @param escape
326326 * the escape character
327327 * @return A copy of this format using the specified escape character
@@ -339,7 +339,7 @@ public CSVFormat withEscape(char escape) {
339339
340340 /**
341341 * Returns whether escape are being processed.
342- *
342+ *
343343 * @return {@code true} if escapes are processed
344344 */
345345 public boolean isEscaping () {
@@ -348,7 +348,7 @@ public boolean isEscaping() {
348348
349349 /**
350350 * Specifies whether spaces around values are ignored when parsing input.
351- *
351+ *
352352 * @return <tt>true</tt> if spaces around values are ignored, <tt>false</tt> if they are treated as part of the
353353 * value.
354354 */
@@ -358,7 +358,7 @@ public boolean isSurroundingSpacesIgnored() {
358358
359359 /**
360360 * Returns a copy of this format with the specified trimming behavior.
361- *
361+ *
362362 * @param surroundingSpacesIgnored
363363 * the trimming behavior, <tt>true</tt> to remove the surrounding spaces, <tt>false</tt> to leave the
364364 * spaces as is.
@@ -371,7 +371,7 @@ public CSVFormat withSurroundingSpacesIgnored(boolean surroundingSpacesIgnored)
371371
372372 /**
373373 * Specifies whether empty lines between records are ignored when parsing input.
374- *
374+ *
375375 * @return <tt>true</tt> if empty lines between records are ignored, <tt>false</tt> if they are turned into empty
376376 * records.
377377 */
@@ -381,7 +381,7 @@ public boolean isEmptyLinesIgnored() {
381381
382382 /**
383383 * Returns a copy of this format with the specified empty line skipping behavior.
384- *
384+ *
385385 * @param emptyLinesIgnored
386386 * the empty line skipping behavior, <tt>true</tt> to ignore the empty lines between the records,
387387 * <tt>false</tt> to translate empty lines to empty records.
@@ -394,7 +394,7 @@ public CSVFormat withEmptyLinesIgnored(boolean emptyLinesIgnored) {
394394
395395 /**
396396 * Returns the line separator delimiting output records.
397- *
397+ *
398398 * @return the line separator
399399 */
400400 public String getLineSeparator () {
@@ -403,10 +403,10 @@ public String getLineSeparator() {
403403
404404 /**
405405 * Returns a copy of this format using the specified output line separator.
406- *
406+ *
407407 * @param lineSeparator
408408 * the line separator to be used for output.
409- *
409+ *
410410 * @return A copy of this format using the specified output line separator
411411 */
412412 public CSVFormat withLineSeparator (String lineSeparator ) {
@@ -421,20 +421,20 @@ String[] getHeader() {
421421 /**
422422 * Returns a copy of this format using the specified header. The header can either be parsed automatically from the
423423 * input file with:
424- *
424+ *
425425 * <pre>
426426 * CSVFormat format = aformat.withHeader();
427427 * </pre>
428- *
428+ *
429429 * or specified manually with:
430- *
430+ *
431431 * <pre>
432432 * CSVFormat format = aformat.withHeader("name", "email", "phone");
433433 * </pre>
434- *
434+ *
435435 * @param header
436436 * the header, <tt>null</tt> if disabled, empty if parsed automatically, user specified otherwise.
437- *
437+ *
438438 * @return A copy of this format using the specified header
439439 */
440440 public CSVFormat withHeader (String ... header ) {
@@ -444,7 +444,7 @@ public CSVFormat withHeader(String... header) {
444444
445445 /**
446446 * Parses the specified content.
447- *
447+ *
448448 * @param in
449449 * the input stream
450450 */
@@ -454,7 +454,7 @@ public Iterable<CSVRecord> parse(Reader in) throws IOException {
454454
455455 /**
456456 * Format the specified values.
457- *
457+ *
458458 * @param values
459459 * the values to format
460460 */
0 commit comments