Package org.mybatis.generator.api
Class CompositePlugin
java.lang.Object
org.mybatis.generator.api.CompositePlugin
- All Implemented Interfaces:
Plugin
- Direct Known Subclasses:
PluginAggregator
,ReadOnlyPlugin
This class implements a composite plugin. It contains a list of plugins for the
current context and is used to aggregate plugins together. This class
implements the rule that if any plugin returns "false" from a method, then no
subsequent plugin is called.
- Author:
- Jeff Butler
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.mybatis.generator.api.Plugin
Plugin.ModelClassType
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
boolean
clientBasicInsertMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the insert method has been generated for the mapper interface.boolean
clientBasicInsertMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) This method is called when the insert function has been generated for the mapper interface.boolean
clientBasicInsertMultipleMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the insert multiple method has been generated for the mapper interface.boolean
clientBasicInsertMultipleMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) This method is called when the insert multiple method has been generated for the mapper interface.boolean
clientBasicSelectManyMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the selectMany method has been generated for the mapper interface.boolean
clientBasicSelectManyMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientBasicSelectOneMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the selectOne method has been generated for the mapper interface.boolean
clientBasicSelectOneMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientColumnListPropertyGenerated
(KotlinProperty kotlinProperty, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientCountByExampleMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the countByExample method has been generated in the client interface.boolean
clientDeleteByExampleMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the deleteByExample method has been generated in the client interface.boolean
clientDeleteByPrimaryKeyMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the deleteByPrimaryKey method has been generated in the client interface.boolean
clientDeleteByPrimaryKeyMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientGeneralCountMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) Called when the general count method has been generated.boolean
clientGeneralCountMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientGeneralDeleteMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) Called when the general delete method has been generated.boolean
clientGeneralDeleteMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientGeneralSelectDistinctMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) Called when the general select distinct method has been generated.boolean
clientGeneralSelectDistinctMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientGeneralSelectMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) Called when the general select method has been generated.boolean
clientGeneralSelectMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientGeneralUpdateMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) Called when the general update method has been generated.boolean
clientGeneralUpdateMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientGenerated
(Interface interfaze, IntrospectedTable introspectedTable) This method is called when the entire client has been generated.boolean
clientInsertMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the insert method has been generated in the client interface.boolean
clientInsertMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientInsertMultipleMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the insert multiple method has been generated in the client interface.boolean
clientInsertMultipleMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientInsertMultipleVarargMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientInsertSelectiveMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the insert selective method has been generated in the client interface.boolean
clientInsertSelectiveMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientSelectAllMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the selectAll method has been generated in the client interface.boolean
clientSelectByExampleWithBLOBsMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the selectByExampleWithBLOBs method has been generated in the client interface.boolean
clientSelectByExampleWithoutBLOBsMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the selectByExampleWithoutBLOBs method has been generated in the client interface.boolean
clientSelectByPrimaryKeyMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the selectByPrimaryKey method has been generated in the client interface.boolean
clientSelectByPrimaryKeyMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientSelectListFieldGenerated
(Field field, Interface interfaze, IntrospectedTable introspectedTable) Called when the selectList field is generated in a MyBatis Dynamic SQL V2 runtime.boolean
clientSelectOneMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) Called when the selectOne method is generated.boolean
clientSelectOneMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientUpdateAllColumnsMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) Called when the updateAllColumns method is generated.boolean
clientUpdateAllColumnsMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientUpdateByExampleSelectiveMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByExampleSelective method has been generated in the client interface.boolean
clientUpdateByExampleWithBLOBsMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithBLOBs method has been generated in the client interface.boolean
clientUpdateByExampleWithoutBLOBsMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithoutBLOBs method has been generated in the client interface.boolean
clientUpdateByPrimaryKeyMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) The motivation for adding this method can be found in https://github.com/mybatis/generator/issues/1116 This method is called when the updateByPrimaryKey method has been generated in the dynamic SQL runtime client interface.boolean
clientUpdateByPrimaryKeyMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientUpdateByPrimaryKeySelectiveMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeySelective method has been generated in the client interface.boolean
clientUpdateByPrimaryKeySelectiveMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) boolean
clientUpdateByPrimaryKeyWithBLOBsMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the client interface.boolean
clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the client interface.boolean
clientUpdateSelectiveColumnsMethodGenerated
(Method method, Interface interfaze, IntrospectedTable introspectedTable) Called when the updateSelectiveColumns method is generated.boolean
clientUpdateSelectiveColumnsMethodGenerated
(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) contextGenerateAdditionalFiles
(IntrospectedTable introspectedTable) This method can be used to generate any additional Java file needed by your implementation.contextGenerateAdditionalJavaFiles
(IntrospectedTable introspectedTable) This method can be used to generate additional Java files needed by your implementation that might be related to a specific table.contextGenerateAdditionalKotlinFiles
(IntrospectedTable introspectedTable) This method can be used to generate any additional XML file needed by your implementation.contextGenerateAdditionalXmlFiles
(IntrospectedTable introspectedTable) This method can be used to generate additional XML files needed by your implementation that might be related to a specific table.boolean
dynamicSqlSupportGenerated
(TopLevelClass supportClass, IntrospectedTable introspectedTable) This method is called when the MyBatis Dynamic SQL support class has been generated in the MyBatis Dynamic SQL runtime.boolean
dynamicSqlSupportGenerated
(KotlinFile kotlinFile, KotlinType outerSupportObject, KotlinType innerSupportClass, IntrospectedTable introspectedTable) This method is called when the MyBatis Dynamic SQL support object has been generated.void
initialized
(IntrospectedTable introspectedTable) This method is called just before the getGeneratedXXXFiles methods are called on the introspected table.boolean
kotlinDataClassGenerated
(KotlinFile kotlinFile, KotlinType dataClass, IntrospectedTable introspectedTable) boolean
mapperGenerated
(KotlinFile mapperFile, KotlinType mapper, IntrospectedTable introspectedTable) boolean
modelBaseRecordClassGenerated
(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called after the base record class is generated by the JavaModelGenerator.boolean
modelExampleClassGenerated
(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called after the example class is generated by the JavaModelGenerator.boolean
modelFieldGenerated
(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType) This method is called after the field is generated for a specific column in a table.boolean
modelGetterMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType) This method is called after the getter, or accessor, method is generated for a specific column in a table.boolean
modelPrimaryKeyClassGenerated
(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called after the primary key class is generated by the JavaModelGenerator.boolean
modelRecordWithBLOBsClassGenerated
(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called after the record with BLOBs class is generated by the JavaModelGenerator.boolean
modelSetterMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType) This method is called after the setter, or mutator, method is generated for a specific column in a table.boolean
providerApplyWhereMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the applyWhere method has been generated in the SQL provider.boolean
providerCountByExampleMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the countByExample method has been generated in the SQL provider.boolean
providerDeleteByExampleMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the deleteByExample method has been generated in the SQL provider.boolean
providerGenerated
(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the SQL provider has been generated.boolean
providerInsertSelectiveMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the insertSelective method has been generated in the SQL provider.boolean
providerSelectByExampleWithBLOBsMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the selectByExampleWithBLOBs method has been generated in the SQL provider.boolean
providerSelectByExampleWithoutBLOBsMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the selectByExampleWithoutBLOBs method has been generated in the SQL provider.boolean
providerUpdateByExampleSelectiveMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByExampleSelective method has been generated in the SQL provider.boolean
providerUpdateByExampleWithBLOBsMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithBLOBs method has been generated in the SQL provider.boolean
providerUpdateByExampleWithoutBLOBsMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithoutBLOBs method has been generated in the SQL provider.boolean
providerUpdateByPrimaryKeySelectiveMethodGenerated
(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeySelective method has been generated in the SQL provider.void
setContext
(Context context) Set the context under which this plugin is running.void
setProperties
(Properties properties) Set properties from the plugin configuration.boolean
shouldGenerate
(IntrospectedTable introspectedTable) If false, the table will be skipped in code generation.boolean
sqlMapBaseColumnListElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the baseColumnList element is generated.boolean
sqlMapBlobColumnListElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the blobColumnList element is generated.boolean
sqlMapCountByExampleElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the countByExample element is generated.boolean
sqlMapDeleteByExampleElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the deleteByExample element is generated.boolean
sqlMapDeleteByPrimaryKeyElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the deleteByPrimaryKey element is generated.boolean
sqlMapDocumentGenerated
(Document document, IntrospectedTable introspectedTable) This method is called when the SqlMap document has been generated.boolean
sqlMapExampleWhereClauseElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the exampleWhereClause element is generated.boolean
sqlMapGenerated
(GeneratedXmlFile sqlMap, IntrospectedTable introspectedTable) This method is called when the SqlMap file has been generated.boolean
sqlMapInsertElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the insert element is generated.boolean
sqlMapInsertSelectiveElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the insert selective element is generated.boolean
sqlMapResultMapWithBLOBsElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the resultMap with BLOBs element is generated - this resultMap will extend the base resultMap.boolean
sqlMapResultMapWithoutBLOBsElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the base resultMap is generated.boolean
sqlMapSelectAllElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the selectAll element is generated.boolean
sqlMapSelectByExampleWithBLOBsElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the selectByExampleWithBLOBs element is generated.boolean
sqlMapSelectByExampleWithoutBLOBsElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the selectByExample element is generated.boolean
sqlMapSelectByPrimaryKeyElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the selectByPrimaryKey element is generated.boolean
sqlMapUpdateByExampleSelectiveElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the updateByExampleSelective element is generated.boolean
sqlMapUpdateByExampleWithBLOBsElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithBLOBs element is generated.boolean
sqlMapUpdateByExampleWithoutBLOBsElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithourBLOBs element is generated.boolean
sqlMapUpdateByPrimaryKeySelectiveElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeySelective element is generated.boolean
sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeyWithBLOBs element is generated.boolean
sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated
(XmlElement element, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeyWithoutBLOBs element is generated.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.mybatis.generator.api.Plugin
clientBasicCountMethodGenerated, clientBasicCountMethodGenerated, clientBasicDeleteMethodGenerated, clientBasicDeleteMethodGenerated, clientBasicInsertMultipleHelperMethodGenerated, clientBasicInsertMultipleHelperMethodGenerated, clientBasicUpdateMethodGenerated, clientBasicUpdateMethodGenerated, mapperExtensionsGenerated, validate
-
Constructor Details
-
CompositePlugin
protected CompositePlugin()
-
-
Method Details
-
addPlugin
-
setContext
Description copied from interface:Plugin
Set the context under which this plugin is running.- Specified by:
setContext
in interfacePlugin
- Parameters:
context
- the new context
-
setProperties
Description copied from interface:Plugin
Set properties from the plugin configuration.- Specified by:
setProperties
in interfacePlugin
- Parameters:
properties
- the new properties
-
initialized
Description copied from interface:Plugin
This method is called just before the getGeneratedXXXFiles methods are called on the introspected table. Plugins can implement this method to override any of the default attributes, or change the results of database introspection, before any code generation activities occur. Attributes are listed as static Strings with the prefix ATTR_ in IntrospectedTable.A good example of overriding an attribute would be the case where a user wanted to change the name of one of the generated classes, change the target package, or change the name of the generated SQL map file.
Warning: Anything that is listed as an attribute should not be changed by one of the other plugin methods. For example, if you want to change the name of a generated example class, you should not simply change the Type in the
modelExampleClassGenerated()
method. If you do, the change will not be reflected in other generated artifacts.- Specified by:
initialized
in interfacePlugin
- Parameters:
introspectedTable
- the introspected table
-
contextGenerateAdditionalJavaFiles
Description copied from interface:Plugin
This method can be used to generate any additional Java file needed by your implementation. This method is called once, after all other Java files have been generated.- Specified by:
contextGenerateAdditionalJavaFiles
in interfacePlugin
- Returns:
- a List of GeneratedJavaFiles - these files will be saved with the other files from this run.
-
contextGenerateAdditionalJavaFiles
public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method can be used to generate additional Java files needed by your implementation that might be related to a specific table. This method is called once for every table in the configuration.- Specified by:
contextGenerateAdditionalJavaFiles
in interfacePlugin
- Parameters:
introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- a List of GeneratedJavaFiles - these files will be saved with the other files from this run.
-
contextGenerateAdditionalKotlinFiles
- Specified by:
contextGenerateAdditionalKotlinFiles
in interfacePlugin
-
contextGenerateAdditionalKotlinFiles
public List<GeneratedKotlinFile> contextGenerateAdditionalKotlinFiles(IntrospectedTable introspectedTable) - Specified by:
contextGenerateAdditionalKotlinFiles
in interfacePlugin
-
contextGenerateAdditionalFiles
- Specified by:
contextGenerateAdditionalFiles
in interfacePlugin
-
contextGenerateAdditionalFiles
- Specified by:
contextGenerateAdditionalFiles
in interfacePlugin
-
contextGenerateAdditionalXmlFiles
Description copied from interface:Plugin
This method can be used to generate any additional XML file needed by your implementation. This method is called once, after all other XML files have been generated.- Specified by:
contextGenerateAdditionalXmlFiles
in interfacePlugin
- Returns:
- a List of GeneratedXmlFiles - these files will be saved with the other files from this run.
-
contextGenerateAdditionalXmlFiles
public List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles(IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method can be used to generate additional XML files needed by your implementation that might be related to a specific table. This method is called once for every table in the configuration.- Specified by:
contextGenerateAdditionalXmlFiles
in interfacePlugin
- Parameters:
introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- a List of GeneratedXmlFiles - these files will be saved with the other files from this run.
-
clientGenerated
Description copied from interface:Plugin
This method is called when the entire client has been generated. Implement this method to add additional methods or fields to a generated client interface or implementation.- Specified by:
clientGenerated
in interfacePlugin
- Parameters:
interfaze
- the generated interface if any, may be nullintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the interface should be generated, false if the generated interface should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientBasicInsertMethodGenerated
public boolean clientBasicInsertMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insert method has been generated for the mapper interface. This method is only called in the MyBatis3DynamicSql runtime. This method is only called if the table has generated keys.- Specified by:
clientBasicInsertMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated insert methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientBasicInsertMethodGenerated
public boolean clientBasicInsertMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insert function has been generated for the mapper interface. This method is only called in the MyBatis3Kotlin runtime. This method is only called if the table has generated keys.- Specified by:
clientBasicInsertMethodGenerated
in interfacePlugin
- Parameters:
kotlinFunction
- the generated insert functionkotlinFile
- the partially generated fileintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the function should be generated, false if the generated function should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientBasicInsertMultipleMethodGenerated
public boolean clientBasicInsertMultipleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insert multiple method has been generated for the mapper interface. This method is only called in the MyBatis3DynamicSql runtime. This method is only called if the table has generated keys.- Specified by:
clientBasicInsertMultipleMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated insert methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientBasicInsertMultipleMethodGenerated
public boolean clientBasicInsertMultipleMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insert multiple method has been generated for the mapper interface. This method is only called in the MyBatis3DynamicSql runtime. This method is only called if the table has generated keys.- Specified by:
clientBasicInsertMultipleMethodGenerated
in interfacePlugin
- Parameters:
kotlinFunction
- the generated insert functionkotlinFile
- the partially generated fileintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated function should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientBasicSelectManyMethodGenerated
public boolean clientBasicSelectManyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectMany method has been generated for the mapper interface. This method is only called in the MyBatis3DynamicSql runtime.- Specified by:
clientBasicSelectManyMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated selectMany methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientBasicSelectManyMethodGenerated
public boolean clientBasicSelectManyMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientBasicSelectManyMethodGenerated
in interfacePlugin
-
clientBasicSelectOneMethodGenerated
public boolean clientBasicSelectOneMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectOne method has been generated for the mapper interface. This method is only called in the MyBatis3DynamicSql runtime.- Specified by:
clientBasicSelectOneMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated selectOne methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientBasicSelectOneMethodGenerated
public boolean clientBasicSelectOneMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientBasicSelectOneMethodGenerated
in interfacePlugin
-
clientCountByExampleMethodGenerated
public boolean clientCountByExampleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the countByExample method has been generated in the client interface.- Specified by:
clientCountByExampleMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated countByExample methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientDeleteByExampleMethodGenerated
public boolean clientDeleteByExampleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the deleteByExample method has been generated in the client interface.- Specified by:
clientDeleteByExampleMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated deleteByExample methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientDeleteByPrimaryKeyMethodGenerated
public boolean clientDeleteByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the deleteByPrimaryKey method has been generated in the client interface.- Specified by:
clientDeleteByPrimaryKeyMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated deleteByPrimaryKey methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientDeleteByPrimaryKeyMethodGenerated
public boolean clientDeleteByPrimaryKeyMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientDeleteByPrimaryKeyMethodGenerated
in interfacePlugin
-
clientGeneralCountMethodGenerated
public boolean clientGeneralCountMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
Called when the general count method has been generated. This is the replacement for countByExample in the MyBatis Dynamic SQL V2 runtime.- Specified by:
clientGeneralCountMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated general count methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated
-
clientGeneralCountMethodGenerated
public boolean clientGeneralCountMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientGeneralCountMethodGenerated
in interfacePlugin
-
clientGeneralDeleteMethodGenerated
public boolean clientGeneralDeleteMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
Called when the general delete method has been generated. This is the replacement for deleteByExample in the MyBatis Dynamic SQL V2 runtime.- Specified by:
clientGeneralDeleteMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated general delete methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated
-
clientGeneralDeleteMethodGenerated
public boolean clientGeneralDeleteMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientGeneralDeleteMethodGenerated
in interfacePlugin
-
clientGeneralSelectDistinctMethodGenerated
public boolean clientGeneralSelectDistinctMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
Called when the general select distinct method has been generated. This is the replacement for selectDistinctByExample in the MyBatis Dynamic SQL V2 runtime.- Specified by:
clientGeneralSelectDistinctMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated general select distinct methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated
-
clientGeneralSelectDistinctMethodGenerated
public boolean clientGeneralSelectDistinctMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientGeneralSelectDistinctMethodGenerated
in interfacePlugin
-
clientGeneralSelectMethodGenerated
public boolean clientGeneralSelectMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
Called when the general select method has been generated. This is the replacement for selectByExample in the MyBatis Dynamic SQL V2 runtime.- Specified by:
clientGeneralSelectMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated general select methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated
-
clientGeneralSelectMethodGenerated
public boolean clientGeneralSelectMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientGeneralSelectMethodGenerated
in interfacePlugin
-
clientGeneralUpdateMethodGenerated
public boolean clientGeneralUpdateMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
Called when the general update method has been generated. This is the replacement for updateByExample in the MyBatis Dynamic SQL V2 runtime.- Specified by:
clientGeneralUpdateMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated general update methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated
-
clientGeneralUpdateMethodGenerated
public boolean clientGeneralUpdateMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientGeneralUpdateMethodGenerated
in interfacePlugin
-
clientInsertMethodGenerated
public boolean clientInsertMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insert method has been generated in the client interface.- Specified by:
clientInsertMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated insert methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientInsertMethodGenerated
public boolean clientInsertMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientInsertMethodGenerated
in interfacePlugin
-
clientInsertMultipleMethodGenerated
public boolean clientInsertMultipleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insert multiple method has been generated in the client interface. This method is only called in the MyBatis3DynamicSql runtime.- Specified by:
clientInsertMultipleMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated insert multiple methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientInsertMultipleMethodGenerated
public boolean clientInsertMultipleMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientInsertMultipleMethodGenerated
in interfacePlugin
-
clientInsertSelectiveMethodGenerated
public boolean clientInsertSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insert selective method has been generated in the client interface.- Specified by:
clientInsertSelectiveMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated insert methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientInsertSelectiveMethodGenerated
public boolean clientInsertSelectiveMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientInsertSelectiveMethodGenerated
in interfacePlugin
-
clientSelectByExampleWithBLOBsMethodGenerated
public boolean clientSelectByExampleWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectByExampleWithBLOBs method has been generated in the client interface.- Specified by:
clientSelectByExampleWithBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated selectByExampleWithBLOBs methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientSelectByExampleWithoutBLOBsMethodGenerated
public boolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectByExampleWithoutBLOBs method has been generated in the client interface.- Specified by:
clientSelectByExampleWithoutBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated selectByExampleWithoutBLOBs methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientSelectByPrimaryKeyMethodGenerated
public boolean clientSelectByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectByPrimaryKey method has been generated in the client interface.- Specified by:
clientSelectByPrimaryKeyMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated selectByPrimaryKey methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientSelectByPrimaryKeyMethodGenerated
public boolean clientSelectByPrimaryKeyMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientSelectByPrimaryKeyMethodGenerated
in interfacePlugin
-
clientSelectListFieldGenerated
public boolean clientSelectListFieldGenerated(Field field, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
Called when the selectList field is generated in a MyBatis Dynamic SQL V2 runtime.- Specified by:
clientSelectListFieldGenerated
in interfacePlugin
- Parameters:
field
- the generated selectList fieldinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the field should be generated
-
clientSelectOneMethodGenerated
public boolean clientSelectOneMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
Called when the selectOne method is generated. This is a new method in the MyBatis Dynamic SQL V2 runtime.- Specified by:
clientSelectOneMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated selectOne methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated
-
clientSelectOneMethodGenerated
public boolean clientSelectOneMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientSelectOneMethodGenerated
in interfacePlugin
-
clientUpdateByExampleSelectiveMethodGenerated
public boolean clientUpdateByExampleSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByExampleSelective method has been generated in the client interface.- Specified by:
clientUpdateByExampleSelectiveMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByExampleSelective methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientUpdateAllColumnsMethodGenerated
public boolean clientUpdateAllColumnsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
Called when the updateAllColumns method is generated. The generated method can be used with the general update method to mimic the function of the old updateByExample method.- Specified by:
clientUpdateAllColumnsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateAllColumns methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated
-
clientUpdateAllColumnsMethodGenerated
public boolean clientUpdateAllColumnsMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientUpdateAllColumnsMethodGenerated
in interfacePlugin
-
clientUpdateSelectiveColumnsMethodGenerated
public boolean clientUpdateSelectiveColumnsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
Called when the updateSelectiveColumns method is generated. The generated method can be used with the general update method to mimic the function of the old updateByExampleSelective method.- Specified by:
clientUpdateSelectiveColumnsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateSelectiveColumns methodinterfaze
- the partially generated mapper interfacesintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated
-
clientUpdateSelectiveColumnsMethodGenerated
public boolean clientUpdateSelectiveColumnsMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientUpdateSelectiveColumnsMethodGenerated
in interfacePlugin
-
clientUpdateByExampleWithBLOBsMethodGenerated
public boolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByExampleWithBLOBs method has been generated in the client interface.- Specified by:
clientUpdateByExampleWithBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByExampleWithBLOBs methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientUpdateByExampleWithoutBLOBsMethodGenerated
public boolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByExampleWithoutBLOBs method has been generated in the client interface.- Specified by:
clientUpdateByExampleWithoutBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByExampleWithoutBLOBs methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientUpdateByPrimaryKeySelectiveMethodGenerated
public boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByPrimaryKeySelective method has been generated in the client interface.- Specified by:
clientUpdateByPrimaryKeySelectiveMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByPrimaryKeySelective methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientUpdateByPrimaryKeySelectiveMethodGenerated
public boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientUpdateByPrimaryKeySelectiveMethodGenerated
in interfacePlugin
-
clientUpdateByPrimaryKeyWithBLOBsMethodGenerated
public boolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the client interface.- Specified by:
clientUpdateByPrimaryKeyWithBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByPrimaryKeyWithBLOBs methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated
public boolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the client interface.- Specified by:
clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByPrimaryKeyWithoutBLOBs methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
clientSelectAllMethodGenerated
public boolean clientSelectAllMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectAll method has been generated in the client interface. This method is only generated by the simple runtime.- Specified by:
clientSelectAllMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated selectAll methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
modelFieldGenerated
public boolean modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType) Description copied from interface:Plugin
This method is called after the field is generated for a specific column in a table.- Specified by:
modelFieldGenerated
in interfacePlugin
- Parameters:
field
- the field generated for the specified columntopLevelClass
- the partially implemented model class. You can add additional imported classes to the implementation class if necessary.introspectedColumn
- The class containing information about the column related to this field as introspected from the databaseintrospectedTable
- The class containing information about the table as introspected from the databasemodelClassType
- the type of class that the field is generated for- Returns:
- true if the field should be generated, false if the generated field should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
modelGetterMethodGenerated
public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType) Description copied from interface:Plugin
This method is called after the getter, or accessor, method is generated for a specific column in a table.- Specified by:
modelGetterMethodGenerated
in interfacePlugin
- Parameters:
method
- the getter, or accessor, method generated for the specified columntopLevelClass
- the partially implemented model class. You can add additional imported classes to the implementation class if necessary.introspectedColumn
- The class containing information about the column related to this field as introspected from the databaseintrospectedTable
- The class containing information about the table as introspected from the databasemodelClassType
- the type of class that the field is generated for- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
modelSetterMethodGenerated
public boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType) Description copied from interface:Plugin
This method is called after the setter, or mutator, method is generated for a specific column in a table.- Specified by:
modelSetterMethodGenerated
in interfacePlugin
- Parameters:
method
- the setter, or mutator, method generated for the specified columntopLevelClass
- the partially implemented model class. You can add additional imported classes to the implementation class if necessary.introspectedColumn
- The class containing information about the column related to this field as introspected from the databaseintrospectedTable
- The class containing information about the table as introspected from the databasemodelClassType
- the type of class that the field is generated for- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
modelPrimaryKeyClassGenerated
public boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called after the primary key class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of a primary key class.
This method is only guaranteed to be called by the Java model generators. Other user supplied generators may, or may not, call this method.- Specified by:
modelPrimaryKeyClassGenerated
in interfacePlugin
- Parameters:
topLevelClass
- the generated primary key classintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the class should be generated, false if the generated class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
modelBaseRecordClassGenerated
public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called after the base record class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of a base record class.
This method is only guaranteed to be called by the default Java model generators. Other user supplied generators may, or may not, call this method.- Specified by:
modelBaseRecordClassGenerated
in interfacePlugin
- Parameters:
topLevelClass
- the generated base record classintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the class should be generated, false if the generated class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
modelRecordWithBLOBsClassGenerated
public boolean modelRecordWithBLOBsClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called after the record with BLOBs class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of a record with BLOBs class.
This method is only guaranteed to be called by the default Java model generators. Other user supplied generators may, or may not, call this method.- Specified by:
modelRecordWithBLOBsClassGenerated
in interfacePlugin
- Parameters:
topLevelClass
- the generated record with BLOBs classintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the class should be generated, false if the generated class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
modelExampleClassGenerated
public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called after the example class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of an example class.
This method is only guaranteed to be called by the default Java model generators. Other user supplied generators may, or may not, call this method.- Specified by:
modelExampleClassGenerated
in interfacePlugin
- Parameters:
topLevelClass
- the generated example classintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the class should be generated, false if the generated class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapGenerated
Description copied from interface:Plugin
This method is called when the SqlMap file has been generated.- Specified by:
sqlMapGenerated
in interfacePlugin
- Parameters:
sqlMap
- the generated file (containing the file name, package name, and project name)introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the sqlMap should be generated, false if the generated sqlMap should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapDocumentGenerated
Description copied from interface:Plugin
This method is called when the SqlMap document has been generated. This method can be used to add additional XML elements the the generated document.- Specified by:
sqlMapDocumentGenerated
in interfacePlugin
- Parameters:
document
- the generated document (note that this is the MyBatis generator's internal Document class - not the w3c XML Document class)introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the document should be generated, false if the generated
document should be ignored. In the case of multiple plugins, the
first plugin returning false will disable the calling of further
plugins. Also, if any plugin returns false, then the
sqlMapGenerated
method will not be called.
-
sqlMapResultMapWithoutBLOBsElementGenerated
public boolean sqlMapResultMapWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the base resultMap is generated.- Specified by:
sqlMapResultMapWithoutBLOBsElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <resultMap> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapCountByExampleElementGenerated
public boolean sqlMapCountByExampleElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the countByExample element is generated.- Specified by:
sqlMapCountByExampleElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapDeleteByExampleElementGenerated
public boolean sqlMapDeleteByExampleElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the deleteByExample element is generated.- Specified by:
sqlMapDeleteByExampleElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <delete> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapDeleteByPrimaryKeyElementGenerated
public boolean sqlMapDeleteByPrimaryKeyElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the deleteByPrimaryKey element is generated.- Specified by:
sqlMapDeleteByPrimaryKeyElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <delete> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapExampleWhereClauseElementGenerated
public boolean sqlMapExampleWhereClauseElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the exampleWhereClause element is generated.- Specified by:
sqlMapExampleWhereClauseElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <sql> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapBaseColumnListElementGenerated
public boolean sqlMapBaseColumnListElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the baseColumnList element is generated.- Specified by:
sqlMapBaseColumnListElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <sql> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapBlobColumnListElementGenerated
public boolean sqlMapBlobColumnListElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the blobColumnList element is generated.- Specified by:
sqlMapBlobColumnListElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <sql> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapInsertElementGenerated
public boolean sqlMapInsertElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insert element is generated.- Specified by:
sqlMapInsertElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <insert> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapInsertSelectiveElementGenerated
public boolean sqlMapInsertSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insert selective element is generated.- Specified by:
sqlMapInsertSelectiveElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <insert> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapResultMapWithBLOBsElementGenerated
public boolean sqlMapResultMapWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the resultMap with BLOBs element is generated - this resultMap will extend the base resultMap.- Specified by:
sqlMapResultMapWithBLOBsElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <resultMap> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapSelectAllElementGenerated
public boolean sqlMapSelectAllElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectAll element is generated.- Specified by:
sqlMapSelectAllElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapSelectByPrimaryKeyElementGenerated
public boolean sqlMapSelectByPrimaryKeyElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectByPrimaryKey element is generated.- Specified by:
sqlMapSelectByPrimaryKeyElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapSelectByExampleWithoutBLOBsElementGenerated
public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectByExample element is generated.- Specified by:
sqlMapSelectByExampleWithoutBLOBsElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapSelectByExampleWithBLOBsElementGenerated
public boolean sqlMapSelectByExampleWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectByExampleWithBLOBs element is generated.- Specified by:
sqlMapSelectByExampleWithBLOBsElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapUpdateByExampleSelectiveElementGenerated
public boolean sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByExampleSelective element is generated.- Specified by:
sqlMapUpdateByExampleSelectiveElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapUpdateByExampleWithBLOBsElementGenerated
public boolean sqlMapUpdateByExampleWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByExampleWithBLOBs element is generated.- Specified by:
sqlMapUpdateByExampleWithBLOBsElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapUpdateByExampleWithoutBLOBsElementGenerated
public boolean sqlMapUpdateByExampleWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByExampleWithourBLOBs element is generated.- Specified by:
sqlMapUpdateByExampleWithoutBLOBsElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapUpdateByPrimaryKeySelectiveElementGenerated
public boolean sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByPrimaryKeySelective element is generated.- Specified by:
sqlMapUpdateByPrimaryKeySelectiveElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated
public boolean sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByPrimaryKeyWithBLOBs element is generated.- Specified by:
sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated
public boolean sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByPrimaryKeyWithoutBLOBs element is generated.- Specified by:
sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated
in interfacePlugin
- Parameters:
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerGenerated
Description copied from interface:Plugin
This method is called when the SQL provider has been generated. Implement this method to add additional methods or fields to a generated SQL provider.- Specified by:
providerGenerated
in interfacePlugin
- Parameters:
topLevelClass
- the generated providerintrospectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the provider should be generated, false if the generated provider should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerApplyWhereMethodGenerated
public boolean providerApplyWhereMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the applyWhere method has been generated in the SQL provider.- Specified by:
providerApplyWhereMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated applyWhere methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerCountByExampleMethodGenerated
public boolean providerCountByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the countByExample method has been generated in the SQL provider.- Specified by:
providerCountByExampleMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated countByExample methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerDeleteByExampleMethodGenerated
public boolean providerDeleteByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the deleteByExample method has been generated in the SQL provider.- Specified by:
providerDeleteByExampleMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated deleteByExample methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerInsertSelectiveMethodGenerated
public boolean providerInsertSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the insertSelective method has been generated in the SQL provider.- Specified by:
providerInsertSelectiveMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated insertSelective methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerSelectByExampleWithBLOBsMethodGenerated
public boolean providerSelectByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectByExampleWithBLOBs method has been generated in the SQL provider.- Specified by:
providerSelectByExampleWithBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated selectByExampleWithBLOBs methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerSelectByExampleWithoutBLOBsMethodGenerated
public boolean providerSelectByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the selectByExampleWithoutBLOBs method has been generated in the SQL provider.- Specified by:
providerSelectByExampleWithoutBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated selectByExampleWithoutBLOBs methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerUpdateByExampleSelectiveMethodGenerated
public boolean providerUpdateByExampleSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByExampleSelective method has been generated in the SQL provider.- Specified by:
providerUpdateByExampleSelectiveMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByExampleSelective methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerUpdateByExampleWithBLOBsMethodGenerated
public boolean providerUpdateByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByExampleWithBLOBs method has been generated in the SQL provider.- Specified by:
providerUpdateByExampleWithBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByExampleWithBLOBs methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerUpdateByExampleWithoutBLOBsMethodGenerated
public boolean providerUpdateByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByExampleWithoutBLOBs method has been generated in the SQL provider.- Specified by:
providerUpdateByExampleWithoutBLOBsMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByExampleWithoutBLOBs methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
providerUpdateByPrimaryKeySelectiveMethodGenerated
public boolean providerUpdateByPrimaryKeySelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the updateByPrimaryKeySelective method has been generated in the SQL provider.- Specified by:
providerUpdateByPrimaryKeySelectiveMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByPrimaryKeySelective methodtopLevelClass
- the partially generated provider class You can add additional imported classes to the class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
dynamicSqlSupportGenerated
public boolean dynamicSqlSupportGenerated(TopLevelClass supportClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the MyBatis Dynamic SQL support class has been generated in the MyBatis Dynamic SQL runtime.- Specified by:
dynamicSqlSupportGenerated
in interfacePlugin
- Parameters:
supportClass
- the generated MyBatis Dynamic SQL support class You can add additional items to the generated class if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the class should be generated, false if the generated class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-
dynamicSqlSupportGenerated
public boolean dynamicSqlSupportGenerated(KotlinFile kotlinFile, KotlinType outerSupportObject, KotlinType innerSupportClass, IntrospectedTable introspectedTable) Description copied from interface:Plugin
This method is called when the MyBatis Dynamic SQL support object has been generated. The format of the class is an outer object with an inner class. The inner class contains the table and column definitions. The outer (singleton) object contains a reference to an instance of the inner class, and shortcut properties that reference the columns of that instance.- Specified by:
dynamicSqlSupportGenerated
in interfacePlugin
- Parameters:
kotlinFile
- the generated Kotlin file containing the outer object and inner classouterSupportObject
- a reference to the outer object in the fileinnerSupportClass
- a reference to the inner classintrospectedTable
- the class containing information about the table as introspected from the database- Returns:
- true if the generated file should be kept
-
mapperGenerated
public boolean mapperGenerated(KotlinFile mapperFile, KotlinType mapper, IntrospectedTable introspectedTable) - Specified by:
mapperGenerated
in interfacePlugin
-
kotlinDataClassGenerated
public boolean kotlinDataClassGenerated(KotlinFile kotlinFile, KotlinType dataClass, IntrospectedTable introspectedTable) - Specified by:
kotlinDataClassGenerated
in interfacePlugin
-
clientColumnListPropertyGenerated
public boolean clientColumnListPropertyGenerated(KotlinProperty kotlinProperty, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientColumnListPropertyGenerated
in interfacePlugin
-
clientInsertMultipleVarargMethodGenerated
public boolean clientInsertMultipleVarargMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientInsertMultipleVarargMethodGenerated
in interfacePlugin
-
clientUpdateByPrimaryKeyMethodGenerated
public boolean clientUpdateByPrimaryKeyMethodGenerated(KotlinFunction kotlinFunction, KotlinFile kotlinFile, IntrospectedTable introspectedTable) - Specified by:
clientUpdateByPrimaryKeyMethodGenerated
in interfacePlugin
-
shouldGenerate
Description copied from interface:Plugin
If false, the table will be skipped in code generation.- Specified by:
shouldGenerate
in interfacePlugin
- Parameters:
introspectedTable
- the current table- Returns:
- true if code should be generated for this table, else false
-
clientUpdateByPrimaryKeyMethodGenerated
public boolean clientUpdateByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) Description copied from interface:Plugin
The motivation for adding this method can be found in https://github.com/mybatis/generator/issues/1116 This method is called when the updateByPrimaryKey method has been generated in the dynamic SQL runtime client interface.- Specified by:
clientUpdateByPrimaryKeyMethodGenerated
in interfacePlugin
- Parameters:
method
- the generated updateByPrimaryKey methodinterfaze
- the partially implemented client interface. You can add additional imported classes to the interface if necessary.introspectedTable
- The class containing information about the table as introspected from the database- Returns:
- true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.
-