| java.lang.Object
 org.eclipse.pde.internal.ui.util.TemplateFileGenerator
| Field Summary | |
| final public static String | KEY_ACTIVATOR_SIMPLE
| | final public static String | KEY_PACKAGE_NAME
The key for the package name that will be created by this teamplate
(value="packageName"). | | final public static String | KEY_PLUGIN_CLASS
The key for the main plug-in class of the plug-in that the template is
used for (value="pluginClass"). | | final public static String | KEY_PLUGIN_ID
The key for the plug-in id of the plug-in that the template is used for
(value="pluginId"). | | final public static String | KEY_PLUGIN_NAME
The key for the plug-in name of the plug-in that the template is used for
(value="pluginName"). |
| Method Summary | |
| public void | generateFiles(IProgressMonitor monitor)
Generates files as part of the template execution. | | protected void | generateFiles(IProgressMonitor monitor, URL locationUrl)
Generates files as part of the template execution.
The files found in the location are processed in the following way:
- Files and folders found in the directory bin are
copied into the target project without modification.
- Files found in the directory java are copied into the
Java source folder by creating the folder structure that corresponds to
the package name (variable packageName ).
| | public String | getReplacementString(String fileName, String key)
The default implementation of this method provides values of the
following keys: pluginClass , pluginId and
pluginName . | | public String | getSectionId()
| | protected IFolder | getSourceFolder(IProgressMonitor monitor)
Returns the folder with Java files in the target project. | | protected double | getTargetVersion()
| | public URL | getTemplateLocation()
| | public Object | getValue(String key)
| | protected boolean | isOkToCreateFile(File sourceFile)
Tests if the file found in the template location should be created in the
target project. | | protected boolean | isOkToCreateFolder(File sourceFolder)
Tests if the folder found in the template location should be created in
the target project. |
| KEY_ACTIVATOR_SIMPLE | | final public static String KEY_ACTIVATOR_SIMPLE(Code) | | The key for the simple class name of a bundle activator (value="activator")
since:
3.3 |
| KEY_PACKAGE_NAME | | final public static String KEY_PACKAGE_NAME(Code) | | The key for the package name that will be created by this teamplate
(value="packageName").
|
| KEY_PLUGIN_CLASS | | final public static String KEY_PLUGIN_CLASS(Code) | | The key for the main plug-in class of the plug-in that the template is
used for (value="pluginClass"). The return value is a fully-qualified class name.
|
| KEY_PLUGIN_ID | | final public static String KEY_PLUGIN_ID(Code) | | The key for the plug-in id of the plug-in that the template is used for
(value="pluginId").
|
| KEY_PLUGIN_NAME | | final public static String KEY_PLUGIN_NAME(Code) | | The key for the plug-in name of the plug-in that the template is used for
(value="pluginName").
|
| generateFiles | | public void generateFiles(IProgressMonitor monitor) throws CoreException(Code) | | Generates files as part of the template execution. The default
implementation uses template location as a root of the file templates.
TemplateFileGenerator.generateFiles(IProgressMonitor monitor,URL locationUrl) on how
the location gets processed.
Parameters:
monitor - progress monitor to use to indicate generation progress |
| generateFiles | | protected void generateFiles(IProgressMonitor monitor, URL locationUrl) throws CoreException(Code) | | Generates files as part of the template execution.
The files found in the location are processed in the following way:
- Files and folders found in the directory bin are
copied into the target project without modification.
- Files found in the directory java are copied into the
Java source folder by creating the folder structure that corresponds to
the package name (variable packageName ). Java files are
subject to conditional generation and variable replacement.
- All other files and folders are copied directly into the target
folder with the conditional generation and variable replacement for
files. Variable replacement also includes file names.
since:
3.3
Parameters:
monitor - progress monitor to use to indicate generation progress
Parameters:
locationUrl - a url pointing to a file/directory that will be copied into the template |
| getReplacementString | | public String getReplacementString(String fileName, String key)(Code) | | The default implementation of this method provides values of the
following keys: pluginClass , pluginId and
pluginName .
See Also: ITemplateSection.getReplacementString(StringString) |
| getSourceFolder | | protected IFolder getSourceFolder(IProgressMonitor monitor) throws CoreException(Code) | | Returns the folder with Java files in the target project. The default
implementation looks for source folders in the classpath of the target
folders and picks the first one encountered. Subclasses may override this
behaviour.
Parameters:
monitor - progress monitor to use source folder that will be used to generate Java files ornull if none found. |
| getTargetVersion | | protected double getTargetVersion()(Code) | | |
| getTemplateLocation | | public URL getTemplateLocation()(Code) | | |
| isOkToCreateFile | | protected boolean isOkToCreateFile(File sourceFile)(Code) | | Tests if the file found in the template location should be created in the
target project. Subclasses may use this method to conditionally block
creation of the file (subject to user choices).
Parameters:
sourceFile - the file found in the template location that needs to becreated. true if the specified file should be created in theproject or false to skip it. The defaultimplementation is true . |
| isOkToCreateFolder | | protected boolean isOkToCreateFolder(File sourceFolder)(Code) | | Tests if the folder found in the template location should be created in
the target project. Subclasses may use this method to conditionally block
the creation of entire directories (subject to user choices).
Parameters:
sourceFolder - the folder that is tested true if the provided folder should be created inthe workspace, false if the values of thesubstitution variables indicate otherwise. |
|
|