/*
* Copyright 2002-2012 the original author or authors.
*
* 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 org.springframework.jdbc.core;
Extension of the BatchPreparedStatementSetter interface, adding a batch exhaustion check. This interface allows you to signal the end of a batch rather than
having to determine the exact batch size upfront. Batch size is still
being honored but it is now the maximum size of the batch.
The isBatchExhausted method is called after each call to BatchPreparedStatementSetter.setValues to determine whether there were some values added, or if the batch was determined to be complete and no additional values were provided during the last call to setValues.
Consider extending the AbstractInterruptibleBatchPreparedStatementSetter base class instead of implementing this interface directly, using a single setValuesIfAvailable callback method that checks for available values and sets them, returning whether values have actually been provided.
Author: Thomas Risberg, Juergen Hoeller See Also: Since: 2.0
/**
* Extension of the {@link BatchPreparedStatementSetter} interface,
* adding a batch exhaustion check.
*
* <p>This interface allows you to signal the end of a batch rather than
* having to determine the exact batch size upfront. Batch size is still
* being honored but it is now the maximum size of the batch.
*
* <p>The {@link #isBatchExhausted} method is called after each call to
* {@link #setValues} to determine whether there were some values added,
* or if the batch was determined to be complete and no additional values
* were provided during the last call to {@code setValues}.
*
* <p>Consider extending the
* {@link org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter}
* base class instead of implementing this interface directly, using a single
* {@code setValuesIfAvailable} callback method that checks for available
* values and sets them, returning whether values have actually been provided.
*
* @author Thomas Risberg
* @author Juergen Hoeller
* @since 2.0
* @see JdbcTemplate#batchUpdate(String, BatchPreparedStatementSetter)
* @see org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter
*/
public interface InterruptibleBatchPreparedStatementSetter extends BatchPreparedStatementSetter {
Return whether the batch is complete, that is, whether there were no additional values added during the last setValues call. NOTE: If this method returns true, any parameters that might have been set during the last setValues call will be ignored! Make sure that you set a corresponding internal flag if you detect exhaustion at the beginning of your setValues implementation, letting this method return true based on the flag.
Params: - i – index of the statement we're issuing in the batch, starting from 0
See Also: Returns: whether the batch is already exhausted
/**
* Return whether the batch is complete, that is, whether there were no
* additional values added during the last {@code setValues} call.
* <p><b>NOTE:</b> If this method returns {@code true}, any parameters
* that might have been set during the last {@code setValues} call will
* be ignored! Make sure that you set a corresponding internal flag if you
* detect exhaustion <i>at the beginning</i> of your {@code setValues}
* implementation, letting this method return {@code true} based on the flag.
* @param i index of the statement we're issuing in the batch, starting from 0
* @return whether the batch is already exhausted
* @see #setValues
* @see org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter#setValuesIfAvailable
*/
boolean isBatchExhausted(int i);
}