org.eclipse.xtext.generator.scoping

Class AbstractScopingFragment

java.lang.Object

org.eclipse.xtext.generator.DefaultGeneratorFragment

org.eclipse.xtext.generator.AbstractGeneratorFragment

org.eclipse.xtext.generator.AbstractInheritingGeneratorFragment

org.eclipse.xtext.generator.scoping.AbstractScopingFragment

All Implemented Interfaces:

IGeneratorFragment, IGeneratorFragmentExtension, IGeneratorFragmentExtension2, IGeneratorFragmentExtension3, IInheriting, IStubGenerating, IStubGenerating.XtendOption, NamingAware

Direct Known Subclasses:

ImportNamespacesScopingFragment, ImportURIScopingFragment

public abstract class AbstractScopingFragment
extends AbstractInheritingGeneratorFragment
implements IStubGenerating, IStubGenerating.XtendOption

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.generator.IStubGenerating

IStubGenerating.XtendOption

Nested classes/interfaces inherited from interface org.eclipse.xtext.generator.IInheriting

IInheriting.Util

Constructor Summary

Constructors

Constructor and Description
AbstractScopingFragment()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	getDefaultScopeProviderSuperClassName()
java.lang.String[]	getExportedPackagesRt(Grammar grammar) return the exported packages for the runtime bundle
protected abstract java.lang.Class<? extends IGlobalScopeProvider>	getGlobalScopeProvider()
java.util.Set<Binding>	getGuiceBindingsRt(Grammar grammar) return a map containing the contributed guice bindings created in this generator fragment
protected abstract java.lang.Class<? extends IScopeProvider>	getLocalScopeProvider()
protected java.util.List<java.lang.Object>	getParameters(Grammar grammar)
java.lang.String[]	getRequiredBundlesRt(Grammar grammar) return the bundles this fragment requires at runtime
static java.lang.String	getScopeProviderName(Grammar grammar, Naming naming)
protected java.lang.String	getScopeProviderSuperClassName(Grammar grammar)
protected java.lang.String	getTemplate()
boolean	isGenerateStub()
boolean	isGenerateStub(Grammar grammar)
boolean	isGenerateXtendStub()
boolean	isIgnoreCase()
void	setGenerateStub(boolean isGenerateStub)
void	setGenerateXtendStub(boolean isGenerateXtendStub)
void	setIgnoreCase(boolean ignoreCase)

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

getSuperClassName, getSuperGrammar, isClassExists, isInheritImplementation, setInheritImplementation

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

addToPluginXmlRt, addToPluginXmlTests, addToPluginXmlUi, addToStandaloneSetup, generate, getNaming, readFileIntoString, registerNaming, writeStringIntoFile

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

addToPluginXmlRt, addToPluginXmlUi, addToStandaloneSetup, checkConfiguration, generate, getExportedPackagesIde, getExportedPackagesTests, getExportedPackagesUi, getGuiceBindingsUi, getImportedPackagesIde, getImportedPackagesRt, getImportedPackagesTests, getImportedPackagesUi, getRequiredBundlesIde, getRequiredBundlesTests, getRequiredBundlesUi

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractScopingFragment

public AbstractScopingFragment()

Method Detail

getScopeProviderName

public static java.lang.String getScopeProviderName(Grammar grammar,
                                    Naming naming)

isGenerateXtendStub

public boolean isGenerateXtendStub()

Specified by:

isGenerateXtendStub in interface IStubGenerating.XtendOption

Returns:

true, if the fragment is configured to generate stub classes in Xtend instead of Java. This only has an effect if the generation of stubs is enabled in general IStubGenerating.isGenerateStub().

Since:

2.4

setGenerateXtendStub

public void setGenerateXtendStub(boolean isGenerateXtendStub)

Specified by:

setGenerateXtendStub in interface IStubGenerating.XtendOption

Parameters:

isGenerateXtendStub - decide if the fragment should generate stub classes in Xtend instead of Java. This only has an effect if the generation of stubs is enabled in general IStubGenerating.setGenerateStub(boolean).

Since:

2.4

isGenerateStub

public boolean isGenerateStub()

Specified by:

isGenerateStub in interface IStubGenerating

setGenerateStub

public void setGenerateStub(boolean isGenerateStub)

Specified by:

setGenerateStub in interface IStubGenerating

isGenerateStub

public boolean isGenerateStub(Grammar grammar)

Since:

2.1

isIgnoreCase

public boolean isIgnoreCase()

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)

getGlobalScopeProvider

protected abstract java.lang.Class<? extends IGlobalScopeProvider> getGlobalScopeProvider()

getLocalScopeProvider

protected abstract java.lang.Class<? extends IScopeProvider> getLocalScopeProvider()

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

getScopeProviderSuperClassName

protected java.lang.String getScopeProviderSuperClassName(Grammar grammar)

getDefaultScopeProviderSuperClassName

protected java.lang.String getDefaultScopeProviderSuperClassName()

getParameters

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

Overrides:

getParameters in class AbstractGeneratorFragment

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

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

getTemplate

protected java.lang.String getTemplate()

Overrides:

getTemplate in class AbstractGeneratorFragment

Since:

2.4