public class CsvBuilderImpl extends Object implements CsvBuilder
Constructor and Description |
---|
CsvBuilderImpl() |
Modifier and Type | Method and Description |
---|---|
protected static List<String> |
fromSeparatedValues(String aSeparatedValues)
|
protected static List<String> |
fromSeparatedValues(String aSeparatedValues,
char aDelimiter)
|
protected static List<String> |
fromSeparatedValues(String aRecord,
char aDelimiter,
CsvEscapeMode aCsvEscapeMode) |
protected static List<String> |
fromSplitValues(String aSplitValues)
|
protected static List<String> |
fromSplitValues(String aSplitValues,
char aDelimiter)
|
protected static List<String> |
fromSplitValues(String aValues,
String aDelimiters)
|
CsvEscapeMode |
getCsvEscapeMode()
Retrieves the CSV escape mode from the CSV escape mode property.
|
char |
getDelimiterChar()
Retrieves the delimiter char from the delimiter char property.
|
Collection<Object> |
getFields()
Retrieves the CSV elements from the CSV elements property.
|
String |
getRecord()
Retrieves the CSV line from the CSV line property.
|
void |
setCsvEscapeMode(CsvEscapeMode aCsvEscapeMode)
Sets the CSV escape mode for the CSV escape mode property.
|
void |
setDelimiterChar(char aDelimiterChar)
Sets the delimiter char for the delimiter char property.
|
void |
setFields(Collection<Object> aFields)
Sets the CSV elements for the CSV elements property.
|
void |
setFields(Object... aFields)
Sets the CSV elements for the CSV elements property.
|
void |
setRecord(String aRecord)
Sets the CSV line for the CSV line property.
|
protected static String |
toEscapedRegexp(char aDelimiter) |
List<String> |
toFields()
Creates a list of
String elements from the CSV line being set via
CsvBuilder.setRecord(String) or CsvBuilder.withRecord(String) . |
String |
toRecord()
Creates a CSV line from the elements being set via
CsvBuilder.setFields(String[]) or CsvBuilder.withFields(String[]) . |
String |
toRecord(Collection<Object> aFields)
Creates a CSV line from the fields being provided
This method is to be side effect free in terms of the fields (and the
resulting record) is not part of the state for this instance (from the
point of view of this method).
|
String |
toRecord(Object... aFields)
Creates a CSV line from the fields being provided
This method is to be side effect free in terms of the fields (and the
resulting record) is not part of the state for this instance (from the
point of view of this method).
|
String |
toRecord(String... aFields)
Creates a CSV line from the fields being provided
This method is to be side effect free in terms of the fields (and the
resulting record) is not part of the state for this instance (from the
point of view of this method).
|
protected static String |
toSeparatedValue(Object aValue)
Escapes a single value according to the rules of CSV like separated
values with the according
Delimiter.CSV_DELIMITER
delimiter. |
protected static String |
toSeparatedValue(Object aValue,
char aDelimiter)
Escapes a single value according to the rules of CSV like separated
values.
|
protected static String |
toSeparatedValues(Collection<?> aCollection)
Takes the collection and creates a single
String with the
according Delimiter.CSV_DELIMITER delimiter. |
protected static String |
toSeparatedValues(Collection<?> aCollection,
char aDelimiter)
Takes the collection and creates a single
String with the
provided delimiter. |
protected static String |
toSeparatedValues(Collection<Object> aFields,
char aDelimiter,
CsvEscapeMode aCsvEscapeMode) |
protected static String |
toSeparatedValues(Object[] aArray)
|
protected static String |
toSeparatedValues(Object[] aArray,
char aDelimiter)
Takes the array's String representation and creates a single
String with the provided delimiter. |
protected static String |
toSplitValue(Object aValue,
char aDelimiter)
Creates the
String representation of a single split value not
applying any escaping. |
protected static String |
toSplitValues(Collection<?> aCollection)
Takes the collection and creates a single
String with the
according Delimiter.CSV_DELIMITER delimiter. |
protected static String |
toSplitValues(Collection<?> aCollection,
char aDelimiter)
Takes the collection and creates a single
String with the
provided delimiter. |
protected static String |
toSplitValues(Object[] aArray)
|
protected static String |
toSplitValues(Object[] aArray,
char aDelimiter)
Takes the array's String representation and creates a single
String with the provided delimiter. |
String |
toString()
The
String being build by the builder upon the settings of the
attributes. |
String[] |
toStrings()
Creates an array of
String s from the CSV line being set via
CsvBuilder.setRecord(String) or CsvBuilder.withRecord(String) . |
String[] |
toStrings(String aRecord)
Creates an array of
String s from the CSV line being set via
CsvBuilder.setRecord(String) or CsvBuilder.withRecord(String) . |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, setFields, toFields, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, toRecord, withCsvEscapeMode, withDelimiterChar, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withFields, withRecord
public CsvEscapeMode getCsvEscapeMode()
CsvBuilder
getCsvEscapeMode
in interface CsvBuilder
public void setCsvEscapeMode(CsvEscapeMode aCsvEscapeMode)
CsvBuilder
setCsvEscapeMode
in interface CsvBuilder
aCsvEscapeMode
- The CSV escape mode to be stored by the align text
mode property.public void setRecord(String aRecord)
CsvBuilder
setRecord
in interface CsvBuilder
aRecord
- The CSV line to be stored by the CSV line property.public String getRecord()
CsvBuilder
getRecord
in interface CsvBuilder
public void setFields(Object... aFields)
CsvBuilder
setFields
in interface CsvBuilder
aFields
- The CSV elements to be stored by the CSV elements
property.public Collection<Object> getFields()
CsvBuilder
getFields
in interface CsvBuilder
public void setFields(Collection<Object> aFields)
CsvBuilder
setFields
in interface CsvBuilder
aFields
- The CSV elements to be stored by the CSV elements
property.public char getDelimiterChar()
CsvBuilder
getDelimiterChar
in interface CsvBuilder
public void setDelimiterChar(char aDelimiterChar)
CsvBuilder
setDelimiterChar
in interface CsvBuilder
aDelimiterChar
- The delimiter char to be stored by the text align
mode property.public List<String> toFields() throws IllegalStateException
CsvBuilder
String
elements from the CSV line being set via
CsvBuilder.setRecord(String)
or CsvBuilder.withRecord(String)
.toFields
in interface CsvBuilder
IllegalStateException
- Thrown in case no elements have been set
via the CsvBuilder.withFields(String[])
or
CsvBuilder.setFields(String[])
methods.public String toRecord() throws IllegalStateException
CsvBuilder
CsvBuilder.setFields(String[])
or CsvBuilder.withFields(String[])
.toRecord
in interface CsvBuilder
IllegalStateException
- Thrown in case no CSV line has been set via
the CsvBuilder.withRecord(String)
or CsvBuilder.setRecord(String)
methods.public String toRecord(Object... aFields)
CsvBuilder
CsvBuilder.withDelimiterChar(char)
can cause side effects!
For avoiding thread race conditions / side effects regarding the fields
(and the resulting record), use this method instead of the combination of
CsvBuilder.withFields(String...)
with CsvBuilder.toRecord()
.toRecord
in interface CsvBuilder
aFields
- The CSV elements to be converted into a record.public String toRecord(Collection<Object> aFields)
CsvBuilder
CsvBuilder.withDelimiterChar(char)
can cause side effects!
For avoiding thread race conditions / side effects regarding the fields
(and the resulting record), use this method instead of the combination of
CsvBuilder.withFields(String...)
with CsvBuilder.toRecord()
.toRecord
in interface CsvBuilder
aFields
- The CSV elements to be converted into a record.public String[] toStrings() throws IllegalStateException
CsvBuilder
String
s from the CSV line being set via
CsvBuilder.setRecord(String)
or CsvBuilder.withRecord(String)
. It should
return the same result as an array as a call to CsvBuilder.toFields()
.toStrings
in interface CsvBuilder
IllegalStateException
public String toRecord(String... aFields) throws IllegalStateException
CsvBuilder
CsvBuilder.withDelimiterChar(char)
can cause side effects!
For avoiding thread race conditions / side effects regarding the fields
(and the resulting record), use this method instead of the combination of
CsvBuilder.withFields(String...)
with CsvBuilder.toRecord()
.toRecord
in interface CsvBuilder
aFields
- The CSV elements to be converted into a record.IllegalStateException
public String[] toStrings(String aRecord)
CsvBuilder
String
s from the CSV line being set via
CsvBuilder.setRecord(String)
or CsvBuilder.withRecord(String)
. It should
return the same result as an array as a call to CsvBuilder.toFields()
.
This method is to be side effect free in terms of the record (and the
resulting fields) is not part of the state for this instance (from the
point of view of this method). Still changing for example the delimiter
via CsvBuilder.withDelimiterChar(char)
can cause side effects!
For avoiding thread race conditions / side effects regarding the record
(and the resulting fields), use this method instead of the combination of
CsvBuilder.withRecord(String)
with CsvBuilder.toStrings()
.toStrings
in interface CsvBuilder
aRecord
- The CSV line to be stored by the CSV line property.public String toString() throws IllegalStateException
CsvBuilder
String
being build by the builder upon the settings of the
attributes. It should return the same result as a call to
CsvBuilder.toRecord()
.toString
in interface CsvBuilder
toString
in class Object
String
IllegalStateException
protected static List<String> fromSeparatedValues(String aRecord, char aDelimiter, CsvEscapeMode aCsvEscapeMode)
protected static String toSeparatedValues(Collection<Object> aFields, char aDelimiter, CsvEscapeMode aCsvEscapeMode)
protected static String toSeparatedValues(Collection<?> aCollection)
String
with the
according Delimiter.CSV_DELIMITER
delimiter. Unescaping any
escaped chars is taken care of by this method, for example an unescaped
delimiter char is escaped in the result.protected static String toSeparatedValues(Collection<?> aCollection, char aDelimiter)
String
with the
provided delimiter. Unescaping any escaped chars is taken care of by this
method, for example an unescaped delimiter char is escaped in the result.protected static String toSeparatedValue(Object aValue)
Delimiter.CSV_DELIMITER
delimiter.aValue
- The value which's String
representation is to be
escaped accordingly.protected static String toSeparatedValue(Object aValue, char aDelimiter)
protected static List<String> fromSeparatedValues(String aSeparatedValues)
String
and creates a List
with String
instances containing the elements as identified from the String
by splitting the String
at the delimiter positions and adding
those chunks to the List
with the according
Delimiter.CSV_DELIMITER
delimiter.. Escaping any unescaped
chars is taken care of by this method, for example an escaped delimiter
char is unescaped in the result.protected static List<String> fromSeparatedValues(String aSeparatedValues, char aDelimiter)
String
and creates a List
with String
instances containing the elements as identified from the String
by splitting the String
at the delimiter positions and adding
those chunks to the List
. Escaping any unescaped chars is taken
care of by this method, for example an escaped delimiter char is
unescaped in the result.aSeparatedValues
- The String
representing the CSV
String
where contained elements are separated from each
other by the given delimiter.aDelimiter
- The delimiter used for separating the elements if the
single CSV String
.List
containing the elements as identified from the
given CSV String
.protected static String toSplitValues(Object[] aArray, char aDelimiter)
String
with the provided delimiter. No escaping is taken of, for
escaping either use the according
SeparatedValuesUtility#toSeparatedValues(Object[], char)
method
or do escaping manually via toSeparatedValue
.protected static String toSplitValues(Collection<?> aCollection)
String
with the
according Delimiter.CSV_DELIMITER
delimiter. No escaping is
taken of, for escaping either use the according toSeparatedValues
method or do escaping manually via toSeparatedValue
.protected static String toSplitValues(Collection<?> aCollection, char aDelimiter)
String
with the
provided delimiter. No escaping is taken of, for escaping either use the
according toSeparatedValues
method or do escaping manually via
toSeparatedValue
.protected static String toSplitValue(Object aValue, char aDelimiter)
String
representation of a single split value not
applying any escaping.protected static List<String> fromSplitValues(String aSplitValues)
String
and creates a List
with String
instances containing the elements as identified from the String
by splitting the String
at the delimiter positions and adding
those chunks to the List
with the according
Delimiter.CSV_DELIMITER
delimiter.. Escaping any unescaped
chars is taken care of by this method, for example an escaped delimiter
char is unescaped in the result.protected static List<String> fromSplitValues(String aSplitValues, char aDelimiter)
String
and creates a List
with String
instances containing the elements as identified from the String
by splitting the String
at the delimiter positions and adding
those chunks to the List
. Escaping any unescaped chars is taken
care of by this method, for example an escaped delimiter char is
unescaped in the result.aSplitValues
- The String
representing the CSV
String
where contained elements are split from each other
by the given delimiter.aDelimiter
- The delimiter used for separating the elements if the
single CSV String
.List
containing the elements as identified from the
given CSV String
.protected static List<String> fromSplitValues(String aValues, String aDelimiters)
String
and creates a List
with String
instances containing the elements as identified from the String
by splitting the String
at the delimiter positions and adding
those chunks to the List
. Escaping any unescaped chars is taken
care of by this method, for example an escaped delimiter char is
unescaped in the result.protected static String toSeparatedValues(Object[] aArray, char aDelimiter)
String
with the provided delimiter. Unescaping any escaped chars
is taken care of by this method, for example an unescaped delimiter char
is escaped in the result.protected static String toEscapedRegexp(char aDelimiter)
Copyright © 2017. All rights reserved.