com.sodius.mdw.core.eval.launch
Interface LaunchConfiguration

All Superinterfaces:
EvaluationConfiguration

public interface LaunchConfiguration
extends EvaluationConfiguration

A launch configuration defines a complete set of properties to launch a text template or a main rule evaluation.

This interface is not intended to be implemented by clients.

See Also:
EvaluationManager.loadLaunchConfiguration(File), EvaluationManager.evaluate(LaunchConfiguration, ProgressMonitor), LaunchRunner

Method Summary
 File getDebugHierarchyFile()
          Returns the file where the debug hierarchy created during the evaluation must be persisted.
 LaunchEntryPoint getEntryPoint()
          Returns the referenced entry-point, which can either be a text template or a main rule.
 File getFile()
          Returns the file where this launch configuration is saved.
 String getName()
          Returns the launch configuration name, which matches the Eclipse launch configuration.
 File getProjectClasspathFile()
          Returns the location of the file defining the required project classpath.
 File getReportFile()
          Returns the file where the report created during the evaluation must be persisted.
 void save(File file)
          Saves this launch configuration into the specified file.
 void setDebugHierarchyFile(File file)
          Sets the file where the debug hierarchy created during the evaluation must be persisted.
 void setName(String name)
          Sets the launch configuration name.
 void setReportFile(File file)
          Sets the file where the report created during the evaluation must be persisted.
 
Methods inherited from interface com.sodius.mdw.core.eval.EvaluationConfiguration
getEvaluationDirectory, isDebugHierarchyEnabled, isFileOverwriteForced, setDebugHierarchyEnabled, setEvaluationDirectory, setFileOverwriteForced
 

Method Detail

getName

String getName()
Returns the launch configuration name, which matches the Eclipse launch configuration.

Returns:
the launch configuration name.

getFile

File getFile()
Returns the file where this launch configuration is saved.

Returns:
the file where this launch configuration is saved, null if no saved in a file.

setName

void setName(String name)
Sets the launch configuration name.

Parameters:
name - the launch configuration name.

getProjectClasspathFile

File getProjectClasspathFile()
Returns the location of the file defining the required project classpath.

Returns:
the file defining the project classpath.

getEntryPoint

LaunchEntryPoint getEntryPoint()
Returns the referenced entry-point, which can either be a text template or a main rule.

Returns:
the launch entry point.

getDebugHierarchyFile

File getDebugHierarchyFile()
Returns the file where the debug hierarchy created during the evaluation must be persisted.

Returns:
the file where to store the debug hierarchy, null if no debug hierarchy requested.

setDebugHierarchyFile

void setDebugHierarchyFile(File file)
Sets the file where the debug hierarchy created during the evaluation must be persisted.

If this file is null, then no debug hierarchy is created. Otherwise, setting a file will override the isDebugHierarchyEnabled method to force the workbench to create a debug hierarchy.

Parameters:
file - the file where to store the debug hierarchy, null if no debug hierarchy requested.
See Also:
EvaluationConfiguration.isDebugHierarchyEnabled()

getReportFile

File getReportFile()
Returns the file where the report created during the evaluation must be persisted.

Returns:
the file where to store the created evaluation report, null if the report must not be saved.

setReportFile

void setReportFile(File file)
Sets the file where the report created during the evaluation must be persisted.

Parameters:
file - the file where to store the created evaluation report, null if the report must not be saved.

save

void save(File file)
          throws CoreException
Saves this launch configuration into the specified file.

Parameters:
file - the file where to store this launch configuration.
Throws:
CoreException - if the configuration could not be saved.