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, 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 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 in ExecutionEnvironmentConfiguration
      • setProfileConfiguration

        void setProfileConfiguration​(java.lang.String profileName,
                                     java.lang.String configurationOrigin)
                              throws java.lang.IllegalStateException
        Sets the effective profile configuration, unless the method overrideProfileConfiguration(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 in ExecutionEnvironmentConfiguration
      • getProfileName

        java.lang.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​(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()
      • isIgnoredByResolver

        boolean isIgnoredByResolver()
      • getAllKnownEEs

        java.util.Collection<ExecutionEnvironment> getAllKnownEEs()
        Returns:
        all known Execution Environments accessible for the same scope
      • ignoreExecutionEnvironment

        boolean ignoreExecutionEnvironment()