http://opencsv.sf.net: A simple library for reading and writing CSV in Java
  • Glen Smith
  • Tom Squires
  • Maciek Opala
  • J.C. Romanda
  • Sean Sullivan
  • Kyle Miller
  • Vladimir Dolzhenko
  • Scott Conway
  • Andrew Rucker Jones 
/*
 * Copyright 2017 Andrew Rucker Jones.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.opencsv.bean;

import com.opencsv.exceptions.CsvConstraintViolationException;
import com.opencsv.exceptions.CsvDataTypeMismatchException;

import java.util.Locale;


Classes implementing this interface perform a conversion from String to
some type on reading and some type to String on writing.

This interface is used by BeanField to perform the actual data conversion.


Synchronization: All implementations of this interface must
be thread-safe.


Author:Andrew Rucker Jones
Since:4.2
/**
 * Classes implementing this interface perform a conversion from String to
 * some type on reading and some type to String on writing.
 * <p>This interface is used by BeanField to perform the actual data conversion.</p>
 * <p><b><i>Synchronization:</i></b> All implementations of this interface must
 * be thread-safe.</p>
 *
 * @author Andrew Rucker Jones
 * @since 4.2
 */
public interface CsvConverter {
    
Method for converting from a string to the proper data type of the
destination field.

Params:
  • 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 be null, empty or blank according to StringUtils.isBlank(CharSequence)
Throws:
Returns:An Object representing the input data converted into the proper type
/**
     * Method for converting from a string to the proper data type of the
     * destination field.
     *
     * @param 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 be {@code null}, empty or blank according to
     *   {@link org.apache.commons.lang3.StringUtils#isBlank(java.lang.CharSequence)}
     * @return An {@link java.lang.Object} representing the input data converted
     *   into the proper type
     * @throws CsvDataTypeMismatchException    If the input string cannot be converted into
     *                                         the proper type
     * @throws CsvConstraintViolationException When the internal structure of
     *                                         data would be violated by the data in the CSV file
     */
    Object convertToRead(String value)
            throws CsvDataTypeMismatchException, CsvConstraintViolationException;
    
    
Method for converting from the data type of the destination field to a
string.

Params:
  • 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.
Throws:
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
/**
     * Method for converting from the data type of the destination field to a
     * string.
     * 
     * @param value The contents of the field currently being processed from the
     *   bean to be written. Can be {@code null} if the field is not marked as
     *   required.
     * @return A string representation of the value of the field in question in
     *   the bean passed in, or an empty string if {@code value} is
     *   {@code null}
     * @throws CsvDataTypeMismatchException If the input cannot be converted to
     *   a string by this converter
     */
    String convertToWrite(Object value)
            throws CsvDataTypeMismatchException;
    
    
Sets the locale for all error messages.

Params:
  • errorLocale – Locale for error messages. If null, the default locale is used.
/**
     * Sets the locale for all error messages.
     * @param errorLocale Locale for error messages. If {@code null}, the
     *   default locale is used.
     */
    void setErrorLocale(Locale errorLocale);

    
Sets the class of the type of the data being processed.

Params:
  • type – The type of the data being processed
Since:4.3
/**
     * Sets the class of the type of the data being processed.
     *
     * @param type The type of the data being processed
     * @since 4.3
     */
    void setType(Class<?> type);

    
If not null or empty, specifies the locale used for converting
locale-specific data types for reading.

Params:
  • locale – The name of the locale for locale-sensitive data
Since:4.3
/**
     * If not null or empty, specifies the locale used for converting
     * locale-specific data types for reading.
     *
     * @param locale The name of the locale for locale-sensitive data
     * @since 4.3
     */
    void setLocale(String locale);

    
If not null or empty, specifies the locale used for converting
locale-specific data types for writing.

Params:
  • writeLocale – The name of the locale for locale-sensitive data
Since:5.0
/**
     * If not null or empty, specifies the locale used for converting
     * locale-specific data types for writing.
     *
     * @param writeLocale The name of the locale for locale-sensitive data
     * @since 5.0
     */
    void setWriteLocale(String writeLocale);
}