public class UnitConfiguration extends Object
Constructor and Description |
---|
UnitConfiguration() |
Modifier and Type | Method and Description |
---|---|
File |
getCacheDirectory()
Returns the cache directory where the generator can store internal files.
|
ClassLoader |
getClassLoader()
Returns the class loader to use by the generator when accessing
the templates or classes defined within the templates.
|
ConfigurationHandlers |
getConfigurationHandlers()
Returns the configuration handlers used to parse the configuration
of this generation unit.
|
String |
getDefaultOutputEncoding()
Returns the output encoding if no specific encoding has been set
in the output.
|
EntityReferences |
getEntityReferences()
Returns the entityReferences of the associated configuration unit.
|
Loglevel |
getLoglevel()
Returns the Loglevel during generation.
|
Options |
getOptions()
Returns the options of the associated configuration unit.
|
OutletConfiguration |
getOutletConfiguration()
Returns the configuration of the outlets in this generation unit.
|
File |
getOutputDirectory(String outputDirKey)
Returns the output directory for a given output directory key.
|
Map<String,File> |
getOutputDirectoryMap()
Returns the output directory map which contains the mapping
from output directory key to output directory.
|
List<Output> |
getOutputList()
Returns the list of output definitions of the associated configuration
unit.
|
SourceProvider |
getOverrideSourceProvider()
Returns the source provider which overrides the source provider defined
in the control file.
|
String |
getTemplateSetName()
Returns the name of the template set.
|
File |
getWorkDirectory()
Returns the work directory where the generator can store internal files.
|
boolean |
isAddDebuggingInfoToOutput()
Returns whether to add debug information to the output.
|
boolean |
isInit()
Checks whether the unit configuration is fully initialized.
|
boolean |
isRunOnlyOnSourceChange()
Returns true if only the sources should be processed which have
changed since last generation.
|
void |
setAddDebuggingInfoToOutput(boolean addDebuggingInfoToOutput)
Sets whether to add debug information to the output.
|
void |
setCacheDirectory(File cacheDirectory)
Sets the cache directory where the generator can store internal files.
|
void |
setClassLoader(ClassLoader classLoader)
Sets the class loader to use by the generator when accessing
the templates or classes defined within the templates.
|
void |
setConfigurationHandlers(ConfigurationHandlers configurationHandlers)
Sets the configuration handlers used to parse the configuration
of this generation unit.
|
void |
setDefaultOutputEncoding(String defaultOutputEncoding)
Sets the output encoding if no specific encoding has been set
in the output.
|
void |
setEntityReferences(EntityReferences entityReferences)
Sets the entityReferences of the associated configuration unit.
|
void |
setLoglevel(Loglevel loglevel)
Sets the Loglevel during generation.
|
void |
setOptions(Options options)
Sets the options of the associated configuration unit.
|
void |
setOutletConfiguration(OutletConfiguration outletConfiguration)
Sets the outlet configuration of the associated configuration unit.
|
void |
setOutputDirectoryMap(Map<String,File> outputDirectoryMap)
Sets the output directory map which contains the mapping
from output directory key to output directory.
|
void |
setOutputList(List<Output> outputList)
Sets the output activities of the associated configuration unit.
|
void |
setOverrideSourceProvider(SourceProvider overrideSourceProvider)
Sets the source provider which overrides the source provider defined
in the control file.
|
void |
setRunOnlyOnSourceChange(boolean runOnlyOnSourceChange)
Sets whether only the sources should be processed which have
changed since last generation.
|
void |
setTemplateSetName(String name)
Sets the name of the template set.
|
void |
setWorkDirectory(File workDirectory)
Sets the work directory where the generator can store internal files.
|
String |
toString() |
public OutletConfiguration getOutletConfiguration()
IllegalStateException
- if outletConfiguration was not set.public void setOutletConfiguration(OutletConfiguration outletConfiguration)
outletConfiguration
- the outlet configuration, not null.NullPointerException
- if outletConfiguration is null.public Options getOptions()
IllegalStateException
- if options were not yet set.public void setOptions(Options options)
options
- the options, not null.NullPointerException
- if options is null.public File getOutputDirectory(String outputDirKey)
outputDirKey
- the key which output directory should be returned.
Null represents the default output directory and is always
mapped to a non-null value.IllegalStateException
- if the default output directory
was not yet set.public Map<String,File> getOutputDirectoryMap()
IllegalStateException
- if no mapping is contained
for the key null.public void setOutputDirectoryMap(Map<String,File> outputDirectoryMap)
outputDirectoryMap
- the new output directory map,
must contain at least a mapping for the key null.NullPointerException
- if outputDirectoryMap is null.IllegalStateException
- if the target directory was not yet set.public File getWorkDirectory()
IllegalStateException
- if the target directory was not yet set.public void setWorkDirectory(File workDirectory)
workDirectory
- the work directory, not null.NullPointerException
- if workDirectory is null.public File getCacheDirectory()
IllegalStateException
- if the target directory was not yet set.public void setCacheDirectory(File cacheDirectory)
cacheDirectory
- the work directory, not null.NullPointerException
- if workDirectory is null.public void setOutputList(List<Output> outputList)
outputList
- the output activities, not null.NullPointerException
- if outputFiles is null.public List<Output> getOutputList()
IllegalStateException
- if the output definitions were not yet set.public Loglevel getLoglevel()
IllegalStateException
- if the loglevel is not yet set.public void setLoglevel(Loglevel loglevel)
loglevel
- the Loglevel, not null.NullPointerException
- if loglevel is set to null.public boolean isAddDebuggingInfoToOutput()
public void setAddDebuggingInfoToOutput(boolean addDebuggingInfoToOutput)
addDebuggingInfoToOutput
- true if debug information should be
added, false otherwise.public ConfigurationHandlers getConfigurationHandlers()
IllegalStateException
- if configurationHandlers was not set.public void setConfigurationHandlers(ConfigurationHandlers configurationHandlers)
configurationHandlers
- the configuration handlers, not null.NullPointerException
- if configurationHandlers is null.public SourceProvider getOverrideSourceProvider()
NullPointerException
- if overrideSourceFileset was not yet set.public void setOverrideSourceProvider(SourceProvider overrideSourceProvider)
overrideSourceProvider
- the override source provider, or null
to use the source provider defined in the control file.public EntityReferences getEntityReferences()
IllegalStateException
- if entityReferences were not yet set.public void setEntityReferences(EntityReferences entityReferences)
entityReferences
- the entityReferences, not null.NullPointerException
- if entityReferences is null.public String getDefaultOutputEncoding()
public void setDefaultOutputEncoding(String defaultOutputEncoding)
defaultOutputEncoding
- the default output encoding,
null for the default platform encoding.public ClassLoader getClassLoader()
public void setClassLoader(ClassLoader classLoader)
classLoader
- the class loader for the templates,
or null if the standard class loader
of the torque generator classes should be used.public boolean isRunOnlyOnSourceChange()
public void setRunOnlyOnSourceChange(boolean runOnlyOnSourceChange)
runOnlyOnSourceChange
- false if the controller should be run
irrespective of changes in the source files,
true if the controller should be run for source files
which have changed during last generation.public String getTemplateSetName()
public void setTemplateSetName(String name)
name
- the name of the template set.public boolean isInit()
Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.