Package org.mybatis.generator.codegen

Class AbstractJavaClientGenerator

java.lang.Object

org.mybatis.generator.codegen.AbstractGenerator

org.mybatis.generator.codegen.AbstractJavaGenerator

org.mybatis.generator.codegen.AbstractJavaClientGenerator

Direct Known Subclasses:

DynamicSqlMapperGenerator, JavaMapperGenerator, SimpleJavaClientGenerator

public abstract class AbstractJavaClientGenerator
extends AbstractJavaGenerator

This class exists to that Java client generators can specify whether an XML generator is required to match the methods in the Java client. For example, a Java client built entirely with annotations does not need matching XML.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	requiresXMLGenerator

Fields inherited from class org.mybatis.generator.codegen.AbstractGenerator

context, introspectedTable, progressCallback, warnings

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJavaClientGenerator(String project, boolean requiresXMLGenerator)

Method Summary

Modifier and Type	Method	Description
abstract AbstractXmlGenerator	getMatchedXMLGenerator()	Returns an instance of the XML generator associated with this client generator.
boolean	requiresXMLGenerator()	Returns true is a matching XML generator is required.

Methods inherited from class org.mybatis.generator.codegen.AbstractJavaGenerator

addDefaultConstructor, addDefaultConstructorWithGeneratedAnnotatoin, getCompilationUnits, getGetter, getProject, getRootClass

Methods inherited from class org.mybatis.generator.codegen.AbstractGenerator

setContext, setIntrospectedTable, setProgressCallback, setWarnings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

requiresXMLGenerator

private final boolean requiresXMLGenerator

Constructor Details

AbstractJavaClientGenerator

protected AbstractJavaClientGenerator(String project,
 boolean requiresXMLGenerator)

Method Details

requiresXMLGenerator

public boolean requiresXMLGenerator()

Returns true is a matching XML generator is required.

Returns:

true if matching XML is generator required

getMatchedXMLGenerator

public abstract AbstractXmlGenerator getMatchedXMLGenerator()

Returns an instance of the XML generator associated with this client generator.

Returns:

the matched XML generator. May return null if no XML is required by this generator