org.eclipse.xtext.generator

Class OutputConfiguration

java.lang.Object

org.eclipse.xtext.generator.OutputConfiguration

public class OutputConfiguration
extends Object

Since:

2.1

Author:

Sven Efftinge - Initial contribution and API

Property Summary

Properties

Type	Property and Description
boolean	isSetDerived

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutputConfiguration.SourceMapping Specifies the output folder for a source folder (may be null, in which case the output folder of the enclosing OutputConfiguration is used).

Constructor Summary

Constructors

Constructor and Description
OutputConfiguration(String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription()
String	getName()
Set<String>	getOutputDirectories() The output directories returned are project relative, e.g.
String	getOutputDirectory()
String	getOutputDirectory(String sourceFolder)
Set<String>	getSourceFolders() The source folders returned are project relative, e.g.
Set<OutputConfiguration.SourceMapping>	getSourceMappings()
int	hashCode()
boolean	isCanClearOutputDirectory()
boolean	isCleanUpDerivedResources()
boolean	isCreateOutputDirectory()
boolean	isHideSyntheticLocalVariables()
boolean	isInstallDslAsPrimarySource()
Boolean	isKeepLocalHistory()
boolean	isOverrideExistingResources()
boolean	isSetDerivedProperty()
boolean	isUseOutputPerSourceFolder()
void	setCanClearOutputDirectory(boolean canClearOutputDirectory) whether the whole outputDirectory can be cleared.
void	setCleanUpDerivedResources(boolean cleanUpDerivedResources) whether derived resources should be deleted on clean.
void	setCreateOutputDirectory(boolean createOutputDirectory) whether the output directory should be created if t doesn't already exist.
void	setDescription(String description) a description to be shown in the UI.
void	setHideSyntheticLocalVariables(boolean hideSyntheticLocalVariables) whether debug information should be removed from the class files for synthetic local variables.
void	setInstallDslAsPrimarySource(boolean installDslAsPrimarySource) whether the DSL files should be registered as primary source files for debugging in the generated Java-class-files.
void	setKeepLocalHistory(Boolean keepLocalHistory) whether local history should be kept for generated files.
void	setOutputDirectory(String outputDirectory) the project relative path to the output directory
void	setOverrideExistingResources(boolean overrideExistingResources) whether existing resources should be overridden.
void	setSetDerivedProperty(boolean setDerivedProperty) whether the resources should be flagged as 'derived' Only used if the underlying file system implementation supports such a property
void	setUseOutputPerSourceFolder(boolean useOutputPerSourceFolder) Whether to allow specifying output directories on a per source folder basis
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Property Detail

isSetDerived

Constructor Detail

OutputConfiguration

public OutputConfiguration(String name)

Parameters:

name - - a unique name identifying this outlet configuration.

Method Detail

getName

public String getName()

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

a description to be shown in the UI.

getOutputDirectory

public String getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

the project relative path to the output directory

isCleanUpDerivedResources

public boolean isCleanUpDerivedResources()

setCleanUpDerivedResources

public void setCleanUpDerivedResources(boolean cleanUpDerivedResources)

whether derived resources should be deleted on clean.

isOverrideExistingResources

public boolean isOverrideExistingResources()

setOverrideExistingResources

public void setOverrideExistingResources(boolean overrideExistingResources)

whether existing resources should be overridden.

isSetDerivedProperty

public boolean isSetDerivedProperty()

setSetDerivedProperty

public void setSetDerivedProperty(boolean setDerivedProperty)

whether the resources should be flagged as 'derived' Only used if the underlying file system implementation supports such a property

isCreateOutputDirectory

public boolean isCreateOutputDirectory()

setCreateOutputDirectory

public void setCreateOutputDirectory(boolean createOutputDirectory)

whether the output directory should be created if t doesn't already exist.

isCanClearOutputDirectory

public boolean isCanClearOutputDirectory()

setCanClearOutputDirectory

public void setCanClearOutputDirectory(boolean canClearOutputDirectory)

whether the whole outputDirectory can be cleared. This is usually used in a CLEAN build.

isInstallDslAsPrimarySource

public boolean isInstallDslAsPrimarySource()

Since:

2.4

setInstallDslAsPrimarySource

public void setInstallDslAsPrimarySource(boolean installDslAsPrimarySource)

whether the DSL files should be registered as primary source files for debugging in the generated Java-class-files. If false, the Java source is registered as primary source and the DSL files are registered as secondary source via JSR-045 (SMAP).

Since:

2.4

isHideSyntheticLocalVariables

public boolean isHideSyntheticLocalVariables()

Since:

2.4

setHideSyntheticLocalVariables

public void setHideSyntheticLocalVariables(boolean hideSyntheticLocalVariables)

whether debug information should be removed from the class files for synthetic local variables. Synthetic variables are the ones that have not been declared in the DSL but have been introduced by the compiler. This flag is only used when isInstallDslAsPrimarySource() is true.

Since:

2.4

isKeepLocalHistory

public Boolean isKeepLocalHistory()

Since:

2.5

setKeepLocalHistory

public void setKeepLocalHistory(Boolean keepLocalHistory)

whether local history should be kept for generated files.

Since:

2.5

isUseOutputPerSourceFolder

public boolean isUseOutputPerSourceFolder()

Since:

2.6

setUseOutputPerSourceFolder

public void setUseOutputPerSourceFolder(boolean useOutputPerSourceFolder)

Whether to allow specifying output directories on a per source folder basis

Since:

2.6

getSourceMappings

public Set<OutputConfiguration.SourceMapping> getSourceMappings()

Since:

2.6

getOutputDirectory

public String getOutputDirectory(String sourceFolder)

Parameters:

sourceFolder - the project relative source folder, e.g. "src" or "src/main/java"

Returns:

the project relative output directory

Since:

2.6

getSourceFolders

public Set<String> getSourceFolders()

The source folders returned are project relative, e.g. "src" or "src/main/java"

Since:

2.6

getOutputDirectories

public Set<String> getOutputDirectories()

The output directories returned are project relative, e.g. "build/gen" or "src-gen"

Since:

2.6

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object