Class DefaultSettingsBuildingRequest

  • All Implemented Interfaces:
    SettingsBuildingRequest

    public class DefaultSettingsBuildingRequest
    extends java.lang.Object
    implements SettingsBuildingRequest
    Collects settings that control building of effective settings.
    Author:
    Benjamin Bentmann
    • Constructor Detail

      • DefaultSettingsBuildingRequest

        public DefaultSettingsBuildingRequest()
    • Method Detail

      • setGlobalSettingsFile

        public DefaultSettingsBuildingRequest setGlobalSettingsFile​(java.io.File globalSettingsFile)
        Description copied from interface: SettingsBuildingRequest
        Sets the global settings file. A non-existent settings file is equivalent to empty settings. If both user settings and global settings are given, the user settings take precedence.
        Specified by:
        setGlobalSettingsFile in interface SettingsBuildingRequest
        Parameters:
        globalSettingsFile - The global settings file, may be null to disable global settings.
        Returns:
        This request, never null.
      • setUserSettingsFile

        public DefaultSettingsBuildingRequest setUserSettingsFile​(java.io.File userSettingsFile)
        Description copied from interface: SettingsBuildingRequest
        Sets the user settings file. A non-existent settings file is equivalent to empty settings. If both a user settings file and a global settings file are given, the user settings take precedence.
        Specified by:
        setUserSettingsFile in interface SettingsBuildingRequest
        Parameters:
        userSettingsFile - The user settings file, may be null to disable user settings.
        Returns:
        This request, never null.
      • getSystemProperties

        public java.util.Properties getSystemProperties()
        Description copied from interface: SettingsBuildingRequest
        Gets the system properties to use for interpolation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.
        Specified by:
        getSystemProperties in interface SettingsBuildingRequest
        Returns:
        The system properties, never null.
      • setSystemProperties

        public DefaultSettingsBuildingRequest setSystemProperties​(java.util.Properties systemProperties)
        Description copied from interface: SettingsBuildingRequest
        Sets the system properties to use for interpolation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.
        Specified by:
        setSystemProperties in interface SettingsBuildingRequest
        Parameters:
        systemProperties - The system properties, may be null.
        Returns:
        This request, never null.
      • getUserProperties

        public java.util.Properties getUserProperties()
        Description copied from interface: SettingsBuildingRequest
        Gets the user properties to use for interpolation. The user properties have been configured directly by the user on his discretion, e.g. via the -Dkey=value parameter on the command line.
        Specified by:
        getUserProperties in interface SettingsBuildingRequest
        Returns:
        The user properties, never null.
      • setUserProperties

        public DefaultSettingsBuildingRequest setUserProperties​(java.util.Properties userProperties)
        Description copied from interface: SettingsBuildingRequest
        Sets the user properties to use for interpolation. The user properties have been configured directly by the user on his discretion, e.g. via the -Dkey=value parameter on the command line.
        Specified by:
        setUserProperties in interface SettingsBuildingRequest
        Parameters:
        userProperties - The user properties, may be null.
        Returns:
        This request, never null.