Module org.eclipse.tycho.embedder.shared

Package org.eclipse.tycho

Interface ExecutionEnvironmentConfiguration

public interface ExecutionEnvironmentConfiguration

Instances of this type collect information on the execution environment a project is targeted to. Since there are multiple ways to configure the execution environment, and some of them are project type specific, it is explicitly allowed to call the configuration setters of an instance multiple times. In order to ensure that all configuration sources are taken into account, IllegalStateExceptions are thrown if the configuration setters are called too late, i.e. after the effective configuration has been queried for the first time.

In case of an custom execution environment, the information required for the build can not be directly computed from the configuration. Therefore, this instance also has a callback to add the missing information as soon as it has been extracted from the target platform.

Method Summary

Modifier and Type	Method	Description
Collection<ExecutionEnvironment>	getAllKnownEEs()
ExecutionEnvironment	getFullSpecification()	Returns the execution environment specification with information needed for the build.
String	getProfileName()	Returns the name of the configured profile.
boolean	ignoreExecutionEnvironment()
boolean	isCustomProfile()	Returns true if the configured profile is not one of the known standard execution environments.
boolean	isIgnoredByResolver()
default boolean	isResolveWithEEConstraints()
void	overrideProfileConfiguration(String profileName, String configurationOrigin)	Sets the effective profile configuration.
void	setFullSpecificationForCustomProfile(List<SystemCapability> systemCapabilities)	Call-back for setting the actual specification for the configured custom profile.
void	setProfileConfiguration(String profileName, String configurationOrigin)	Sets the effective profile configuration, unless the method overrideProfileConfiguration(String, String) has been called on this instance.

Method Details

overrideProfileConfiguration

void overrideProfileConfiguration(String profileName,
 String configurationOrigin)
                           throws IllegalStateException

Sets the effective profile configuration.

Throws:

IllegalStateException - if the configuration has been already frozen by calling any one of the getters defined in ExecutionEnvironmentConfiguration

setProfileConfiguration

void setProfileConfiguration(String profileName,
 String configurationOrigin)
                      throws IllegalStateException

Sets the effective profile configuration, unless the method overrideProfileConfiguration(String, String) has been called on this instance.

Throws:

IllegalStateException - if the configuration has been already frozen by calling any one of the getters defined in ExecutionEnvironmentConfiguration

getProfileName

String getProfileName()

Returns the name of the configured profile.

isCustomProfile

boolean isCustomProfile()

Returns true if the configured profile is not one of the known standard execution environments.

setFullSpecificationForCustomProfile

void setFullSpecificationForCustomProfile(List<SystemCapability> systemCapabilities)
                                   throws IllegalStateException

Call-back for setting the actual specification for the configured custom profile. The specification, e.g. the list of provided packages, is read from the target platform.

Throws:

IllegalStateException - if the configured execution environment profile is not a custom profile

See Also:

• isCustomProfile()

getFullSpecification

ExecutionEnvironment getFullSpecification()
                                   throws IllegalStateException

Returns the execution environment specification with information needed for the build.

Throws:

IllegalStateException - if a custom execution environment profile has been configure, and setFullSpecificationForCustomProfile(List) has not been called.

See Also:

• ExecutionEnvironment

isIgnoredByResolver

boolean isIgnoredByResolver()

isResolveWithEEConstraints

default boolean isResolveWithEEConstraints()

getAllKnownEEs

Collection<ExecutionEnvironment> getAllKnownEEs()

Returns:

all known Execution Environments accessible for the same scope

ignoreExecutionEnvironment

boolean ignoreExecutionEnvironment()