View Javadoc
1   /*
2    *    Copyright 2006-2026 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.api;
17  
18  import java.util.Properties;
19  
20  import org.mybatis.generator.config.Context;
21  
22  /**
23   * This class is a convenient base class for implementing plugins.
24   *
25   * <p>This adapter does not implement the <code>validate</code> method - all plugins
26   * must perform validation.
27   *
28   * @author Jeff Butler
29   */
30  public abstract class PluginAdapter implements Plugin {
31      protected Context context;
32      protected final Properties properties = new Properties();
33      protected CommentGenerator commentGenerator;
34      protected KnownRuntime knownRuntime;
35  
36      protected PluginAdapter() {
37      }
38  
39      @Override
40      public void setContext(Context context) {
41          this.context = context;
42      }
43  
44      @Override
45      public void setProperties(Properties properties) {
46          this.properties.putAll(properties);
47      }
48  
49      @Override
50      public void setCommentGenerator(CommentGenerator commentGenerator) {
51          this.commentGenerator = commentGenerator;
52      }
53  
54      @Override
55      public void setKnownRuntime(KnownRuntime knownRuntime) {
56          this.knownRuntime = knownRuntime;
57      }
58  }