Interface ExecutionEnvironmentConfiguration
-
- All Known Implementing Classes:
ExecutionEnvironmentConfigurationImpl
,ExecutionEnvironmentConfigurationStub
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,
IllegalStateException
s 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ExecutionEnvironment
getFullSpecification()
Returns the execution environment specification with information needed for the build.java.lang.String
getProfileName()
Returns the name of the configured profile.boolean
isCustomProfile()
Returnstrue
if the configured profile is not one of the known standard execution environments.boolean
isIgnoredByResolver()
void
overrideProfileConfiguration(java.lang.String profileName, java.lang.String configurationOrigin)
Sets the effective profile configuration.void
setFullSpecificationForCustomProfile(java.util.List<SystemCapability> systemCapabilities)
Call-back for setting the actual specification for the configured custom profile.void
setProfileConfiguration(java.lang.String profileName, java.lang.String configurationOrigin)
Sets the effective profile configuration, unless the methodoverrideProfileConfiguration(String, String)
has been called on this instance.
-
-
-
Method Detail
-
overrideProfileConfiguration
void overrideProfileConfiguration(java.lang.String profileName, java.lang.String configurationOrigin) throws java.lang.IllegalStateException
Sets the effective profile configuration.- Throws:
java.lang.IllegalStateException
- if the configuration has been already frozen by calling any one of the getters defined inExecutionEnvironmentConfiguration
-
setProfileConfiguration
void setProfileConfiguration(java.lang.String profileName, java.lang.String configurationOrigin) throws java.lang.IllegalStateException
Sets the effective profile configuration, unless the methodoverrideProfileConfiguration(String, String)
has been called on this instance.- Throws:
java.lang.IllegalStateException
- if the configuration has been already frozen by calling any one of the getters defined inExecutionEnvironmentConfiguration
-
getProfileName
java.lang.String getProfileName()
Returns the name of the configured profile.
-
isCustomProfile
boolean isCustomProfile()
Returnstrue
if the configured profile is not one of the known standard execution environments.
-
setFullSpecificationForCustomProfile
void setFullSpecificationForCustomProfile(java.util.List<SystemCapability> systemCapabilities) throws java.lang.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:
java.lang.IllegalStateException
- if the configured execution environment profile is not a custom profile- See Also:
isCustomProfile()
-
getFullSpecification
ExecutionEnvironment getFullSpecification() throws java.lang.IllegalStateException
Returns the execution environment specification with information needed for the build.- Throws:
java.lang.IllegalStateException
- if a custom execution environment profile has been configure, andsetFullSpecificationForCustomProfile(List)
has not been called.- See Also:
ExecutionEnvironment
-
isIgnoredByResolver
boolean isIgnoredByResolver()
-
-