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 */
016
017package org.springframework.batch.item.file;
018
019import org.springframework.batch.item.file.mapping.FieldSetMapper;
020import org.springframework.batch.item.file.transform.LineTokenizer;
021
022
023/**
024 * Interface for mapping lines (strings) to domain objects typically used to map lines read from a file to domain objects
025 * on a per line basis.  Implementations of this interface perform the actual
026 * work of parsing a line without having to deal with how the line was
027 * obtained.  
028 * 
029 * @author Robert Kasanicky
030 * @param <T> type of the domain object
031 * @see FieldSetMapper
032 * @see LineTokenizer
033 * @since 2.0
034 */
035public interface LineMapper<T> {
036
037        /**
038         * Implementations must implement this method to map the provided line to 
039         * the parameter type T.  The line number represents the number of lines
040         * into a file the current line resides.
041         * 
042         * @param line to be mapped
043         * @param lineNumber of the current line
044         * @return mapped object of type T
045         * @throws Exception if error occurred while parsing.
046         */
047        T mapLine(String line, int lineNumber) throws Exception;
048}