001/* 002 * Copyright 2006-2018 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 java.io.Writer; 020import java.io.IOException; 021 022/** 023 * Callback interface for writing a header to a file. 024 * 025 * @author Robert Kasanicky 026 * @author Mahmoud Ben Hassine 027 */ 028public interface FlatFileHeaderCallback { 029 030 /** 031 * Write contents to a file using the supplied {@link Writer}. It is not 032 * required to flush the writer inside this method. 033 * 034 * @param writer the {@link Writer} to be used to write the header. 035 * 036 * @throws IOException if error occurs during writing. 037 */ 038 void writeHeader(Writer writer) throws IOException; 039}