org.easybatch.xml.MultiXmlFileRecordReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of easybatch-xml Show documentation
Easy Batch xml module
The newest version!
/**
 * The MIT License
 *
 *   Copyright (c) 2020, Mahmoud Ben Hassine ([email protected])
 *
 *   Permission is hereby granted, free of charge, to any person obtaining a copy
 *   of this software and associated documentation files (the "Software"), to deal
 *   in the Software without restriction, including without limitation the rights
 *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *   copies of the Software, and to permit persons to whom the Software is
 *   furnished to do so, subject to the following conditions:
 *
 *   The above copyright notice and this permission notice shall be included in
 *   all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *   THE SOFTWARE.
 */
package org.easybatch.xml;

import org.easybatch.core.reader.AbstractFileRecordReader;
import org.easybatch.core.reader.AbstractMultiFileRecordReader;

import java.io.File;
import java.nio.charset.Charset;
import java.util.List;

/**
 * Reader for multiple xml files in one shot.
 * Files must have the same format (schema).
 *
 * @author Mahmoud Ben Hassine ([email protected])
 */
public class MultiXmlFileRecordReader extends AbstractMultiFileRecordReader {

    private String rootElementName;

    /**
     * Create a new {@link MultiXmlFileRecordReader}.
     *
     * @param files to read
     * @param rootElementName to match records
     * @deprecated This constructor is deprecated since v5.3 and will be removed in v6.
     * It will be replaced with a constructor that accepts a {@code List}
     */
    @Deprecated
    public MultiXmlFileRecordReader(List files, String rootElementName) {
        this(files, rootElementName, Charset.defaultCharset());
    }

    /**
     * Create a new {@link MultiXmlFileRecordReader}.
     * @param files to read
     * @param rootElementName to match records
     * @param charset of files
     * @deprecated This constructor is deprecated since v5.3 and will be removed in v6.
     * It will be replaced with a constructor that accepts a {@code List}
     */
    @Deprecated
    public MultiXmlFileRecordReader(List files, String rootElementName, Charset charset) {
        super(files, charset);
        this.rootElementName = rootElementName;
    }

    @Override
    protected AbstractFileRecordReader createReader() throws Exception {
        return new XmlFileRecordReader(currentFile, rootElementName, charset.name());
    }
}