org.eclipse.xtext.generator

Class AbstractGeneratorFragment

java.lang.Object

org.eclipse.xtext.generator.DefaultGeneratorFragment

org.eclipse.xtext.generator.AbstractGeneratorFragment

All Implemented Interfaces:

IGeneratorFragment, NamingAware

Direct Known Subclasses:

AbstractAntlrGeneratorFragment, AbstractInheritingGeneratorFragment, AbstractStubGeneratorFragment, CodetemplatesGeneratorFragment, EMFGeneratorFragment, GeneratorFragment, GrammarAccessFragment, ImplicitUiFragment, Junit4Fragment, PackratParserFragment, ParseTreeConstructorFragment, QuickOutlineFragment, RefactorElementNameFragment, ResourceFactoryFragment, SimpleProjectWizardFragment, XbaseGeneratorFragment

public abstract class AbstractGeneratorFragment
extends DefaultGeneratorFragment
implements NamingAware

Author:

Sven Efftinge - Initial contribution and API base class redirecting call backs to respective Xpand definitions. The template needs to have the same qualified name the extending class has.

Constructor Summary

Constructors

Constructor and Description
AbstractGeneratorFragment()

Method Summary

Methods

Modifier and Type	Method and Description
void	addToPluginXmlRt(Grammar grammar, org.eclipse.xpand2.XpandExecutionContext ctx) Used to add code to the plugin.xml of the runtime bundle.
void	addToPluginXmlTests(Grammar grammar, org.eclipse.xpand2.XpandExecutionContext ctx)
void	addToPluginXmlUi(Grammar grammar, org.eclipse.xpand2.XpandExecutionContext ctx) Used to add code to the plugin.xml of the ui bundle.
void	addToStandaloneSetup(Grammar grammar, org.eclipse.xpand2.XpandExecutionContext ctx) Used to add code to the generated 'public void register(Injector injector)'-method
void	generate(Grammar grammar, org.eclipse.xpand2.XpandExecutionContext ctx) can be used to generate whatever necessary
java.lang.String[]	getExportedPackagesRt(Grammar grammar) return the exported packages for the runtime bundle
java.lang.String[]	getExportedPackagesUi(Grammar grammar) return the exported packages for the ui bundle
java.util.Set<Binding>	getGuiceBindingsRt(Grammar grammar) return a map containing the contributed guice bindings created in this generator fragment
java.util.Set<Binding>	getGuiceBindingsUi(Grammar grammar) return a map containing the contributed guice bindings for the ui part created in this generator fragment
Naming	getNaming()
protected java.util.List<java.lang.Object>	getParameters(Grammar grammar)
java.lang.String[]	getRequiredBundlesRt(Grammar grammar) return the bundles this fragment requires at runtime
java.lang.String[]	getRequiredBundlesUi(Grammar grammar) return the bundles this fragment requires in ui
protected java.lang.String	getTemplate()
void	registerNaming(Naming naming)

Methods inherited from class org.eclipse.xtext.generator.DefaultGeneratorFragment

checkConfiguration, getImportedPackagesRt, getImportedPackagesUi

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGeneratorFragment

public AbstractGeneratorFragment()

Method Detail

registerNaming

public void registerNaming(Naming naming)

Specified by:

registerNaming in interface NamingAware

getNaming

public Naming getNaming()

getTemplate

protected java.lang.String getTemplate()

generate

public void generate(Grammar grammar,
            org.eclipse.xpand2.XpandExecutionContext ctx)

Description copied from interface: IGeneratorFragment

can be used to generate whatever necessary

Specified by:

generate in interface IGeneratorFragment

Overrides:

generate in class DefaultGeneratorFragment

ctx - - the execution context to use

addToPluginXmlRt

public void addToPluginXmlRt(Grammar grammar,
                    org.eclipse.xpand2.XpandExecutionContext ctx)

Description copied from interface: IGeneratorFragment

Used to add code to the plugin.xml of the runtime bundle. The surrounding tags are added automatically

Specified by:

addToPluginXmlRt in interface IGeneratorFragment

Overrides:

addToPluginXmlRt in class DefaultGeneratorFragment

ctx - - the execution context to use (the plugin.xml file is already opened)

addToPluginXmlUi

public void addToPluginXmlUi(Grammar grammar,
                    org.eclipse.xpand2.XpandExecutionContext ctx)

Description copied from interface: IGeneratorFragment

Used to add code to the plugin.xml of the ui bundle. The surrounding tags are added automatically

Specified by:

addToPluginXmlUi in interface IGeneratorFragment

Overrides:

addToPluginXmlUi in class DefaultGeneratorFragment

ctx - - the execution context to use (the plugin.xml file is already opened)

addToPluginXmlTests

public void addToPluginXmlTests(Grammar grammar,
                       org.eclipse.xpand2.XpandExecutionContext ctx)

Since:

2.3

addToStandaloneSetup

public void addToStandaloneSetup(Grammar grammar,
                        org.eclipse.xpand2.XpandExecutionContext ctx)

Description copied from interface: IGeneratorFragment

Used to add code to the generated 'public void register(Injector injector)'-method

Specified by:

addToStandaloneSetup in interface IGeneratorFragment

Overrides:

addToStandaloneSetup in class DefaultGeneratorFragment

ctx - - the execution context to use (the file is already opened, content goes into the register method)

getExportedPackagesRt

public java.lang.String[] getExportedPackagesRt(Grammar grammar)

Description copied from interface: IGeneratorFragment

return the exported packages for the runtime bundle

Specified by:

getExportedPackagesRt in interface IGeneratorFragment

Overrides:

getExportedPackagesRt in class DefaultGeneratorFragment

getExportedPackagesUi

public java.lang.String[] getExportedPackagesUi(Grammar grammar)

Description copied from interface: IGeneratorFragment

return the exported packages for the ui bundle

Specified by:

getExportedPackagesUi in interface IGeneratorFragment

Overrides:

getExportedPackagesUi in class DefaultGeneratorFragment

getGuiceBindingsRt

public java.util.Set<Binding> getGuiceBindingsRt(Grammar grammar)

Description copied from interface: IGeneratorFragment

return a map containing the contributed guice bindings created in this generator fragment

Specified by:

getGuiceBindingsRt in interface IGeneratorFragment

Overrides:

getGuiceBindingsRt in class DefaultGeneratorFragment

getGuiceBindingsUi

public java.util.Set<Binding> getGuiceBindingsUi(Grammar grammar)

Description copied from interface: IGeneratorFragment

return a map containing the contributed guice bindings for the ui part created in this generator fragment

Specified by:

getGuiceBindingsUi in interface IGeneratorFragment

Overrides:

getGuiceBindingsUi in class DefaultGeneratorFragment

getRequiredBundlesRt

public java.lang.String[] getRequiredBundlesRt(Grammar grammar)

Description copied from interface: IGeneratorFragment

return the bundles this fragment requires at runtime

Specified by:

getRequiredBundlesRt in interface IGeneratorFragment

Overrides:

getRequiredBundlesRt in class DefaultGeneratorFragment

getRequiredBundlesUi

public java.lang.String[] getRequiredBundlesUi(Grammar grammar)

Description copied from interface: IGeneratorFragment

return the bundles this fragment requires in ui

Specified by:

getRequiredBundlesUi in interface IGeneratorFragment

Overrides:

getRequiredBundlesUi in class DefaultGeneratorFragment

getParameters

protected java.util.List<java.lang.Object> getParameters(Grammar grammar)