org.eclipse.xpand2
Class Generator

java.lang.Object
  org.eclipse.emf.mwe.core.lib.AbstractWorkflowComponent
      org.eclipse.emf.mwe.core.lib.AbstractWorkflowComponent2
          org.eclipse.xtend.expression.AbstractExpressionsUsingWorkflowComponent
              org.eclipse.xpand2.Generator

All Implemented Interfaces:

org.eclipse.emf.mwe.core.WorkflowComponent, org.eclipse.emf.mwe.core.WorkflowComponentWithID, org.eclipse.emf.mwe2.runtime.workflow.IWorkflowComponent

public class Generator
extends AbstractExpressionsUsingWorkflowComponent

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.xtend.expression.AbstractExpressionsUsingWorkflowComponent

AbstractExpressionsUsingWorkflowComponent.Debug, AbstractExpressionsUsingWorkflowComponent.GlobalVar, AbstractExpressionsUsingWorkflowComponent.GlobalVarDef

Field Summary

protected List<String>	advices
protected String	expand
protected List<String>	extensionAdvices

Fields inherited from class org.eclipse.xtend.expression.AbstractExpressionsUsingWorkflowComponent

_advice, callback, exceptionHandler, exceptionsOnNullEvaluation, log, metaModels

Constructor Summary

Generator()

Method Summary

void	addAdvice(String advice) Adds an advice.
void	addExtensionAdvice(String extensionAdvice) Adds an extension advice.
void	addOutlet(Outlet outlet) Adds an outlet.
protected void	checkConfigurationInternal(org.eclipse.emf.mwe.core.issues.Issues issues)
protected XpandExecutionContext	createExecutionContext(org.eclipse.emf.mwe.core.WorkflowContext wfContext, org.eclipse.emf.mwe.core.monitor.ProgressMonitor monitor, org.eclipse.emf.mwe.core.issues.Issues issues) Creates the execution context that is used for evaluation of the Xpand generator.
protected Outlet	createOutlet() Creates an Outlet instance.
protected Output	createOutput() Creates an Output instance.
List<? extends PostProcessor>	getBeautifier() Deprecated. Will be removed in 2.0
String	getComponentName()
String	getFileEncoding() Returns the name of character encoding used for the output file.
String	getLogMessage()
List<Outlet>	getOutlets() Retrieves the configured and initialized outlets of the generator.
protected Output	getOutput()
protected ProtectedRegionResolver	getProtectedRegionResolver()
protected ExpandStatement	getStatement()
protected void	invokeInternal2(org.eclipse.emf.mwe.core.WorkflowContext ctx, org.eclipse.emf.mwe.core.monitor.ProgressMonitor monitor, org.eclipse.emf.mwe.core.issues.Issues issues)
void	setAutomaticHyphens(boolean automaticHyphens) Enables or disables the automatic hyphenation.
void	setBeautifier(List<? extends PostProcessor> beautifiers) Deprecated. Configure PostProcessors per Outlet
void	setExpand(String invoke) Sets the statement that is to expand by the generator.
void	setFileEncoding(String fileEncoding) Sets the character encoding used for the output file.
void	setGenPath(String genPath) Deprecated. use addOutlet(Outlet) instead
void	setOutput(Output output) Sets the output.
void	setPrDefaultExcludes(boolean prDefaultExcludes) Enables oder disables the default excludes for protected regions.
void	setPrExcludes(String prExcludes) Sets the additional excludes for protected regions.
void	setPrSrcPaths(String prSrcPathes) Sets the source paths for protected regions.
void	setSrcPath(String srcPath) Deprecated. use outlets instead

Methods inherited from class org.eclipse.xtend.expression.AbstractExpressionsUsingWorkflowComponent

addAdvices, addDebug, addExtensionAdvices, addGlobalVar, addGlobalVarDef, addMetaModel, getExecutionContext, getGlobalVars, getNullEvaluationHandler, getResourceManager, invokeInternal, setCallback, setDumpContext, setExceptionHandler, setExceptionsOnNullEvaluation, setResourceManager, setVetoableCallback, toString

Methods inherited from class org.eclipse.emf.mwe.core.lib.AbstractWorkflowComponent2

checkConfiguration

Methods inherited from class org.eclipse.emf.mwe.core.lib.AbstractWorkflowComponent

checkRequiredConfigProperty, getBridge, getContainer, getId, getLocation, invoke, invoke, postInvoke, preInvoke, setContainer, setId, setLocation, setSkipOnErrors

Methods inherited from class java.lang.Object

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

Field Detail

expand

protected String expand

Since:

1.4

advices

protected final List<String> advices

Since:

1.4

extensionAdvices

protected final List<String> extensionAdvices

Since:

1.4

Constructor Detail

Generator

public Generator()

Method Detail

setAutomaticHyphens

public void setAutomaticHyphens(boolean automaticHyphens)

Enables or disables the automatic hyphenation. If automatic hyphenation is enabled, redundant blank lines are avoided automatically.

Parameters:

automaticHyphens - If true, automatic hyphenation is enabled, otherwise disabled.

getLogMessage

public String getLogMessage()

Specified by:

getLogMessage in interface org.eclipse.emf.mwe.core.WorkflowComponentWithID

Overrides:

getLogMessage in class org.eclipse.emf.mwe.core.lib.AbstractWorkflowComponent

See Also:

AbstractWorkflowComponent.getLogMessage()

addAdvice

public void addAdvice(String advice)

Adds an advice.

Overrides:

addAdvice in class AbstractExpressionsUsingWorkflowComponent

Parameters:

advice - the advice

addExtensionAdvice

public void addExtensionAdvice(String extensionAdvice)

Adds an extension advice.

Overrides:

addExtensionAdvice in class AbstractExpressionsUsingWorkflowComponent

Parameters:

extensionAdvice - the extension advice

getBeautifier

@Deprecated
public List<? extends PostProcessor> getBeautifier()

Deprecated. Will be removed in 2.0

Returns the list of beautifiers that will be applied to the generated output.

Returns:

list of beautifiers

setBeautifier

@Deprecated
public void setBeautifier(List<? extends PostProcessor> beautifiers)

Deprecated. Configure PostProcessors per Outlet

Sets the list of beautifiers that will be applied to the generated output.

Parameters:

beautifiers - list of beautifiers

setFileEncoding

public void setFileEncoding(String fileEncoding)

Sets the character encoding used for the output file.

Parameters:

fileEncoding - name of character encoding

getFileEncoding

public String getFileEncoding()

Returns the name of character encoding used for the output file.

Returns:

name of character encoding

setGenPath

@Deprecated
public void setGenPath(String genPath)

Deprecated. use addOutlet(Outlet) instead

Sets the path for always generated sources. This will create two Outlets for this path: The default outlet, and an Outlet with name "APPEND" and setting append=true

setExpand

public void setExpand(String invoke)

Sets the statement that is to expand by the generator.

Parameters:

invoke - statement to expand

setPrDefaultExcludes

public void setPrDefaultExcludes(boolean prDefaultExcludes)

Enables oder disables the default excludes for protected regions.

Parameters:

prDefaultExcludes - If true, the default excludes are enabled, otherwise disabled.

setPrExcludes

public void setPrExcludes(String prExcludes)

Sets the additional excludes for protected regions.

Parameters:

prExcludes - the excludes

setPrSrcPaths

public void setPrSrcPaths(String prSrcPathes)

Sets the source paths for protected regions.

Parameters:

prSrcPathes - the source paths

getComponentName

public String getComponentName()

Specified by:

getComponentName in interface org.eclipse.emf.mwe.core.WorkflowComponent

Overrides:

getComponentName in class org.eclipse.emf.mwe.core.lib.AbstractWorkflowComponent

See Also:

AbstractWorkflowComponent.getComponentName()

setSrcPath

@Deprecated
public void setSrcPath(String srcPath)

Deprecated. use outlets instead

invokeInternal2

protected void invokeInternal2(org.eclipse.emf.mwe.core.WorkflowContext ctx,
                               org.eclipse.emf.mwe.core.monitor.ProgressMonitor monitor,
                               org.eclipse.emf.mwe.core.issues.Issues issues)

Overrides:

invokeInternal2 in class AbstractExpressionsUsingWorkflowComponent

createExecutionContext

protected XpandExecutionContext createExecutionContext(org.eclipse.emf.mwe.core.WorkflowContext wfContext,
                                                       org.eclipse.emf.mwe.core.monitor.ProgressMonitor monitor,
                                                       org.eclipse.emf.mwe.core.issues.Issues issues)

Creates the execution context that is used for evaluation of the Xpand generator.

Since:

1.4

getProtectedRegionResolver

protected ProtectedRegionResolver getProtectedRegionResolver()

addOutlet

public void addOutlet(Outlet outlet)

Adds an outlet.

Parameters:

outlet - the outlet

setOutput

public void setOutput(Output output)

Sets the output.

Parameters:

output - the output

getOutput

protected final Output getOutput()

Since:

1.4

getOutlets

public final List<Outlet> getOutlets()

Retrieves the configured and initialized outlets of the generator.

getStatement

protected final ExpandStatement getStatement()

Since:

1.4

checkConfigurationInternal

protected void checkConfigurationInternal(org.eclipse.emf.mwe.core.issues.Issues issues)

Overrides:

checkConfigurationInternal in class AbstractExpressionsUsingWorkflowComponent

createOutput

protected Output createOutput()

Creates an Output instance.

Returns:

Instance of OutputImpl. Setting automaticHyphens will be considered.

Since:

1.4

createOutlet

protected Outlet createOutlet()

Creates an Outlet instance.

Since:

1.4