ch.sahits.codegen.extensions
Class JETemplate

java.lang.Object
  ch.sahits.codegen.extensions.JETemplate

public final class JETemplate
extends java.lang.Object

This class handles the extension point ch.sahits.codegen.java.jettemplate

Since:

0.9.2

Author:

Andi Hotz

Constructor Summary

JETemplate()

Method Summary

static java.lang.String[]	getContributingJetPluginIDs() Retrieve all plugin ids that contribute a jetemplate and are not equal to this plug-in
static IGeneratorCollection	getGenerators() Retrieve all registered jetemplates
static IJetGeneratorExtension	getJetemplate(java.lang.String bundle, java.lang.String location) Retrieve the Jetemplate for a specific Jetemplate
static java.util.Map<java.lang.String,java.lang.String>	getJetemplate4DisplaySelection() This methods retrieves the map of generates in the form .
static java.lang.String[]	getJETemplates() Deprecated. Use getJetemplate4DisplaySelection() instead. This method will be removed with Version 3.0
static java.lang.String	getJetFileDirectory(java.lang.String jetTemplatePluginID) Retrieve the file directory for the JETemplat in a plugin
static java.lang.String	getPluginIdOfContibutingPlugin(java.lang.String jeTemplateName) Deprecated. with the use of getJetemplate4DisplaySelection() this method is obsolete. This method will be removed with 3.0
static java.lang.String	getPluginIdOfContibutingPlugin2(java.lang.String jeTemplateLocationName) Deprecated. with the use of getJetemplate4DisplaySelection() this method is obsolete. This method will be removed with 3.0

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JETemplate

public JETemplate()

Method Detail

getGenerators

public static IGeneratorCollection getGenerators()

Retrieve all registered jetemplates

Returns:

Collection of jetemplates

getJetemplate

public static IJetGeneratorExtension getJetemplate(java.lang.String bundle,
                                                   java.lang.String location)

Retrieve the Jetemplate for a specific Jetemplate

Parameters:

bundle - Bundle ID

location - of the jetemplate within the bundle

Returns:

Jetemplate definition

getJetFileDirectory

public static java.lang.String getJetFileDirectory(java.lang.String jetTemplatePluginID)

Retrieve the file directory for the JETemplat in a plugin

Parameters:

jetTemplatePluginID - id of the plugin

Returns:

directory path from the plugin root to the jet file (exclusive)

getContributingJetPluginIDs

public static java.lang.String[] getContributingJetPluginIDs()

Retrieve all plugin ids that contribute a jetemplate and are not equal to this plug-in

Returns:

Array of all plugin ids that contribute a jetemplate

getPluginIdOfContibutingPlugin

@Deprecated
public static java.lang.String getPluginIdOfContibutingPlugin(java.lang.String jeTemplateName)

Deprecated. with the use of getJetemplate4DisplaySelection() this method is obsolete. This method will be removed with 3.0

Get the plugin id of the plugin that holds the template

Parameters:

jeTemplateName - name of the template to be looked up in the contributing extension points

Returns:

plugin id or null

getPluginIdOfContibutingPlugin2

@Deprecated
public static java.lang.String getPluginIdOfContibutingPlugin2(java.lang.String jeTemplateLocationName)

Deprecated. with the use of getJetemplate4DisplaySelection() this method is obsolete. This method will be removed with 3.0

Get the plugin id of the plugin that holds the template

Parameters:

jeTemplateLocationName - name of the template to be looked up in the contributing extension points

Returns:

plugin id or null

getJETemplates

@Deprecated
public static java.lang.String[] getJETemplates()

Deprecated. Use getJetemplate4DisplaySelection() instead. This method will be removed with Version 3.0

Get the names off all the contributing jetemplates

Returns:

array with template names

getJetemplate4DisplaySelection

public static java.util.Map<java.lang.String,java.lang.String> getJetemplate4DisplaySelection()

This methods retrieves the map of generates in the form . Each display name is unique. Should two generators have the same display name the second and all further will display the key as display name of the generator

Returns:

Map of generators