Package org.eclipse.xtext.generator
Class OutputConfiguration
- java.lang.Object
-
- org.eclipse.xtext.generator.OutputConfiguration
-
public class OutputConfiguration extends java.lang.Object
- Since:
- 2.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OutputConfiguration.SourceMapping
Specifies the output folder for a source folder (may be null, in which case the output folder of the enclosingOutputConfiguration
is used).
-
Constructor Summary
Constructors Constructor Description OutputConfiguration(java.lang.String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getDescription()
java.lang.String
getName()
java.util.Set<java.lang.String>
getOutputDirectories()
The output directories returned are project relative, e.g.java.lang.String
getOutputDirectory()
java.lang.String
getOutputDirectory(java.lang.String sourceFolder)
java.util.Set<java.lang.String>
getSourceFolders()
The source folders returned are project relative, e.g.java.util.Set<OutputConfiguration.SourceMapping>
getSourceMappings()
int
hashCode()
boolean
isCanClearOutputDirectory()
boolean
isCleanUpDerivedResources()
boolean
isCreateOutputDirectory()
boolean
isHideSyntheticLocalVariables()
boolean
isInstallDslAsPrimarySource()
java.lang.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 it doesn't already exist.void
setDescription(java.lang.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(java.lang.Boolean keepLocalHistory)
whether local history should be kept for generated files.void
setOutputDirectory(java.lang.String outputDirectory)
the project relative path to the output directoryvoid
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 propertyvoid
setUseOutputPerSourceFolder(boolean useOutputPerSourceFolder)
Whether to allow specifying output directories on a per source folder basisjava.lang.String
toString()
-
-
-
Method Detail
-
getName
public java.lang.String getName()
-
getDescription
public java.lang.String getDescription()
-
setDescription
public void setDescription(java.lang.String description)
a description to be shown in the UI.
-
getOutputDirectory
public java.lang.String getOutputDirectory()
-
setOutputDirectory
public void setOutputDirectory(java.lang.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 it 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 whenisInstallDslAsPrimarySource()
is true.- Since:
- 2.4
-
isKeepLocalHistory
public java.lang.Boolean isKeepLocalHistory()
- Since:
- 2.5
-
setKeepLocalHistory
public void setKeepLocalHistory(java.lang.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 java.util.Set<OutputConfiguration.SourceMapping> getSourceMappings()
- Since:
- 2.6
-
getOutputDirectory
public java.lang.String getOutputDirectory(java.lang.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 java.util.Set<java.lang.String> getSourceFolders()
The source folders returned are project relative, e.g. "src" or "src/main/java"- Since:
- 2.6
-
getOutputDirectories
public java.util.Set<java.lang.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 classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-