Groovy Documentation

org.akhikhl.wuff
[Groovy] Class PluginUtils

java.lang.Object
  org.akhikhl.wuff.PluginUtils

final class PluginUtils

Eclipse Plugin utils

Authors:
akhikhl


Property Summary
static java.lang.String eclipsePluginMask

static java.lang.String equinoxLauncherPluginName

static java.lang.String osgiFrameworkPluginName

 
Method Summary
static java.util.List collectPluginLocalizationFiles(Project project)

Collects eclipse plugin configuration localization files, 'plugin*.properties'.

static java.util.List collectPrivateLibPackages(Project project)

Collects list of privateLib packages in the given project.

static java.lang.String findClassInSources(Project project, java.lang.String... sourceMasks)

Finds a class in the sources of the project.

static java.util.List findClassesInSources(Project project, java.lang.String... sourceMasks)

Finds classes in the sources of the project.

static java.util.List findImportPackagesInPluginConfigFile(Project project, java.lang.Object pluginConfig)

Finds list of import-packages in the given plugin configuration file, 'plugin.xml'.

static java.io.File findPluginCustomizationFile(Project project)

Finds eclipse plugin customization file, 'plugin_customization.ini'.

static java.io.File findPluginIntroHtmlFile(Project project, java.lang.String language = null)

static java.io.File findPluginIntroXmlFile(Project project, java.lang.String language = null)

static java.io.File findPluginManifestFile(Project project)

static java.io.File findPluginSplashFile(Project project)

static java.io.File findPluginXmlFile(Project project)

Finds eclipse plugin configuration file, 'plugin.xml'.

static java.lang.String getEclipseApplicationId(Project project)

static java.lang.String getEclipseIntroId(Project project)

static java.lang.String getEclipseProductId(Project project)

static java.io.File getEquinoxLauncherFile(Project project)

static java.io.File getExtraDir(Project project)

static java.io.File getExtraIntroXmlFile(Project project, java.lang.String language = null)

static java.io.File getExtraPluginCustomizationFile(Project project)

static java.io.File getExtraPluginXmlFile(Project project)

static java.util.List getLocalizationDirs(Project project)

static java.io.File getOsgiFrameworkFile(Project project)

static java.lang.String getPluginName(java.lang.String fileName)

static java.io.File getProductOutputBaseDir(Project project)

static java.io.File getWrappedLibsDir(Project project)

 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Property Detail

eclipsePluginMask

static final java.lang.String eclipsePluginMask


equinoxLauncherPluginName

static final java.lang.String equinoxLauncherPluginName


osgiFrameworkPluginName

static final java.lang.String osgiFrameworkPluginName


 
Method Detail

collectPluginLocalizationFiles

static java.util.List collectPluginLocalizationFiles(Project project)
Collects eclipse plugin configuration localization files, 'plugin*.properties'.
Returns:
list of strings (absolute paths) to plugin configuration localization files or empty list, if no localization files are found.
Parameters:
project - project being analyzed, not modified.


collectPrivateLibPackages

static java.util.List collectPrivateLibPackages(Project project)
Collects list of privateLib packages in the given project. The function iterates over files of privateLib configuration in the given project. Each file is treated as zip-tree, from which package names are extracted.
Returns:
list of strings (java package names).
Parameters:
project - project being analyzed, not modified.


findClassInSources

static java.lang.String findClassInSources(Project project, java.lang.String... sourceMasks)
Finds a class in the sources of the project.
Returns:
qualified name (package.class) of the found class or null, if class is not found.
Parameters:
project - - the project being analyzed, not modified.
sourceMasks - - list of Ant-style file patterns


findClassesInSources

static java.util.List findClassesInSources(Project project, java.lang.String... sourceMasks)
Finds classes in the sources of the project.
Returns:
list of qualified names (package.class) of the found classes or empty list, if classes are not found.
Parameters:
project - - the project being analyzed, not modified.
sourceMasks - - list of Ant-style file patterns


findImportPackagesInPluginConfigFile

static java.util.List findImportPackagesInPluginConfigFile(Project project, java.lang.Object pluginConfig)
Finds list of import-packages in the given plugin configuration file, 'plugin.xml'.
Returns:
list of qualified names of java-packages imported by elements in 'plugin.xml'.
Parameters:
project - project being analyzed, not modified.
pluginConfig - could have one of the following types: File, InputSource, InputStream, Reader, String. Should resolve to 'plugin.xml' file in the file system.


findPluginCustomizationFile

static java.io.File findPluginCustomizationFile(Project project)
Finds eclipse plugin customization file, 'plugin_customization.ini'.
Returns:
java.io.File, pointing to 'plugin_customization.ini', or null, if such file does not exist.
Parameters:
project - project being analyzed, not modified.


findPluginIntroHtmlFile

static java.io.File findPluginIntroHtmlFile(Project project, java.lang.String language = null)


findPluginIntroXmlFile

static java.io.File findPluginIntroXmlFile(Project project, java.lang.String language = null)


findPluginManifestFile

static java.io.File findPluginManifestFile(Project project)


findPluginSplashFile

static java.io.File findPluginSplashFile(Project project)


findPluginXmlFile

static java.io.File findPluginXmlFile(Project project)
Finds eclipse plugin configuration file, 'plugin.xml'.
Returns:
java.io.File, pointing to 'plugin.xml', or null, if such file does not exist.
Parameters:
project - project being analyzed, not modified.


getEclipseApplicationId

static java.lang.String getEclipseApplicationId(Project project)


getEclipseIntroId

static java.lang.String getEclipseIntroId(Project project)


getEclipseProductId

static java.lang.String getEclipseProductId(Project project)


getEquinoxLauncherFile

static java.io.File getEquinoxLauncherFile(Project project)


getExtraDir

static java.io.File getExtraDir(Project project)


getExtraIntroXmlFile

static java.io.File getExtraIntroXmlFile(Project project, java.lang.String language = null)


getExtraPluginCustomizationFile

static java.io.File getExtraPluginCustomizationFile(Project project)


getExtraPluginXmlFile

static java.io.File getExtraPluginXmlFile(Project project)


getLocalizationDirs

static java.util.List getLocalizationDirs(Project project)


getOsgiFrameworkFile

static java.io.File getOsgiFrameworkFile(Project project)


getPluginName

static java.lang.String getPluginName(java.lang.String fileName)


getProductOutputBaseDir

static java.io.File getProductOutputBaseDir(Project project)


getWrappedLibsDir

static java.io.File getWrappedLibsDir(Project project)


 

Groovy Documentation