001/*
002 * Copyright 2002-2017 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.core;
018
019/**
020 * Interface to be implemented by objects that can close resources
021 * allocated by parameters like {@code SqlLobValue} objects.
022 *
023 * <p>Typically implemented by {@code PreparedStatementCreators} and
024 * {@code PreparedStatementSetters} that support {@link DisposableSqlTypeValue}
025 * objects (e.g. {@code SqlLobValue}) as parameters.
026 *
027 * @author Thomas Risberg
028 * @author Juergen Hoeller
029 * @since 1.1
030 * @see PreparedStatementCreator
031 * @see PreparedStatementSetter
032 * @see DisposableSqlTypeValue
033 * @see org.springframework.jdbc.core.support.SqlLobValue
034 */
035public interface ParameterDisposer {
036
037        /**
038         * Close the resources allocated by parameters that the implementing
039         * object holds, for example in case of a DisposableSqlTypeValue
040         * (like a SqlLobValue).
041         * @see DisposableSqlTypeValue#cleanup()
042         * @see org.springframework.jdbc.core.support.SqlLobValue#cleanup()
043         */
044        void cleanupParameters();
045
046}