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  /**
27   * The selectAll method is only generated by the Mybatis3Simple runtime.
28   *
29   * @author Jeff Butler
30   */
31  public class SelectAllMethodGenerator extends AbstractJavaMapperMethodGenerator {
32  
33      public SelectAllMethodGenerator() {
34          super();
35      }
36  
37      @Override
38      public void addInterfaceElements(Interface interfaze) {
39          Set<FullyQualifiedJavaType> importedTypes = new TreeSet<>();
40          importedTypes.add(FullyQualifiedJavaType.getNewListInstance());
41  
42          Method method = new Method(introspectedTable.getSelectAllStatementId());
43          method.setVisibility(JavaVisibility.PUBLIC);
44          method.setAbstract(true);
45  
46          FullyQualifiedJavaType returnType = FullyQualifiedJavaType.getNewListInstance();
47          FullyQualifiedJavaType listType;
48          listType = new FullyQualifiedJavaType(introspectedTable.getBaseRecordType());
49  
50          importedTypes.add(listType);
51          returnType.addTypeArgument(listType);
52          method.setReturnType(returnType);
53  
54          context.getCommentGenerator().addGeneralMethodComment(method, introspectedTable);
55  
56          addMapperAnnotations(interfaze, method);
57  
58          if (context.getPlugins().clientSelectAllMethodGenerated(method, interfaze, introspectedTable)) {
59              addExtraImports(interfaze);
60              interfaze.addImportedTypes(importedTypes);
61              interfaze.addMethod(method);
62          }
63      }
64  
65      public void addMapperAnnotations(Interface interfaze, Method method) {
66          // extension point for subclasses
67      }
68  
69      public void addExtraImports(Interface interfaze) {
70          // extension point for subclasses
71      }
72  }