|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ibatis.abator.ui.plugin.EclipseShellCallback
Constructor Summary | |
EclipseShellCallback()
|
Method Summary | |
java.io.File |
getDirectory(java.lang.String targetProject,
java.lang.String targetPackage,
java.util.List warnings)
Abator will call this method to ask the shell to resolve a project/package combination into a directory on the file system. |
java.lang.String |
mergeJavaFile(GeneratedJavaFile newFile,
java.lang.String javadocTag,
java.util.List warnings)
Abator will call this method if a newly generated Java file would overwrite an existing file. |
boolean |
mergeSupported()
Return true if the callback supports Java merging, otherwise false. |
void |
refreshProject(java.lang.String project)
After all files are saved to the file system, Abator will call this method once for each unique project that was affected by the generation run. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public EclipseShellCallback()
Method Detail |
public java.io.File getDirectory(java.lang.String targetProject, java.lang.String targetPackage, java.util.List warnings) throws ShellException
ShellCallback
java.io.File
object:
getDirectory
in interface ShellCallback
targetProject
- targetPackage
- warnings
-
ShellException
- if the project/package cannot be resolved into
a directory on the file system. In this case, Abator will not save the
file it is currently working on. Abator
will add the exception message to the list of warnings automatically.public java.lang.String mergeJavaFile(GeneratedJavaFile newFile, java.lang.String javadocTag, java.util.List warnings) throws ShellException
ShellCallback
newFile.getFormattedContent()
.
However, this will overwrite any modifications to the generated files.
mergeJavaFile
in interface ShellCallback
newFile
- the newly generated Java filejavadocTag
- the JavaDoc tag that denotes which methods and fields in the
old file to delete (all new methods and fields will also include
this tag)warnings
- Any warning strings during the merge can be added to this list.
Adding a warning will not stop Abator from saving the resulting
source.
ShellException
- if the file cannot be merged for some reason. If this
exception is thrown, Abator will not save anything and
the existing file will remain undisturbed. Abator
will add the exception message to the list of warnings automatically.public void refreshProject(java.lang.String project)
ShellCallback
refreshProject
in interface ShellCallback
project
- the project to be refreshedpublic boolean mergeSupported()
ShellCallback
mergeJavaFile
method if this method
returns true;
mergeSupported
in interface ShellCallback
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |