com.opencsv.bean.IterableCSVToBeanBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencsv Show documentation
A simple library for reading and writing CSV in Java
There is a newer version: 5.9
package com.opencsv.bean;

/*
 * Copyright 2005 Bytecode Pty Ltd.
 * 
 * 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.
 */

import com.opencsv.CSVReader;

/**
 * Builder for creating an IterableCSVToBean.
 * This should be the preferred method of creating an IterableCSVToBean to keep
 * the number of constructors to a minimum.
 *
 *  * {@code
 * IterableCSVToBean bean =
 * new IterableCSVToBean()
 * .withReader(csvReader)
 * .withMapper(mappingStrategy)
 * .withFilter(csvToBeanFilter)
 * .build();
 * }
 * 
 *
 * @see IterableCSVToBean
 *
 * @param  Type of the bean to be iterated over
 */
public class IterableCSVToBeanBuilder {

    public static final String NO_MAPPING_STRATEGY_DEFINED = "Unable to instantiate IterableCSVToBeanBuilder because there is no MappingStrategy defined.";
    public static final String NO_READER_DEFINED = "Unable to instantiate IterableCSVToBeanBuilder because there is no CSVReader defined.";

    private MappingStrategy mapper;
    private CSVReader csvReader;
    private CsvToBeanFilter filter;

    /**
     * Default constructor.
     */
    public IterableCSVToBeanBuilder() {
    }

    /**
     * Creates the IterableCSVToBean.
     *
     * Will throw a runtime exception if the MappingStrategy or CSVReader is not set.
     *
     * @return An instance of IterableCSVToBean
     */
    public IterableCSVToBean build() {
        if (mapper == null) {
            throw new RuntimeException(NO_MAPPING_STRATEGY_DEFINED);
        }
        if (csvReader == null) {
            throw new RuntimeException(NO_READER_DEFINED);
        }
        return new IterableCSVToBean(csvReader, mapper, filter);
    }

    /**
     * Sets the MappingStrategy to be used by the builder.
     *
     * @param mappingStrategy An object that implements
     *   {@link com.opencsv.bean.MappingStrategy}
     * @return The builder with the MappingStrategy set
     */
    public IterableCSVToBeanBuilder withMapper(final MappingStrategy mappingStrategy) {
        this.mapper = mappingStrategy;
        return this;
    }

    /**
     * Sets the reader to be used by the builder.
     * @param reader CSVReader to be incorporated in the builder.
     * @return The builder with the CSVReader set
     */
    public IterableCSVToBeanBuilder withReader(final CSVReader reader) {
        this.csvReader = reader;
        return this;
    }

    /**
     * Used by unit tests.
     * @return The MappingStrategy to be used by the builder.
     */
    protected MappingStrategy getStrategy() {
        return mapper;
    }

    /**
     * Used by unit tests.
     * @return The csvReader to be used by the builder.
     */
    protected CSVReader getCsvReader() {
        return csvReader;
    }

    /**
     * Used by unit tests.
     *
     * @return Filter to be used by the builder.
     */
    protected Object getFilter() {
        return filter;
    }

    /**
     * Sets the filter used to remove unwanted data from the CSV file.
     *
     * @param filter An object implementing CsvToBeanFilter
     * @return The builder with the filter set
     */
    public IterableCSVToBeanBuilder withFilter(final CsvToBeanFilter filter) {
        this.filter = filter;
        return this;
    }
}