de.uka.ipd.sdq.beagle.core.facade

Class BeagleConfiguration

java.lang.Object

de.uka.ipd.sdq.beagle.core.facade.BeagleConfiguration

public class BeagleConfiguration
extends Object

Configures a whole execution of Beagle. Therefore contains all values needed to set up Beagle. The class defines meaningful default values for all its settings.

The configuration has two states: A set up state, during which values may be modified and a finalised state, in which the configuration is immutable and can only be used to obtain values. The transition from the set up state to the finalised state is done through finalise(). The inverse transition is not possible. Trying to perform an action that is not allowed for the momentary state results in an IllegalStateException being thrown.

Constructor Summary

Constructors

Constructor and Description
BeagleConfiguration(List<String> elements, File repositoryFile, File sourceStatementLinkFile, org.eclipse.jdt.core.IJavaProject javaProject) Constructs a new BeagleConfiguration using elements as the default elements to be measured.

Method Summary

Modifier and Type	Method and Description
void	finalise() Finalises this configuration, thus transitioning it into the finalised state.
List<String>	getElements() Returns the elements to be measured or null to indicate that everything in the repository file should be analysed.
org.eclipse.jdt.core.IJavaProject	getJavaProject() Gives the IJavaProject to analyse.
Set<LaunchConfiguration>	getLaunchConfigurations() Returns the LaunchConfigurations to use for the analysis.
File	getRepositoryFile() Returns the repository file that contains all elements that shall be analysed.
File	getSourceStatementLinkFile() Returns the file containing the model linking PCM elements to their positions in the source code.
Timeout	getTimeout() Returns the timeout to be used.
boolean	isFinal() Queries whether this configuration is in the finalised state.
void	setElements(List<String> elements) Sets the elements to be measured to elements.
void	setLaunchConfigurations(Set<LaunchConfiguration> launchConfigurations) Sets the LaunchConfigurations to use for the analysis.
void	setRepositoryFile(File repositoryFile) Sets the repository file containing the elements Beagle shall analyse.
void	setSourceStatementLinkFile(File sourceStatementLinkFile) Sets the file containing the model linking PCM elements to their positions in the source code.
void	setTimeout(Timeout timeout) Sets the timeout to be used to timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeagleConfiguration

public BeagleConfiguration(List<String> elements,
                           File repositoryFile,
                           File sourceStatementLinkFile,
                           org.eclipse.jdt.core.IJavaProject javaProject)

Constructs a new BeagleConfiguration using elements as the default elements to be measured.

Parameters:

elements - The elements to be measured or null to indicate that everything in repositoryFile should be analysed.

repositoryFile - The repository file to use. Must not be null.

sourceStatementLinkFile - The xml file containing the PCM Element Source Statement Link Model.

javaProject - the IJavaProject to analyse. Must not be null.

Method Detail

getJavaProject

public org.eclipse.jdt.core.IJavaProject getJavaProject()

Gives the IJavaProject to analyse.

Returns:

the IJavaProject to analyse.

getElements

public List<String> getElements()

Returns the elements to be measured or null to indicate that everything in the repository file should be analysed.

Returns:

The elements to be measured or null to indicate that everything in the repository file should be analysed.

setElements

public void setElements(List<String> elements)

Sets the elements to be measured to elements. null indicates that everything in the repository file should be analysed. This operation is only allowed in the set up state.

Parameters:

elements - The elements to be measured or null to indicate that everything in the repository file should be analysed.

Throws:

IllegalStateException - If this configuration is not in the set up state.

See Also:

getElements()

getTimeout

public Timeout getTimeout()

Returns the timeout to be used. The timeout describes the minimum time Beagle shall keep trying to find results while no perfect results were found.

Returns:

The timeout that will be used by Beagle.

setTimeout

public void setTimeout(Timeout timeout)

Sets the timeout to be used to timeout. The timeout describes the minimum time Beagle shall keep trying to find results while no perfect results were found. This operation is only allowed in the set up state.

Parameters:

timeout - The timeout to be used by Beagle.

Throws:

IllegalStateException - If this configuration is not in the set up state.

getLaunchConfigurations

public Set<LaunchConfiguration> getLaunchConfigurations()

Returns the LaunchConfigurations to use for the analysis.

Returns:

The LaunchConfigurations to use for the analysis.

setLaunchConfigurations

public void setLaunchConfigurations(Set<LaunchConfiguration> launchConfigurations)

Sets the LaunchConfigurations to use for the analysis. This operation is only allowed in the set up state.

Parameters:

launchConfigurations - The LaunchConfigurations to use for the analysis.

Throws:

IllegalStateException - If this configuration is not in the set up state.

getRepositoryFile

public File getRepositoryFile()

Returns the repository file that contains all elements that shall be analysed.

Returns:

The repository file Beagle will operate on.

setRepositoryFile

public void setRepositoryFile(File repositoryFile)

Sets the repository file containing the elements Beagle shall analyse. This operation is only allowed in the set up state.

Parameters:

repositoryFile - The pcm repository file containing all elements Beagle shall analyse. Must not be null.

Throws:

IllegalStateException - If this configuration is not in the set up state.

setSourceStatementLinkFile

public void setSourceStatementLinkFile(File sourceStatementLinkFile)

Sets the file containing the model linking PCM elements to their positions in the source code.

Parameters:

sourceStatementLinkFile - The XML file containing the PCM Source Statement Links Model.

getSourceStatementLinkFile

public File getSourceStatementLinkFile()

Returns the file containing the model linking PCM elements to their positions in the source code.

Returns:

The XML file containing the PCM Source Statement Links Model.

isFinal

public boolean isFinal()

Queries whether this configuration is in the finalised state.

Returns:

true if this configuration is in the finalised state, false if it’s in the set up state.

finalise

public void finalise()

Finalises this configuration, thus transitioning it into the finalised state. Calling this method when this configuration already is in the finalised state has no effect.