View Javadoc

1   /*
2    * Copyright 2006-2007 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.springframework.batch.item.file;
17  
18  import java.io.BufferedReader;
19  import java.io.IOException;
20  import java.io.UnsupportedEncodingException;
21  
22  import org.springframework.core.io.Resource;
23  
24  /**
25   * A factory strategy for custom extensions of {@link BufferedReader} allowing
26   * customisation of the standard behaviour of the <code>java.io</code> variety.
27   * 
28   * @author Dave Syer
29   * 
30   * @since 2.1
31   */
32  public interface BufferedReaderFactory {
33  
34  	/**
35  	 * Create a {@link BufferedReader} for reading String items from the
36  	 * provided resource.
37  	 * 
38  	 * @param resource a {@link Resource} containing the data to be read
39  	 * @param encoding the encoding required for converting binary data to
40  	 * String
41  	 * @return a {@link BufferedReader}
42  	 * @throws UnsupportedEncodingException if the encoding is not supported by
43  	 * the platform
44  	 * @throws IOException if there is a problem creating the reader
45  	 */
46  	BufferedReader create(Resource resource, String encoding) throws UnsupportedEncodingException, IOException;
47  
48  }