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.codegen;
17  
18  /**
19   * This class exists to that Java client generators can specify whether
20   * an XML generator is required to match the methods in the
21   * Java client.  For example, a Java client built entirely with
22   * annotations does not need matching XML.
23   * 
24   * @author Jeff Butler
25   *
26   */
27  public abstract class AbstractJavaClientGenerator extends AbstractJavaGenerator {
28  
29      private boolean requiresXMLGenerator;
30      
31      public AbstractJavaClientGenerator(boolean requiresXMLGenerator) {
32          super();
33          this.requiresXMLGenerator = requiresXMLGenerator;
34      }
35  
36      /**
37       * @return true if matching XML is required
38       */
39      public boolean requiresXMLGenerator() {
40          return requiresXMLGenerator;
41      }
42      
43      /**
44       * This method returns an instance of the XML generator associated
45       * with this client generator.
46       * 
47       * @return the matched XML generator.  May return null if no
48       * XML is required by this generator
49       */
50      public abstract AbstractXmlGenerator getMatchedXMLGenerator();
51  }