Package com.opencsv.bean
Class ConverterNumber
- java.lang.Object
-
- com.opencsv.bean.AbstractCsvConverter
-
- com.opencsv.bean.ConverterNumber
-
- All Implemented Interfaces:
CsvConverter
public class ConverterNumber extends AbstractCsvConverter
This converter class is used in combination withCsvNumber
, that is, when number inputs and outputs should be formatted.- Since:
- 4.2
- Author:
- Andrew Rucker Jones
-
-
Field Summary
-
Fields inherited from class com.opencsv.bean.AbstractCsvConverter
errorLocale, locale, type, writeLocale
-
-
Constructor Summary
Constructors Constructor Description ConverterNumber(java.lang.Class<?> type, java.lang.String locale, java.lang.String writeLocale, java.util.Locale errorLocale, java.lang.String readFormat, java.lang.String writeFormat)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
convertToRead(java.lang.String value)
Method for converting from a string to the proper data type of the destination field.java.lang.String
convertToWrite(java.lang.Object value)
Formats the number in question according to the pattern that has been provided.-
Methods inherited from class com.opencsv.bean.AbstractCsvConverter
setErrorLocale, setLocale, setType, setWriteLocale
-
-
-
-
Constructor Detail
-
ConverterNumber
public ConverterNumber(java.lang.Class<?> type, java.lang.String locale, java.lang.String writeLocale, java.util.Locale errorLocale, java.lang.String readFormat, java.lang.String writeFormat) throws CsvBadConverterException
- Parameters:
type
- The class of the type of the data being processedlocale
- If not null or empty, specifies the locale used for converting locale-specific data types for readingwriteLocale
- If not null or empty, specifies the locale used for converting locale-specific data types for writingerrorLocale
- The locale to use for error messagesreadFormat
- The string to use for parsing the number.writeFormat
- The string to use for formatting the number.- Throws:
CsvBadConverterException
- If the information given to initialize the converter are inconsistent (e.g. the annotationCsvNumber
has been applied to a non-Number
type.- See Also:
CsvNumber.value()
-
-
Method Detail
-
convertToRead
public java.lang.Object convertToRead(java.lang.String value) throws CsvDataTypeMismatchException
Description copied from interface:CsvConverter
Method for converting from a string to the proper data type of the destination field.- Parameters:
value
- The string from the selected field of the CSV file. If the field is marked as required in the annotation, this value is guaranteed not to benull
, empty or blank according toStringUtils.isBlank(java.lang.CharSequence)
- Returns:
- An
Object
representing the input data converted into the proper type - Throws:
CsvDataTypeMismatchException
- If the input string cannot be converted into the proper type
-
convertToWrite
public java.lang.String convertToWrite(java.lang.Object value)
Formats the number in question according to the pattern that has been provided.- Specified by:
convertToWrite
in interfaceCsvConverter
- Overrides:
convertToWrite
in classAbstractCsvConverter
- Parameters:
value
- The contents of the field currently being processed from the bean to be written. Can be null if the field is not marked as required.- Returns:
- A string representation of the value of the field in question in
the bean passed in, or an empty string if
value
is null
-
-