org.eclipse.xtext.generator

Class DefaultGeneratorFragment

java.lang.Object

org.eclipse.xtext.generator.DefaultGeneratorFragment

All Implemented Interfaces:

IGeneratorFragment, IGeneratorFragmentExtension, IGeneratorFragmentExtension2

Direct Known Subclasses:

AbstractGeneratorFragment, AntlrDelegatingFragment, BasicUiGeneratorFragment, BuilderIntegrationFragment, DelegatingGeneratorFragment, Ecore2XtextValueConverterServiceFragment, ExternalAntlrLexerFragment, ImplicitRuntimeFragment, LoggingGeneratorFragment, QualifiedNamesFragment, SimpleNamesFragment, TypesGeneratorFragment, Xtend2GeneratorFragment, XtypeGeneratorFragment

public class DefaultGeneratorFragment
extends java.lang.Object
implements IGeneratorFragment, IGeneratorFragmentExtension, IGeneratorFragmentExtension2

Author:

Sven Efftinge - Initial contribution and API

Constructor Summary

Constructors

Constructor and Description
DefaultGeneratorFragment()

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	addToPluginXmlRt(LanguageConfig config, org.eclipse.xpand2.XpandExecutionContext ctx)
void	addToPluginXmlTests(Grammar grammar, org.eclipse.xpand2.XpandExecutionContext ctx) Deprecated.
void	addToPluginXmlUi(Grammar grammar, org.eclipse.xpand2.XpandExecutionContext ctx) Used to add code to the plugin.xml of the ui bundle.
void	addToPluginXmlUi(LanguageConfig config, org.eclipse.xpand2.XpandExecutionContext ctx)
void	addToStandaloneSetup(Grammar grammar, org.eclipse.xpand2.XpandExecutionContext ctx) Used to add code to the generated 'public void register(Injector injector)'-method
void	addToStandaloneSetup(LanguageConfig config, org.eclipse.xpand2.XpandExecutionContext ctx)
void	checkConfiguration(org.eclipse.emf.mwe.core.issues.Issues issues) Called by the container after configuration so the component can validate the configuration before invocation.
void	generate(Grammar grammar, org.eclipse.xpand2.XpandExecutionContext ctx) can be used to generate whatever necessary
void	generate(LanguageConfig config, org.eclipse.xpand2.XpandExecutionContext ctx)
java.lang.String[]	getExportedPackagesRt(Grammar grammar) return the exported packages for the runtime bundle
java.lang.String[]	getExportedPackagesTests(Grammar grammar) return the exported packages for the tests 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
java.lang.String[]	getImportedPackagesRt(Grammar grammar) return the imported packages for the runtime bundle
java.lang.String[]	getImportedPackagesTests(Grammar grammar) return the imported packages for the tests bundle
java.lang.String[]	getImportedPackagesUi(Grammar grammar) return the imported packages for the ui bundle
java.lang.String[]	getRequiredBundlesRt(Grammar grammar) return the bundles this fragment requires at runtime
java.lang.String[]	getRequiredBundlesTests(Grammar grammar) return the bundles this fragment requires in tests
java.lang.String[]	getRequiredBundlesUi(Grammar grammar) return the bundles this fragment requires in ui

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGeneratorFragment

public DefaultGeneratorFragment()

Method Detail

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

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

addToPluginXmlRt

public void addToPluginXmlRt(LanguageConfig config,
                    org.eclipse.xpand2.XpandExecutionContext ctx)

Specified by:

addToPluginXmlRt in interface IGeneratorFragmentExtension2

Since:

2.6

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

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

addToPluginXmlUi

public void addToPluginXmlUi(LanguageConfig config,
                    org.eclipse.xpand2.XpandExecutionContext ctx)

Specified by:

addToPluginXmlUi in interface IGeneratorFragmentExtension2

Since:

2.6

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

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

addToStandaloneSetup

public void addToStandaloneSetup(LanguageConfig config,
                        org.eclipse.xpand2.XpandExecutionContext ctx)

Specified by:

addToStandaloneSetup in interface IGeneratorFragmentExtension2

Since:

2.6

addToPluginXmlTests

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

Deprecated.

Description copied from interface: IGeneratorFragmentExtension

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

Specified by:

addToPluginXmlTests in interface IGeneratorFragmentExtension

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

Since:

2.6

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

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

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

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

getImportedPackagesRt

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

Description copied from interface: IGeneratorFragment

return the imported packages for the runtime bundle

Specified by:

getImportedPackagesRt in interface IGeneratorFragment

getImportedPackagesUi

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

Description copied from interface: IGeneratorFragment

return the imported packages for the ui bundle

Specified by:

getImportedPackagesUi in interface IGeneratorFragment

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

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

getExportedPackagesTests

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

Description copied from interface: IGeneratorFragmentExtension

return the exported packages for the tests bundle

Specified by:

getExportedPackagesTests in interface IGeneratorFragmentExtension

Since:

2.6

getImportedPackagesTests

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

Description copied from interface: IGeneratorFragmentExtension

return the imported packages for the tests bundle

Specified by:

getImportedPackagesTests in interface IGeneratorFragmentExtension

Since:

2.6

getRequiredBundlesTests

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

Description copied from interface: IGeneratorFragmentExtension

return the bundles this fragment requires in tests

Specified by:

getRequiredBundlesTests in interface IGeneratorFragmentExtension

Since:

2.6

checkConfiguration

public void checkConfiguration(org.eclipse.emf.mwe.core.issues.Issues issues)

Description copied from interface: IGeneratorFragment

Called by the container after configuration so the component can validate the configuration before invocation.

Specified by:

checkConfiguration in interface IGeneratorFragment

Parameters:

issues - implementors should report configuration issues to this.

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

ctx - - the execution context to use

generate

public void generate(LanguageConfig config,
            org.eclipse.xpand2.XpandExecutionContext ctx)

Specified by:

generate in interface IGeneratorFragmentExtension2

Since:

2.6