1 /*
2 * Copyright 2016-2025 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 * https://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 package org.mybatis.dynamic.sql.util.mybatis3;
17
18 import org.apache.ibatis.annotations.UpdateProvider;
19 import org.mybatis.dynamic.sql.update.render.UpdateStatementProvider;
20 import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
21
22 /**
23 * This is a general purpose MyBatis mapper for update statements.
24 *
25 * <p>This mapper can be injected as-is into a MyBatis configuration, or it can be extended with existing mappers.
26 *
27 * @author Jeff Butler
28 */
29 public interface CommonUpdateMapper {
30 /**
31 * Execute an update statement.
32 *
33 * @param updateStatement
34 * the update statement
35 *
36 * @return the number of rows affected
37 */
38 @UpdateProvider(type = SqlProviderAdapter.class, method = "update")
39 int update(UpdateStatementProvider updateStatement);
40 }