javax.batch.api.chunk.listener.SkipWriteListener Maven / Gradle / Ivy

/*
 * Copyright 2012 International Business Machines Corp.
 * 
 * See the NOTICE file distributed with this work for additional information
 * regarding copyright ownership. 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
 * 
 *   http://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 javax.batch.api.chunk.listener;

import java.util.List;
/**
 * SkipWriteListener intercepts skippable 
 * itemWriter exception handling.  

 */
public interface SkipWriteListener {
	/**
	 * The onSkipWriteItems method receives control when a 
	 * skippable exception is thrown from an ItemWriter 
	 * writeItems method.  This 
	 * method receives the exception and the items that were 
	 * skipped as an input. 
	 * @param items specifies the list of item passed to the 
	 * item writer.
	 * @param ex specifies the exception thrown by the 
	 * ItemWriter. 
	 * @throws Exception is thrown if an error occurs.
	 */
	public void onSkipWriteItem(List