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.

  • Method Details

    • getGlobalSettingsFile

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

    • setGlobalSettingsFile

      SettingsBuildingRequest setGlobalSettingsFile(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.

    • getProjectSettingsFile

      File getProjectSettingsFile()
      Gets the project settings file.
      Returns:
      The project settings file or null if none.
      Since:
      4.0.0

    • setProjectSettingsFile

      DefaultSettingsBuildingRequest setProjectSettingsFile(File projectSettingsFile)
      Sets the project settings file. A non-existent settings file is equivalent to empty settings.
      Parameters:
      projectSettingsFile - The project settings file, may be null to disable project settings.
      Returns:
      This request, never null.
      Since:
      4.0.0

    • getProjectSettingsSource

      SettingsSource getProjectSettingsSource()
      Gets the project settings source.
      Returns:
      The project settings source or null if none.
      Since:
      4.0.0

    • setProjectSettingsSource

      SettingsBuildingRequest setProjectSettingsSource(SettingsSource projectSettingsSource)
      Sets the project settings source.
      Parameters:
      projectSettingsSource - The project settings source, may be null to disable global settings.
      Returns:
      This request, never null.
      Since:
      4.0.0

    • getUserSettingsFile

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

    • setUserSettingsFile

      SettingsBuildingRequest setUserSettingsFile(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

      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(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

      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(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.