org.springframework.batch.item.file.BufferedReaderFactory.java Source code

Introduction

Here is the source code for org.springframework.batch.item.file.BufferedReaderFactory.java

Source

/*
 * Copyright 2006-2007 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.batch.item.file;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.UnsupportedEncodingException;

import org.springframework.core.io.Resource;

/**
 * A factory strategy for custom extensions of {@link BufferedReader} allowing
 * customisation of the standard behaviour of the <code>java.io</code> variety.
 * 
 * @author Dave Syer
 * 
 * @since 2.1
 */
public interface BufferedReaderFactory {

    /**
     * Create a {@link BufferedReader} for reading String items from the
     * provided resource.
     * 
     * @param resource a {@link Resource} containing the data to be read
     * @param encoding the encoding required for converting binary data to
     * String
     * @return a {@link BufferedReader}
     * @throws UnsupportedEncodingException if the encoding is not supported by
     * the platform
     * @throws IOException if there is a problem creating the reader
     */
    BufferedReader create(Resource resource, String encoding) throws UnsupportedEncodingException, IOException;

}