net.shredzone.jshred.util.CSVLine Maven / Gradle / Ivy
/**
* jshred - Shred's Toolbox
*
* Copyright (C) 2009 Richard "Shred" Körber
* http://jshred.shredzone.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License / GNU Lesser
* General Public License as published by the Free Software Foundation,
* either version 3 of the License, or (at your option) any later version.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
*/
package net.shredzone.jshred.util;
import java.util.ArrayList;
/**
* This class handles one CSV line.
*
* If you pass a String, it will be split into several columns which are delimited by the
* delim character. It will take care for proper unquoting if a column was quoted.
*
* You can also add and remove columns at will. The {@link #toString()} method will result
* in a valid CSV line that can be written out.
*
* The CSV format is: Each row ends with a newline. A row consists of one or more columns,
* each separated by a delimiter character. If one column contains the delimiter
* character, the entire column must be quoted in double quotes. If the column also
* contains the quote character, then the quote characters within the column must be
* doubled.
*
* CSVLine inherits the List interface for easier access.
*
* @author Richard "Shred" Körber
*/
public class CSVLine extends ArrayList {
private static final long serialVersionUID = 3544948840219359284L;
private char delim;
/**
* Creates a new, empty CSVLine with ';' as delimiter.
*/
public CSVLine() {
this(';');
}
/**
* Creates a new, empty CSVLine with the given delimiter.
*
* @param delim
* Delimiter
*/
public CSVLine(char delim) {
setDelimiter(delim);
}
/**
* Creates a new CSVLine, with the given text and ';' as default delimiter.
*
* @param text
* Text to be split up
*/
public CSVLine(String text) {
this();
addLine(text);
}
/**
* Creates a new CSVLine with the given text and the given delimiter.
*
* @param text
* Text to be split up
* @param delim
* Delimiter character
*/
public CSVLine(String text, char delim) {
this(delim);
addLine(text);
}
/**
* Adds a CSV line to the current content. All columns are added to the end of the
* current column list. This is most probably not what you wanted to do!
*
* If you want to use this class with a new line, use {@link #clear()} before:
*
*
* csvline.clear();
* csvline.addLine(line);
*
*
* @param text
* Line to be added
*/
public void addLine(String text) {
// --- Split the row ---
int max = text.length();
int start = 0;
int end;
while (start < max) {
if (text.charAt(start) == '"') {
// --- Quoted Column ---
end = start - 1;
do {
end = text.indexOf("\"", end + 2);
} while (end > 0 && end < (max - 1) && text.charAt(end + 1) == '"');
if (end < 0)
throw new IllegalArgumentException("ending quote char missing");
if (end < (max - 1) && text.charAt(end + 1) != delim)
throw new IllegalArgumentException("bad quoting");
String content = text.substring(start + 1, end);
content = content.replaceAll("\\\"\\\"", "\"");
add(content);
start = end + 1;
if (start < max && text.charAt(start) == delim) {
start++;
if (start >= max) add("");
}
} else {
// --- Unquoted Column ---
end = text.indexOf(String.valueOf(delim), start);
if (end >= 0) {
add(text.substring(start, end));
start = end + 1;
if (start >= max) add("");
} else {
add(text.substring(start));
start = max;
}
}
}
}
/**
* Sets the delimiter character. The quote character '"' is not allowed as a
* delimiter, and will throw an IllegalArgumentException.
*
* @param delim
* Delimiter
*/
public void setDelimiter(char delim) {
if (delim == '"')
throw new IllegalArgumentException("quote char is not a valid delimiter");
this.delim = delim;
}
/**
* Gets the delimiter character.
*
* @return Delimiter
*/
public char getDelimiter() {
return delim;
}
/**
* Gets a valid CSV line of the current content, using the current delimiter char.
*
* Note: There is no newline character at the end of the line!
*
* @return CSV line, without newline character
*/
@Override
public String toString() {
StringBuilder buffer = new StringBuilder();
boolean first = true;
for (String col : this) {
if (!first) {
buffer.append(delim);
}
if (col == null) col = "";
if (col.indexOf('"') >= 0) {
// --- Escaping needed ---
col = col.replaceAll("\\\"", "\"\"");
buffer.append('"');
buffer.append(col);
buffer.append('"');
} else {
// --- No escaping needed ---
buffer.append(col);
}
first = false;
}
return buffer.toString();
}
}