001/*
002 * Copyright 2006-2007 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.springframework.batch.item.file;
017
018import java.io.BufferedReader;
019import java.io.IOException;
020import java.io.UnsupportedEncodingException;
021
022import org.springframework.core.io.Resource;
023
024/**
025 * A factory strategy for custom extensions of {@link BufferedReader} allowing
026 * customisation of the standard behaviour of the <code>java.io</code> variety.
027 * 
028 * @author Dave Syer
029 * 
030 * @since 2.1
031 */
032public interface BufferedReaderFactory {
033
034        /**
035         * Create a {@link BufferedReader} for reading String items from the
036         * provided resource.
037         * 
038         * @param resource a {@link Resource} containing the data to be read
039         * @param encoding the encoding required for converting binary data to
040         * String
041         * @return a {@link BufferedReader}
042         * @throws UnsupportedEncodingException if the encoding is not supported by
043         * the platform
044         * @throws IOException if there is a problem creating the reader
045         */
046        BufferedReader create(Resource resource, String encoding) throws UnsupportedEncodingException, IOException;
047
048}