1 /*
2 * Copyright 2002-2012 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.jdbc.core;
18
19 /**
20 * Extension of the {@link BatchPreparedStatementSetter} interface,
21 * adding a batch exhaustion check.
22 *
23 * <p>This interface allows you to signal the end of a batch rather than
24 * having to determine the exact batch size upfront. Batch size is still
25 * being honored but it is now the maximum size of the batch.
26 *
27 * <p>The {@link #isBatchExhausted} method is called after each call to
28 * {@link #setValues} to determine whether there were some values added,
29 * or if the batch was determined to be complete and no additional values
30 * were provided during the last call to {@code setValues}.
31 *
32 * <p>Consider extending the
33 * {@link org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter}
34 * base class instead of implementing this interface directly, using a single
35 * {@code setValuesIfAvailable} callback method that checks for available
36 * values and sets them, returning whether values have actually been provided.
37 *
38 * @author Thomas Risberg
39 * @author Juergen Hoeller
40 * @since 2.0
41 * @see JdbcTemplate#batchUpdate(String, BatchPreparedStatementSetter)
42 * @see org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter
43 */
44 public interface InterruptibleBatchPreparedStatementSetter extends BatchPreparedStatementSetter {
45
46 /**
47 * Return whether the batch is complete, that is, whether there were no
48 * additional values added during the last {@code setValues} call.
49 * <p><b>NOTE:</b> If this method returns {@code true}, any parameters
50 * that might have been set during the last {@code setValues} call will
51 * be ignored! Make sure that you set a corresponding internal flag if you
52 * detect exhaustion <i>at the beginning</i> of your {@code setValues}
53 * implementation, letting this method return {@code true} based on the flag.
54 * @param i index of the statement we're issuing in the batch, starting from 0
55 * @return whether the batch is already exhausted
56 * @see #setValues
57 * @see org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter#setValuesIfAvailable
58 */
59 boolean isBatchExhausted(int i);
60
61 }