View Javadoc
1   /*
2    *    Copyright 2006-2023 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.generator.codegen.mybatis3.javamapper.elements;
17  
18  import java.util.Set;
19  import java.util.TreeSet;
20  
21  import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
22  import org.mybatis.generator.api.dom.java.Interface;
23  import org.mybatis.generator.api.dom.java.JavaVisibility;
24  import org.mybatis.generator.api.dom.java.Method;
25  
26  public class DeleteByPrimaryKeyMethodGenerator extends AbstractJavaMapperMethodGenerator {
27  
28      private final boolean isSimple;
29  
30      public DeleteByPrimaryKeyMethodGenerator(boolean isSimple) {
31          super();
32          this.isSimple = isSimple;
33      }
34  
35      @Override
36      public void addInterfaceElements(Interface interfaze) {
37          Method method = new Method(introspectedTable.getDeleteByPrimaryKeyStatementId());
38          method.setVisibility(JavaVisibility.PUBLIC);
39          method.setAbstract(true);
40          method.setReturnType(FullyQualifiedJavaType.getIntInstance());
41  
42          Set<FullyQualifiedJavaType> importedTypes = new TreeSet<>();
43          addPrimaryKeyMethodParameters(isSimple, method, importedTypes);
44  
45          addMapperAnnotations(method);
46  
47          context.getCommentGenerator().addGeneralMethodComment(method, introspectedTable);
48  
49          if (context.getPlugins().clientDeleteByPrimaryKeyMethodGenerated(method, interfaze, introspectedTable)) {
50              addExtraImports(interfaze);
51              interfaze.addImportedTypes(importedTypes);
52              interfaze.addMethod(method);
53          }
54      }
55  
56      public void addMapperAnnotations(Method method) {
57          // extension point for subclasses
58      }
59  
60      public void addExtraImports(Interface interfaze) {
61          // extension point for subclasses
62      }
63  }