Package org.supercsv.quote
Class ColumnQuoteMode
java.lang.Object
org.supercsv.quote.ColumnQuoteMode
- All Implemented Interfaces:
QuoteMode
When using ColumnQuoteMode surrounding quotes are only applied if required to escape special characters (per
RFC4180), or if a particular column should always be quoted.
- Since:
- 2.1.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionColumnQuoteMode
(boolean[] columnsToQuote) Constructs a new ColumnQuoteMode that quotes columns if the element representing that column in the supplied array is true.ColumnQuoteMode
(int... columnsToQuote) Constructs a new ColumnQuoteMode that quotes columns by column number. -
Method Summary
Modifier and TypeMethodDescriptionboolean
quotesRequired
(String csvColumn, CsvContext context, CsvPreference preference) Determines whether surrounding quotes are mandatory in cases where the CSV column would not normally be quoted (the data to be written doesn't contain special characters).
-
Field Details
-
columnNumbers
-
-
Constructor Details
-
ColumnQuoteMode
public ColumnQuoteMode(int... columnsToQuote) Constructs a new ColumnQuoteMode that quotes columns by column number. If no column numbers are supplied (i.e. no parameters) then quoting will be determined per RFC4180.- Parameters:
columnsToQuote
- the column numbers to quote
-
ColumnQuoteMode
public ColumnQuoteMode(boolean[] columnsToQuote) Constructs a new ColumnQuoteMode that quotes columns if the element representing that column in the supplied array is true. Please note that false doesn't disable quoting, it just means that quoting is determined by RFC4180.- Parameters:
columnsToQuote
- array of booleans (one per CSV column) indicating whether each column should be quoted or not- Throws:
NullPointerException
- if columnsToQuote is null
-
-
Method Details
-
quotesRequired
Determines whether surrounding quotes are mandatory in cases where the CSV column would not normally be quoted (the data to be written doesn't contain special characters).- Specified by:
quotesRequired
in interfaceQuoteMode
- Parameters:
csvColumn
- an element of a CSV filecontext
- the contextpreference
- the CSV preferences- Returns:
- true if surrounding quotes are mandatory, otherwise false
-