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.xml; 018 019import java.io.IOException; 020 021import javax.xml.stream.XMLEventWriter; 022 023/** 024 * Callback interface for writing to an XML file - useful e.g. for handling headers 025 * and footers. 026 * 027 * @author Robert Kasanicky 028 */ 029public interface StaxWriterCallback { 030 031 /** 032 * Write contents using the supplied {@link XMLEventWriter}. It is not 033 * required to flush the writer inside this method. 034 * 035 * @param writer the {@link XMLEventWriter} to be used to write the contents. 036 * 037 * @throws IOException thrown if an error occurs during writing. 038 */ 039 void write(XMLEventWriter writer) throws IOException; 040}