View Javadoc
1   /**
2    *    Copyright 2006-2016 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  package org.mybatis.generator.api;
17  
18  import java.util.List;
19  import java.util.Properties;
20  
21  import org.mybatis.generator.api.dom.java.Field;
22  import org.mybatis.generator.api.dom.java.Interface;
23  import org.mybatis.generator.api.dom.java.Method;
24  import org.mybatis.generator.api.dom.java.TopLevelClass;
25  import org.mybatis.generator.api.dom.xml.Document;
26  import org.mybatis.generator.api.dom.xml.XmlElement;
27  import org.mybatis.generator.config.Context;
28  
29  /**
30   * This class includes no-operation methods for almost every method in the
31   * Plugin interface. Clients may extend this class to implement some or all of
32   * the methods in a plugin.
33   * <p>
34   * This adapter does not implement the <tt>validate</tt> method - all plugins
35   * must perform validation.
36   * 
37   * @author Jeff Butler
38   * 
39   */
40  public abstract class PluginAdapter implements Plugin {
41      protected Context context;
42      protected Properties properties;
43  
44      public PluginAdapter() {
45          properties = new Properties();
46      }
47  
48      public Context getContext() {
49          return context;
50      }
51  
52      public void setContext(Context context) {
53          this.context = context;
54      }
55  
56      public Properties getProperties() {
57          return properties;
58      }
59  
60      public void setProperties(Properties properties) {
61          this.properties.putAll(properties);
62      }
63  
64      public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles() {
65          return null;
66      }
67  
68      public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(
69              IntrospectedTable introspectedTable) {
70          return null;
71      }
72  
73      public List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles() {
74          return null;
75      }
76  
77      public List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles(
78              IntrospectedTable introspectedTable) {
79          return null;
80      }
81  
82      public boolean clientCountByExampleMethodGenerated(Method method,
83              Interface interfaze, IntrospectedTable introspectedTable) {
84          return true;
85      }
86  
87      public boolean clientCountByExampleMethodGenerated(Method method,
88              TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
89          return true;
90      }
91  
92      public boolean clientDeleteByExampleMethodGenerated(Method method,
93              Interface interfaze, IntrospectedTable introspectedTable) {
94          return true;
95      }
96  
97      public boolean clientDeleteByExampleMethodGenerated(Method method,
98              TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
99          return true;
100     }
101 
102     public boolean clientDeleteByPrimaryKeyMethodGenerated(Method method,
103             Interface interfaze, IntrospectedTable introspectedTable) {
104         return true;
105     }
106 
107     public boolean clientDeleteByPrimaryKeyMethodGenerated(Method method,
108             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
109         return true;
110     }
111 
112     public boolean clientInsertMethodGenerated(Method method, Interface interfaze,
113             IntrospectedTable introspectedTable) {
114         return true;
115     }
116 
117     public boolean clientInsertMethodGenerated(Method method,
118             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
119         return true;
120     }
121 
122     public boolean clientGenerated(Interface interfaze,
123             TopLevelClass topLevelClass,
124             IntrospectedTable introspectedTable) {
125         return true;
126     }
127 
128     public boolean clientSelectByExampleWithBLOBsMethodGenerated(Method method,
129             Interface interfaze, IntrospectedTable introspectedTable) {
130         return true;
131     }
132 
133     public boolean clientSelectByExampleWithBLOBsMethodGenerated(Method method,
134             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
135         return true;
136     }
137 
138     public boolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method,
139             Interface interfaze, IntrospectedTable introspectedTable) {
140         return true;
141     }
142 
143     public boolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method,
144             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
145         return true;
146     }
147 
148     public boolean clientSelectByPrimaryKeyMethodGenerated(Method method,
149             Interface interfaze, IntrospectedTable introspectedTable) {
150         return true;
151     }
152 
153     public boolean clientSelectByPrimaryKeyMethodGenerated(Method method,
154             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
155         return true;
156     }
157 
158     public boolean clientUpdateByExampleSelectiveMethodGenerated(Method method,
159             Interface interfaze, IntrospectedTable introspectedTable) {
160         return true;
161     }
162 
163     public boolean clientUpdateByExampleSelectiveMethodGenerated(Method method,
164             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
165         return true;
166     }
167 
168     public boolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method,
169             Interface interfaze, IntrospectedTable introspectedTable) {
170         return true;
171     }
172 
173     public boolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method,
174             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
175         return true;
176     }
177 
178     public boolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
179             Interface interfaze, IntrospectedTable introspectedTable) {
180         return true;
181     }
182 
183     public boolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
184             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
185         return true;
186     }
187 
188     public boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
189             Interface interfaze, IntrospectedTable introspectedTable) {
190         return true;
191     }
192 
193     public boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
194             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
195         return true;
196     }
197 
198     public boolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
199             Interface interfaze, IntrospectedTable introspectedTable) {
200         return true;
201     }
202 
203     public boolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
204             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
205         return true;
206     }
207 
208     public boolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(
209             Method method, Interface interfaze,
210             IntrospectedTable introspectedTable) {
211         return true;
212     }
213 
214     public boolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(
215             Method method, TopLevelClass topLevelClass,
216             IntrospectedTable introspectedTable) {
217         return true;
218     }
219 
220     public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
221             IntrospectedTable introspectedTable) {
222         return true;
223     }
224 
225     public boolean modelExampleClassGenerated(TopLevelClass topLevelClass,
226             IntrospectedTable introspectedTable) {
227         return true;
228     }
229 
230     public boolean modelFieldGenerated(Field field,
231             TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn,
232             IntrospectedTable introspectedTable,
233             Plugin.ModelClassType modelClassType) {
234         return true;
235     }
236 
237     public boolean modelGetterMethodGenerated(Method method,
238             TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn,
239             IntrospectedTable introspectedTable,
240             Plugin.ModelClassType modelClassType) {
241         return true;
242     }
243 
244     public boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass,
245             IntrospectedTable introspectedTable) {
246         return true;
247     }
248 
249     public boolean modelRecordWithBLOBsClassGenerated(
250             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
251         return true;
252     }
253 
254     public boolean modelSetterMethodGenerated(Method method,
255             TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn,
256             IntrospectedTable introspectedTable,
257             Plugin.ModelClassType modelClassType) {
258         return true;
259     }
260 
261     public boolean sqlMapResultMapWithoutBLOBsElementGenerated(
262             XmlElement element, IntrospectedTable introspectedTable) {
263         return true;
264     }
265 
266     public boolean sqlMapCountByExampleElementGenerated(XmlElement element,
267             IntrospectedTable introspectedTable) {
268         return true;
269     }
270 
271     public boolean sqlMapDeleteByExampleElementGenerated(XmlElement element,
272             IntrospectedTable introspectedTable) {
273         return true;
274     }
275 
276     public boolean sqlMapDeleteByPrimaryKeyElementGenerated(XmlElement element,
277             IntrospectedTable introspectedTable) {
278         return true;
279     }
280 
281     public boolean sqlMapDocumentGenerated(Document document,
282             IntrospectedTable introspectedTable) {
283         return true;
284     }
285 
286     public boolean sqlMapExampleWhereClauseElementGenerated(XmlElement element,
287             IntrospectedTable introspectedTable) {
288         return true;
289     }
290 
291     public boolean sqlMapGenerated(GeneratedXmlFile sqlMap,
292             IntrospectedTable introspectedTable) {
293         return true;
294     }
295 
296     public boolean sqlMapInsertElementGenerated(XmlElement element,
297             IntrospectedTable introspectedTable) {
298         return true;
299     }
300 
301     public boolean sqlMapResultMapWithBLOBsElementGenerated(XmlElement element,
302             IntrospectedTable introspectedTable) {
303         return true;
304     }
305 
306     public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(
307             XmlElement element, IntrospectedTable introspectedTable) {
308         return true;
309     }
310 
311     public boolean sqlMapSelectByExampleWithBLOBsElementGenerated(
312             XmlElement element, IntrospectedTable introspectedTable) {
313         return true;
314     }
315 
316     public boolean sqlMapSelectByPrimaryKeyElementGenerated(XmlElement element,
317             IntrospectedTable introspectedTable) {
318         return true;
319     }
320 
321     public boolean sqlMapUpdateByExampleSelectiveElementGenerated(
322             XmlElement element, IntrospectedTable introspectedTable) {
323         return true;
324     }
325 
326     public boolean sqlMapUpdateByExampleWithBLOBsElementGenerated(
327             XmlElement element, IntrospectedTable introspectedTable) {
328         return true;
329     }
330 
331     public boolean sqlMapUpdateByExampleWithoutBLOBsElementGenerated(
332             XmlElement element, IntrospectedTable introspectedTable) {
333         return true;
334     }
335 
336     public boolean sqlMapUpdateByPrimaryKeySelectiveElementGenerated(
337             XmlElement element, IntrospectedTable introspectedTable) {
338         return true;
339     }
340 
341     public boolean sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated(
342             XmlElement element, IntrospectedTable introspectedTable) {
343         return true;
344     }
345 
346     public boolean sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated(
347             XmlElement element, IntrospectedTable introspectedTable) {
348         return true;
349     }
350 
351     public boolean sqlMapInsertSelectiveElementGenerated(XmlElement element,
352             IntrospectedTable introspectedTable) {
353         return true;
354     }
355 
356     public boolean clientInsertSelectiveMethodGenerated(Method method,
357             Interface interfaze, IntrospectedTable introspectedTable) {
358         return true;
359     }
360 
361     public boolean clientInsertSelectiveMethodGenerated(Method method,
362             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
363         return true;
364     }
365 
366     public void initialized(IntrospectedTable introspectedTable) {
367     }
368 
369     public boolean sqlMapBaseColumnListElementGenerated(XmlElement element,
370             IntrospectedTable introspectedTable) {
371         return true;
372     }
373 
374     public boolean sqlMapBlobColumnListElementGenerated(XmlElement element,
375             IntrospectedTable introspectedTable) {
376         return true;
377     }
378 
379     public boolean providerGenerated(TopLevelClass topLevelClass,
380             IntrospectedTable introspectedTable) {
381         return true;
382     }
383 
384     public boolean providerApplyWhereMethodGenerated(Method method,
385             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
386         return true;
387     }
388 
389     public boolean providerCountByExampleMethodGenerated(Method method,
390             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
391         return true;
392     }
393 
394     public boolean providerDeleteByExampleMethodGenerated(Method method,
395             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
396         return true;
397     }
398 
399     public boolean providerInsertSelectiveMethodGenerated(Method method,
400             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
401         return true;
402     }
403 
404     public boolean providerSelectByExampleWithBLOBsMethodGenerated(
405             Method method, TopLevelClass topLevelClass,
406             IntrospectedTable introspectedTable) {
407         return true;
408     }
409 
410     public boolean providerSelectByExampleWithoutBLOBsMethodGenerated(
411             Method method, TopLevelClass topLevelClass,
412             IntrospectedTable introspectedTable) {
413         return true;
414     }
415 
416     public boolean providerUpdateByExampleSelectiveMethodGenerated(
417             Method method, TopLevelClass topLevelClass,
418             IntrospectedTable introspectedTable) {
419         return true;
420     }
421 
422     public boolean providerUpdateByExampleWithBLOBsMethodGenerated(
423             Method method, TopLevelClass topLevelClass,
424             IntrospectedTable introspectedTable) {
425         return true;
426     }
427 
428     public boolean providerUpdateByExampleWithoutBLOBsMethodGenerated(
429             Method method, TopLevelClass topLevelClass,
430             IntrospectedTable introspectedTable) {
431         return true;
432     }
433 
434     public boolean providerUpdateByPrimaryKeySelectiveMethodGenerated(
435             Method method, TopLevelClass topLevelClass,
436             IntrospectedTable introspectedTable) {
437         return true;
438     }
439 
440     public boolean clientSelectAllMethodGenerated(Method method,
441             Interface interfaze, IntrospectedTable introspectedTable) {
442         return true;
443     }
444 
445     public boolean clientSelectAllMethodGenerated(Method method,
446             TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
447         return true;
448     }
449 
450     public boolean sqlMapSelectAllElementGenerated(XmlElement element,
451             IntrospectedTable introspectedTable) {
452         return true;
453     }
454 }