DefaultSettingsBuildingRequest (Apache Maven 3.1.1 API)

java.lang.Object
- org.apache.maven.settings.building.DefaultSettingsBuildingRequest

All Implemented Interfaces:

SettingsBuildingRequest
```
public class DefaultSettingsBuildingRequest
extends Object
implements SettingsBuildingRequest
```
Collects settings that control building of effective settings.

Author:

Benjamin Bentmann

Constructor Summary

Constructors
Constructor and Description

DefaultSettingsBuildingRequest()

Constructors
Constructor and Description
`DefaultSettingsBuildingRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`File`	`getGlobalSettingsFile()` Gets the global settings file.
`SettingsSource`	`getGlobalSettingsSource()` Gets the global settings source.
`Properties`	`getSystemProperties()` Gets the system properties to use for interpolation.
`Properties`	`getUserProperties()` Gets the user properties to use for interpolation.
`File`	`getUserSettingsFile()` Gets the user settings file.
`SettingsSource`	`getUserSettingsSource()` Gets the user settings source.
`DefaultSettingsBuildingRequest`	`setGlobalSettingsFile(File globalSettingsFile)` Sets the global settings file.
`DefaultSettingsBuildingRequest`	`setGlobalSettingsSource(SettingsSource globalSettingsSource)` Sets the global settings source.
`DefaultSettingsBuildingRequest`	`setSystemProperties(Properties systemProperties)` Sets the system properties to use for interpolation.
`DefaultSettingsBuildingRequest`	`setUserProperties(Properties userProperties)` Sets the user properties to use for interpolation.
`DefaultSettingsBuildingRequest`	`setUserSettingsFile(File userSettingsFile)` Sets the user settings file.
`DefaultSettingsBuildingRequest`	`setUserSettingsSource(SettingsSource userSettingsSource)` Sets the user settings source.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultSettingsBuildingRequest
```
public DefaultSettingsBuildingRequest()
```
- Method Detail
  - getGlobalSettingsFile
```
public File getGlobalSettingsFile()
```
    Description copied from interface: SettingsBuildingRequest
    
    Gets the global settings file.
    
    Specified by:
    
    getGlobalSettingsFile in interface SettingsBuildingRequest
    
    Returns:
    The global settings file or null if none.
  - setGlobalSettingsFile
```
public DefaultSettingsBuildingRequest setGlobalSettingsFile(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.
  - getGlobalSettingsSource
```
public SettingsSource getGlobalSettingsSource()
```
    Description copied from interface: SettingsBuildingRequest
    
    Gets the global settings source.
    
    Specified by:
    
    getGlobalSettingsSource in interface SettingsBuildingRequest
    
    Returns:
    The global settings source or null if none.
  - setGlobalSettingsSource
```
public DefaultSettingsBuildingRequest setGlobalSettingsSource(SettingsSource globalSettingsSource)
```
    Description copied from interface: SettingsBuildingRequest
    
    Sets the global settings source. If both user settings and a global settings are given, the user settings take precedence.
    
    Specified by:
    
    setGlobalSettingsSource in interface SettingsBuildingRequest
    
    Parameters:
    globalSettingsSource - The global settings source, may be null to disable global settings.
    
    Returns:
    This request, never null.
  - getUserSettingsFile
```
public File getUserSettingsFile()
```
    Description copied from interface: SettingsBuildingRequest
    
    Gets the user settings file.
    
    Specified by:
    
    getUserSettingsFile in interface SettingsBuildingRequest
    
    Returns:
    The user settings file or null if none.
  - setUserSettingsFile
```
public DefaultSettingsBuildingRequest setUserSettingsFile(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.
  - getUserSettingsSource
```
public SettingsSource getUserSettingsSource()
```
    Description copied from interface: SettingsBuildingRequest
    
    Gets the user settings source.
    
    Specified by:
    
    getUserSettingsSource in interface SettingsBuildingRequest
    
    Returns:
    The user settings source or null if none.
  - setUserSettingsSource
```
public DefaultSettingsBuildingRequest setUserSettingsSource(SettingsSource userSettingsSource)
```
    Description copied from interface: SettingsBuildingRequest
    
    Sets the user settings source. If both user settings and a global settings are given, the user settings take precedence.
    
    Specified by:
    
    setUserSettingsSource in interface SettingsBuildingRequest
    
    Parameters:
    userSettingsSource - The user settings source, may be null to disable user settings.
    
    Returns:
    This request, never null.
  - getSystemProperties
```
public 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(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 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(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.

Class DefaultSettingsBuildingRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultSettingsBuildingRequest

Method Detail

getGlobalSettingsFile

setGlobalSettingsFile

getGlobalSettingsSource

setGlobalSettingsSource

getUserSettingsFile

setUserSettingsFile

getUserSettingsSource

setUserSettingsSource

getSystemProperties

setSystemProperties

getUserProperties

setUserProperties