java.lang.Object |
↳ |
org.mybatis.generator.api.MyBatisGenerator |
Class Overview
This class is the main interface to MyBatis generator. A typical execution of
the tool involves these steps:
- Create a Configuration object. The Configuration can be the result of a
parsing the XML configuration file, or it can be created solely in Java.
- Create a MyBatisGenerator object
- Call one of the generate() methods
Summary
[Expand]
Inherited Methods |
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait()
|
final
void
|
wait(long arg0)
|
final
void
|
wait(long arg0, int arg1)
|
|
Public Constructors
public
MyBatisGenerator
(Configuration configuration, ShellCallback shellCallback, List<String> warnings)
Constructs a MyBatisGenerator object.
Parameters
configuration
| The configuration for this invocation |
shellCallback
| an instance of a ShellCallback interface. You may specify
null in which case the DefaultShellCallback will
be used. |
warnings
| Any warnings generated during execution will be added to this
list. Warnings do not affect the running of the tool, but they
may affect the results. A typical warning is an unsupported
data type. In that case, the column will be ignored and
generation will continue. You may specify null if
you do not want warnings returned. |
Public Methods
This is the main method for generating code. This method is long running,
but progress can be provided and the method can be canceled through the
ProgressCallback interface. This version of the method runs all
configured contexts.
Parameters
callback
| an instance of the ProgressCallback interface, or
null if you do not require progress information |
Throws
| SQLException |
| IOException |
InterruptedException
| if the method is canceled through the ProgressCallback
|
SQLException
| |
IOException
| |
public
void
generate
(ProgressCallback callback, Set<String> contextIds)
This is the main method for generating code. This method is long running,
but progress can be provided and the method can be canceled through the
ProgressCallback interface.
Parameters
callback
| an instance of the ProgressCallback interface, or
null if you do not require progress information |
contextIds
| a set of Strings containing context ids to run. Only the
contexts with an id specified in this list will be run. If the
list is null or empty, than all contexts are run. |
Throws
| InvalidConfigurationException |
| SQLException |
| IOException |
InterruptedException
| if the method is canceled through the ProgressCallback
|
SQLException
| |
IOException
| |
public
void
generate
(ProgressCallback callback, Set<String> contextIds, Set<String> fullyQualifiedTableNames)
This is the main method for generating code. This method is long running,
but progress can be provided and the method can be cancelled through the
ProgressCallback interface.
Parameters
callback
| an instance of the ProgressCallback interface, or
null if you do not require progress information |
contextIds
| a set of Strings containing context ids to run. Only the
contexts with an id specified in this list will be run. If the
list is null or empty, than all contexts are run. |
fullyQualifiedTableNames
| a set of table names to generate. The elements of the set must
be Strings that exactly match what's specified in the
configuration. For example, if table name = "foo" and schema =
"bar", then the fully qualified table name is "foo.bar". If
the Set is null or empty, then all tables in the configuration
will be used for code generation. |
Throws
| InvalidConfigurationException |
| SQLException |
| IOException |
InterruptedException
| if the method is canceled through the ProgressCallback
|
SQLException
| |
IOException
| |