001/*
002 * Copyright 2002-2012 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.jdbc.support.xml;
018
019import java.io.IOException;
020import java.io.Writer;
021
022/**
023 * Interface defining handling involved with providing {@code Writer}
024 * data for XML input.
025 *
026 * @author Thomas Risberg
027 * @since 2.5.5
028 * @see java.io.Writer
029 */
030public interface XmlCharacterStreamProvider {
031
032        /**
033         * Implementations must implement this method to provide the XML content
034         * for the {@code Writer}.
035         * @param writer the {@code Writer} object being used to provide the XML input
036         * @throws IOException if an I/O error occurs while providing the XML
037         */
038        void provideXml(Writer writer) throws IOException;
039
040}