org.springframework.batch.core.ItemReadListener Maven / Gradle / Ivy

/*
 * Copyright 2006-2021 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.core;

import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.ItemWriter;

/**
 * Listener interface around the reading of an item.
 * 
 * @author Lucas Ward
 * @author Mahmoud Ben Hassine
 *
 */
public interface ItemReadListener extends StepListener {

	/**
	 * Called before {@link ItemReader#read()}
	 */
	void beforeRead();
	
	/**
	 * Called after {@link ItemReader#read()}.
	 * This method is called only for actual items (ie it is not called when the
	 * reader returns null).
	 * 
	 * @param item returned from read()
	 */
	void afterRead(T item);
	
	/**
	 * Called if an error occurs while trying to read.
	 * 
	 * @param ex thrown from {@link ItemReader}
	 */
	void onReadError(Exception ex);
}