Package org.apache.maven.settings.building

Interface SettingsBuildingRequest

  • All Known Implementing Classes:
    DefaultSettingsBuildingRequest
    public interface SettingsBuildingRequest
    Collects settings that control the building of effective settings.
    Author:
    Benjamin Bentmann

    • Method Detail

      • getGlobalSettingsFile

        java.io.File getGlobalSettingsFile()
        Gets the global settings file.
        Returns:
        The global settings file or null if none.

      • setGlobalSettingsFile

        SettingsBuildingRequest setGlobalSettingsFile​(java.io.File globalSettingsFile)
        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.
        Parameters:
        globalSettingsFile - The global settings file, may be null to disable global settings.
        Returns:
        This request, never null.

      • getGlobalSettingsSource

        SettingsSource getGlobalSettingsSource()
        Gets the global settings source.
        Returns:
        The global settings source or null if none.

      • setGlobalSettingsSource

        SettingsBuildingRequest setGlobalSettingsSource​(SettingsSource globalSettingsSource)
        Sets the global settings source. If both user settings and a global settings are given, the user settings take precedence.
        Parameters:
        globalSettingsSource - The global settings source, may be null to disable global settings.
        Returns:
        This request, never null.

      • getUserSettingsFile

        java.io.File getUserSettingsFile()
        Gets the user settings file.
        Returns:
        The user settings file or null if none.

      • setUserSettingsFile

        SettingsBuildingRequest setUserSettingsFile​(java.io.File userSettingsFile)
        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.
        Parameters:
        userSettingsFile - The user settings file, may be null to disable user settings.
        Returns:
        This request, never null.

      • getUserSettingsSource

        SettingsSource getUserSettingsSource()
        Gets the user settings source.
        Returns:
        The user settings source or null if none.

      • setUserSettingsSource

        SettingsBuildingRequest setUserSettingsSource​(SettingsSource userSettingsSource)
        Sets the user settings source. If both user settings and a global settings are given, the user settings take precedence.
        Parameters:
        userSettingsSource - The user settings source, may be null to disable user settings.
        Returns:
        This request, never null.

      • getSystemProperties

        java.util.Properties getSystemProperties()
        Gets the system properties to use for interpolation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.
        Returns:
        The system properties, never null.

      • setSystemProperties

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

      • getUserProperties

        java.util.Properties getUserProperties()
        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.
        Returns:
        The user properties, never null.

      • setUserProperties

        SettingsBuildingRequest setUserProperties​(java.util.Properties userProperties)
        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.
        Parameters:
        userProperties - The user properties, may be null.
        Returns:
        This request, never null.