DefaultInvocationRequest (Apache Maven Invoker 3.0.1 API)

java.lang.Object
- org.apache.maven.shared.invoker.DefaultInvocationRequest

All Implemented Interfaces:

InvocationRequest
```
public class DefaultInvocationRequest
extends Object
implements InvocationRequest
```
Specifies the parameters used to control a Maven invocation.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.maven.shared.invoker.InvocationRequest
  InvocationRequest.CheckSumPolicy, InvocationRequest.ReactorFailureBehavior

Field Summary
- Fields inherited from interface org.apache.maven.shared.invoker.InvocationRequest
  NO_TIMEOUT

Constructor Summary

Constructors
Constructor and Description

DefaultInvocationRequest()

Constructors
Constructor and Description
`DefaultInvocationRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InvocationRequest`	`addShellEnvironment(String name, String value)` Adds the specified environment variable to the Maven invocation.
`File`	`getBaseDirectory()` Gets the path to the base directory of the POM for the Maven invocation.
`File`	`getBaseDirectory(File defaultDirectory)` Gets the path to the base directory of the POM for the Maven invocation.
`String`	`getBuilder()` Get the current set builder strategy id equivalent of `--builder id`.
`InvocationOutputHandler`	`getErrorHandler(InvocationOutputHandler defaultHandler)` Gets the handler used to capture the error output from the Maven build.
`InvocationRequest.CheckSumPolicy`	`getGlobalChecksumPolicy()` Gets the checksum mode of the Maven invocation.
`File`	`getGlobalSettingsFile()` Gets the path to the global settings for the Maven invocation.
`File`	`getGlobalToolchainsFile()` Alternate path for the global toolchains file Note.
`List<String>`	`getGoals()` Gets the goals for the Maven invocation.
`InputStream`	`getInputStream(InputStream defaultStream)` Gets the input stream used to provide input for the invoked Maven build.
`File`	`getJavaHome()` Gets the path to the base directory of the Java installation used to run Maven.
`File`	`getLocalRepositoryDirectory(File defaultDirectory)` Gets the path to the base directory of the local repository to use for the Maven invocation.
`String`	`getMavenOpts()` Gets the value of the `MAVEN_OPTS` environment variable.
`InvocationOutputHandler`	`getOutputHandler(InvocationOutputHandler defaultHandler)` Gets the handler used to capture the standard output from the Maven build.
`File`	`getPomFile()` Gets the path to the POM for the Maven invocation.
`String`	`getPomFileName()` Gets the (unqualified) filename of the POM for the Maven invocation.
`List<String>`	`getProfiles()` Gets the profiles for the Maven invocation.
`List<String>`	`getProjects()` A list of specified reactor projects to build instead of all projects.
`Properties`	`getProperties()` Gets the system properties for the Maven invocation.
`InvocationRequest.ReactorFailureBehavior`	`getReactorFailureBehavior()` Gets the failure mode of the Maven invocation.
`String`	`getResumeFrom()` Get the value of `resume-from`
`Map<String,String>`	`getShellEnvironments()` Gets the environment variables for the Maven invocation.
`String`	`getThreads()` Get the value of the `threads` argument.
`int`	`getTimeoutInSeconds()`
`File`	`getToolchainsFile()` Gets the path to the custom toolchains file
`File`	`getUserSettingsFile()` Gets the path to the user settings for the Maven invocation.
`boolean`	`isAlsoMake()` Get the value of the `also-make` argument.
`boolean`	`isAlsoMakeDependents()` Get the value of the `also-make-dependents`
`boolean`	`isBatchMode()` By default, Maven is executed in batch mode.
`boolean`	`isDebug()` Gets the debug mode of the Maven invocation.
`boolean`	`isNonPluginUpdates()` Indicates whether Maven should check for plugin updates.
`boolean`	`isOffline()` Gets the network mode of the Maven invocation.
`boolean`	`isRecursive()` Gets the recursion behavior of a reactor invocation.
`boolean`	`isShellEnvironmentInherited()` Indicates whether the environment variables of the current process should be propagated to the Maven invocation.
`boolean`	`isShowErrors()` Gets the exception output mode of the Maven invocation.
`boolean`	`isShowVersion()` The show version behavior (-V option)
`boolean`	`isUpdateSnapshots()` Indicates whether Maven should enforce an update check for plugins and snapshots.
`InvocationRequest`	`setAlsoMake(boolean alsoMake)` Enable the 'also make' mode.
`InvocationRequest`	`setAlsoMakeDependents(boolean alsoMakeDependents)` Enable the 'also make dependents' mode.
`InvocationRequest`	`setBaseDirectory(File basedir)` Sets the path to the base directory of the POM for the Maven invocation.
`InvocationRequest`	`setBatchMode(boolean interactive)` Sets the interaction mode of the Maven invocation.
`InvocationRequest`	`setBuilder(String id)` The id of the build strategy to use.
`InvocationRequest`	`setDebug(boolean debug)` Sets the debug mode of the Maven invocation.
`InvocationRequest`	`setErrorHandler(InvocationOutputHandler errorHandler)` Sets the handler used to capture the error output from the Maven build.
`InvocationRequest`	`setGlobalChecksumPolicy(InvocationRequest.CheckSumPolicy globalChecksumPolicy)` Sets the checksum mode of the Maven invocation.
`InvocationRequest`	`setGlobalSettingsFile(File globalSettings)` Sets the path to the global settings for the Maven invocation.
`InvocationRequest`	`setGlobalToolchainsFile(File toolchains)` Sets the alternate path for the global toolchains file Equivalent of `-gt` or `--global-toolchains`
`InvocationRequest`	`setGoals(List<String> goals)` Sets the goals for the Maven invocation.
`InvocationRequest`	`setInputStream(InputStream inputStream)` Sets the input stream used to provide input for the invoked Maven build.
`InvocationRequest`	`setJavaHome(File javaHome)` Sets the path to the base directory of the Java installation used to run Maven.
`InvocationRequest`	`setLocalRepositoryDirectory(File localRepository)` Sets the path to the base directory of the local repository to use for the Maven invocation.
`InvocationRequest`	`setMavenOpts(String mavenOpts)` Sets the value of the `MAVEN_OPTS` environment variable.
`InvocationRequest`	`setNonPluginUpdates(boolean nonPluginUpdates)` Specifies whether Maven should check for plugin updates.
`InvocationRequest`	`setOffline(boolean offline)` Sets the network mode of the Maven invocation.
`InvocationRequest`	`setOutputHandler(InvocationOutputHandler outputHandler)` Sets the handler used to capture the standard output from the Maven build.
`InvocationRequest`	`setPomFile(File pomFile)` Sets the path to the POM for the Maven invocation.
`InvocationRequest`	`setPomFileName(String pomFilename)` Sets the (unqualified) filename of the POM for the Maven invocation.
`InvocationRequest`	`setProfiles(List<String> profiles)` Sets the profiles for the Maven invocation.
`InvocationRequest`	`setProjects(List<String> projects)` Sets the reactor project list.
`InvocationRequest`	`setProperties(Properties properties)` Sets the system properties for the Maven invocation.
`InvocationRequest`	`setReactorFailureBehavior(InvocationRequest.ReactorFailureBehavior failureBehavior)` Sets the failure mode of the Maven invocation.
`InvocationRequest`	`setRecursive(boolean recursive)` Sets the recursion behavior of a reactor invocation.
`InvocationRequest`	`setResumeFrom(String resumeFrom)` Resume reactor from specified project.
`InvocationRequest`	`setShellEnvironmentInherited(boolean shellEnvironmentInherited)` Specifies whether the environment variables of the current process should be propagated to the Maven invocation.
`InvocationRequest`	`setShowErrors(boolean showErrors)` Sets the exception output mode of the Maven invocation.
`InvocationRequest`	`setShowVersion(boolean showVersion)` enable displaying version without stopping the build Equivalent of `-V` or `--show-version`
`InvocationRequest`	`setThreads(String threads)` Thread count, for instance 2.0C where C is core multiplied Equivalent of `-T` or `--threads`
`void`	`setTimeoutInSeconds(int timeoutInSeconds)`
`InvocationRequest`	`setToolchainsFile(File toolchains)` Sets the alternate path for the user toolchains file Equivalent of `-t` or `--toolchains`
`InvocationRequest`	`setUpdateSnapshots(boolean updateSnapshots)` Specifies whether Maven should enforce an update check for plugins and snapshots.
`InvocationRequest`	`setUserSettingsFile(File userSettings)` Sets the path to the user settings for the Maven invocation.

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

- Constructor Detail
  - DefaultInvocationRequest
```
public DefaultInvocationRequest()
```
- Method Detail
  - getBaseDirectory
```
public File getBaseDirectory()
```
    Description copied from interface: InvocationRequest
    
    Gets the path to the base directory of the POM for the Maven invocation. If InvocationRequest.getPomFile() does not return null, this setting only affects the working directory for the Maven invocation.
    
    Specified by:
    
    getBaseDirectory in interface InvocationRequest
    
    Returns:
    
    The path to the base directory of the POM or null if not set.
  - getBaseDirectory
```
public File getBaseDirectory(File defaultDirectory)
```
    Description copied from interface: InvocationRequest
    
    Gets the path to the base directory of the POM for the Maven invocation. If InvocationRequest.getPomFile() does not return null, this setting only affects the working directory for the Maven invocation.
    
    Specified by:
    
    getBaseDirectory in interface InvocationRequest
    
    Parameters:
    
    defaultDirectory - The default base directory to use if none is configured for this request, may be null.
    
    Returns:
    
    The path to the base directory of the POM or null if not set.
  - getErrorHandler
```
public InvocationOutputHandler getErrorHandler(InvocationOutputHandler defaultHandler)
```
    Description copied from interface: InvocationRequest
    
    Gets the handler used to capture the error output from the Maven build.
    
    Specified by:
    
    getErrorHandler in interface InvocationRequest
    
    Parameters:
    
    defaultHandler - the default InvocationOutputHandler to use
    
    Returns:
    
    The error handler or null if not set.
  - getReactorFailureBehavior
```
public InvocationRequest.ReactorFailureBehavior getReactorFailureBehavior()
```
    Description copied from interface: InvocationRequest
    
    Gets the failure mode of the Maven invocation. By default, the mode InvocationRequest.ReactorFailureBehavior.FailFast is used.
    
    Specified by:
    
    getReactorFailureBehavior in interface InvocationRequest
    
    Returns:
    
    The failure mode, one of InvocationRequest.ReactorFailureBehavior.FailFast, InvocationRequest.ReactorFailureBehavior.FailAtEnd and InvocationRequest.ReactorFailureBehavior.FailNever.
  - getGoals
```
public List<String> getGoals()
```
    Description copied from interface: InvocationRequest
    
    Gets the goals for the Maven invocation.
    
    Specified by:
    
    getGoals in interface InvocationRequest
    
    Returns:
    
    The goals for the Maven invocation or null if not set.
  - getInputStream
```
public InputStream getInputStream(InputStream defaultStream)
```
    Description copied from interface: InvocationRequest
    
    Gets the input stream used to provide input for the invoked Maven build. This is in particular useful when invoking Maven in interactive mode.
    
    Specified by:
    
    getInputStream in interface InvocationRequest
    
    Parameters:
    
    defaultStream - the default InputStream to use
    
    Returns:
    
    The input stream used to provide input for the invoked Maven build or null if not set.
  - getLocalRepositoryDirectory
```
public File getLocalRepositoryDirectory(File defaultDirectory)
```
    Description copied from interface: InvocationRequest
    
    Gets the path to the base directory of the local repository to use for the Maven invocation.
    
    Specified by:
    
    getLocalRepositoryDirectory in interface InvocationRequest
    
    Parameters:
    
    defaultDirectory - The default location to use if no location is configured for this request, may be null.
    
    Returns:
    
    The path to the base directory of the local repository or null to use the location from the settings.xml.
  - getOutputHandler
```
public InvocationOutputHandler getOutputHandler(InvocationOutputHandler defaultHandler)
```
    Description copied from interface: InvocationRequest
    
    Gets the handler used to capture the standard output from the Maven build.
    
    Specified by:
    
    getOutputHandler in interface InvocationRequest
    
    Parameters:
    
    defaultHandler - the default InvocationOutputHandler to use
    
    Returns:
    
    The output handler or null if not set.
  - getPomFile
```
public File getPomFile()
```
    Description copied from interface: InvocationRequest
    
    Gets the path to the POM for the Maven invocation. If no base directory is set, the parent directory of this POM will be used as the working directory for the Maven invocation.
    
    Specified by:
    
    getPomFile in interface InvocationRequest
    
    Returns:
    
    The path to the POM for the Maven invocation or null if not set.
  - getProperties
```
public Properties getProperties()
```
    Description copied from interface: InvocationRequest
    
    Gets the system properties for the Maven invocation.
    
    Specified by:
    
    getProperties in interface InvocationRequest
    
    Returns:
    
    The system properties for the Maven invocation or null if not set.
  - isDebug
```
public boolean isDebug()
```
    Description copied from interface: InvocationRequest
    
    Gets the debug mode of the Maven invocation. By default, Maven is executed in normal mode.
    
    Specified by:
    
    isDebug in interface InvocationRequest
    
    Returns:
    
    true if Maven should be executed in debug mode, false if the normal mode should be used.
  - isBatchMode
```
public boolean isBatchMode()
```
    Description copied from interface: InvocationRequest
    
    By default, Maven is executed in batch mode. This mean no interaction with the Maven process can be done.
    
    Specified by:
    
    isBatchMode in interface InvocationRequest
    
    Returns:
    
    true if Maven should be executed in batch mode, false if Maven is executed in interactive mode.
  - isOffline
```
public boolean isOffline()
```
    Description copied from interface: InvocationRequest
    
    Gets the network mode of the Maven invocation. By default, Maven is executed in online mode.
    
    Specified by:
    
    isOffline in interface InvocationRequest
    
    Returns:
    
    true if Maven should be executed in offline mode, false if the online mode is used.
  - isShowErrors
```
public boolean isShowErrors()
```
    Description copied from interface: InvocationRequest
    
    Gets the exception output mode of the Maven invocation. By default, Maven will not print stack traces of build exceptions.
    
    Specified by:
    
    isShowErrors in interface InvocationRequest
    
    Returns:
    
    true if Maven should print stack traces, false otherwise.
  - isUpdateSnapshots
```
public boolean isUpdateSnapshots()
```
    Description copied from interface: InvocationRequest
    
    Indicates whether Maven should enforce an update check for plugins and snapshots. By default, no update check is performed.
    
    Specified by:
    
    isUpdateSnapshots in interface InvocationRequest
    
    Returns:
    
    true if plugins and snapshots should be updated, false otherwise.
  - isRecursive
```
public boolean isRecursive()
```
    Description copied from interface: InvocationRequest
    
    Gets the recursion behavior of a reactor invocation. By default, Maven will recursive the build into sub modules.
    
    Specified by:
    
    isRecursive in interface InvocationRequest
    
    Returns:
    
    true if sub modules should be build, false otherwise.
  - setRecursive
```
public InvocationRequest setRecursive(boolean recursive)
```
    Description copied from interface: InvocationRequest
    
    Sets the recursion behavior of a reactor invocation. Inverse equivalent of -N and --non-recursive
    
    Specified by:
    
    setRecursive in interface InvocationRequest
    
    Parameters:
    
    recursive - true if sub modules should be build, false otherwise.
    
    Returns:
    
    This invocation request.
  - setBaseDirectory
```
public InvocationRequest setBaseDirectory(File basedir)
```
    Description copied from interface: InvocationRequest
    
    Sets the path to the base directory of the POM for the Maven invocation. If InvocationRequest.getPomFile() does not return null, this setting only affects the working directory for the Maven invocation.
    
    Specified by:
    
    setBaseDirectory in interface InvocationRequest
    
    Parameters:
    
    basedir - The path to the base directory of the POM, may be null if not used.
    
    Returns:
    
    This invocation request.
  - setDebug
```
public InvocationRequest setDebug(boolean debug)
```
    Description copied from interface: InvocationRequest
    
    Sets the debug mode of the Maven invocation. Equivalent of -X and --debug
    
    Specified by:
    
    setDebug in interface InvocationRequest
    
    Parameters:
    
    debug - true if Maven should be executed in debug mode, false if the normal mode should be used.
    
    Returns:
    
    This invocation request.
  - setErrorHandler
```
public InvocationRequest setErrorHandler(InvocationOutputHandler errorHandler)
```
    Description copied from interface: InvocationRequest
    
    Sets the handler used to capture the error output from the Maven build.
    
    Specified by:
    
    setErrorHandler in interface InvocationRequest
    
    Parameters:
    
    errorHandler - The error handler, may be null if the output is not of interest.
    
    Returns:
    
    This invocation request.
  - setReactorFailureBehavior
```
public InvocationRequest setReactorFailureBehavior(InvocationRequest.ReactorFailureBehavior failureBehavior)
```
    Description copied from interface: InvocationRequest
    
    Sets the failure mode of the Maven invocation. Equivalent of -ff and --fail-fast, -fae and --fail-at-end, -fn and --fail-never
    
    Specified by:
    
    setReactorFailureBehavior in interface InvocationRequest
    
    Parameters:
    
    failureBehavior - The failure mode, must be one of InvocationRequest.ReactorFailureBehavior.FailFast, InvocationRequest.ReactorFailureBehavior.FailAtEnd and InvocationRequest.ReactorFailureBehavior.FailNever.
    
    Returns:
    
    This invocation request.
  - setGoals
```
public InvocationRequest setGoals(List<String> goals)
```
    Description copied from interface: InvocationRequest
    
    Sets the goals for the Maven invocation.
    
    Specified by:
    
    setGoals in interface InvocationRequest
    
    Parameters:
    
    goals - The goals for the Maven invocation, may be null to execute the POMs default goal.
    
    Returns:
    
    This invocation request.
  - setInputStream
```
public InvocationRequest setInputStream(InputStream inputStream)
```
    Description copied from interface: InvocationRequest
    
    Sets the input stream used to provide input for the invoked Maven build. This is in particular useful when invoking Maven in interactive mode.
    
    Specified by:
    
    setInputStream in interface InvocationRequest
    
    Parameters:
    
    inputStream - The input stream used to provide input for the invoked Maven build, may be null if not required.
    
    Returns:
    
    This invocation request.
  - setBatchMode
```
public InvocationRequest setBatchMode(boolean interactive)
```
    Description copied from interface: InvocationRequest
    
    Sets the interaction mode of the Maven invocation. Equivalent of -B and --batch-mode
    
    Specified by:
    
    setBatchMode in interface InvocationRequest
    
    Parameters:
    
    interactive - true if Maven should be executed in non-interactive mode, false if the interactive modes is used.
    
    Returns:
    
    This invocation request.
  - setLocalRepositoryDirectory
```
public InvocationRequest setLocalRepositoryDirectory(File localRepository)
```
    Description copied from interface: InvocationRequest
    
    Sets the path to the base directory of the local repository to use for the Maven invocation.
    
    Specified by:
    
    setLocalRepositoryDirectory in interface InvocationRequest
    
    Parameters:
    
    localRepository - The path to the base directory of the local repository, may be null.
    
    Returns:
    
    This invocation request.
  - setOffline
```
public InvocationRequest setOffline(boolean offline)
```
    Description copied from interface: InvocationRequest
    
    Sets the network mode of the Maven invocation. Equivalent of -o and --offline
    
    Specified by:
    
    setOffline in interface InvocationRequest
    
    Parameters:
    
    offline - true if Maven should be executed in offline mode, false if the online mode is used.
    
    Returns:
    
    This invocation request.
  - setOutputHandler
```
public InvocationRequest setOutputHandler(InvocationOutputHandler outputHandler)
```
    Description copied from interface: InvocationRequest
    
    Sets the handler used to capture the standard output from the Maven build.
    
    Specified by:
    
    setOutputHandler in interface InvocationRequest
    
    Parameters:
    
    outputHandler - The output handler, may be null if the output is not of interest.
    
    Returns:
    
    This invocation request.
  - setPomFile
```
public InvocationRequest setPomFile(File pomFile)
```
    Description copied from interface: InvocationRequest
    
    Sets the path to the POM for the Maven invocation. If no base directory is set, the parent directory of this POM will be used as the working directory for the Maven invocation.
    
    Specified by:
    
    setPomFile in interface InvocationRequest
    
    Parameters:
    
    pomFile - The path to the POM for the Maven invocation, may be null if not used.
    
    Returns:
    
    This invocation request.
  - setProperties
```
public InvocationRequest setProperties(Properties properties)
```
    Description copied from interface: InvocationRequest
    
    Sets the system properties for the Maven invocation.
    
    Specified by:
    
    setProperties in interface InvocationRequest
    
    Parameters:
    
    properties - The system properties for the Maven invocation, may be null if not set.
    
    Returns:
    
    This invocation request.
  - setShowErrors
```
public InvocationRequest setShowErrors(boolean showErrors)
```
    Description copied from interface: InvocationRequest
    
    Sets the exception output mode of the Maven invocation. Equivalent of -e and --errors
    
    Specified by:
    
    setShowErrors in interface InvocationRequest
    
    Parameters:
    
    showErrors - true if Maven should print stack traces, false otherwise.
    
    Returns:
    
    This invocation request.
  - setUpdateSnapshots
```
public InvocationRequest setUpdateSnapshots(boolean updateSnapshots)
```
    Description copied from interface: InvocationRequest
    
    Specifies whether Maven should enforce an update check for plugins and snapshots. Equivalent of -U and --update-snapshots
    
    Specified by:
    
    setUpdateSnapshots in interface InvocationRequest
    
    Parameters:
    
    updateSnapshots - true if plugins and snapshots should be updated, false otherwise.
    
    Returns:
    
    This invocation request.
  - isShellEnvironmentInherited
```
public boolean isShellEnvironmentInherited()
```
    Description copied from interface: InvocationRequest
    
    Indicates whether the environment variables of the current process should be propagated to the Maven invocation. By default, the current environment variables are inherited by the new Maven invocation.
    
    Specified by:
    
    isShellEnvironmentInherited in interface InvocationRequest
    
    Returns:
    
    true if the environment variables should be propagated, false otherwise.
    
    See Also:
    
    MavenCommandLineBuilder.setShellEnvironment(InvocationRequest, Commandline)
  - setShellEnvironmentInherited
```
public InvocationRequest setShellEnvironmentInherited(boolean shellEnvironmentInherited)
```
    Description copied from interface: InvocationRequest
    
    Specifies whether the environment variables of the current process should be propagated to the Maven invocation.
    
    Specified by:
    
    setShellEnvironmentInherited in interface InvocationRequest
    
    Parameters:
    
    shellEnvironmentInherited - true if the environment variables should be propagated, false otherwise.
    
    Returns:
    
    This invocation request.
  - getJavaHome
```
public File getJavaHome()
```
    Description copied from interface: InvocationRequest
    
    Gets the path to the base directory of the Java installation used to run Maven.
    
    Specified by:
    
    getJavaHome in interface InvocationRequest
    
    Returns:
    
    The path to the base directory of the Java installation used to run Maven or null to use the default Java home.
  - setJavaHome
```
public InvocationRequest setJavaHome(File javaHome)
```
    Sets the path to the base directory of the Java installation used to run Maven.
    
    Specified by:
    
    setJavaHome in interface InvocationRequest
    
    Parameters:
    
    javaHome - The path to the base directory of the Java installation used to run Maven, may be null to use the default Java home.
    
    Returns:
    
    This invocation request.
  - getUserSettingsFile
```
public File getUserSettingsFile()
```
    Gets the path to the user settings for the Maven invocation.
    
    Specified by:
    
    getUserSettingsFile in interface InvocationRequest
    
    Returns:
    
    The path to the user settings for the Maven invocation or null to load the user settings from the default location.
  - setUserSettingsFile
```
public InvocationRequest setUserSettingsFile(File userSettings)
```
    Sets the path to the user settings for the Maven invocation. Equivalent of -s and --settings
    
    Specified by:
    
    setUserSettingsFile in interface InvocationRequest
    
    Parameters:
    
    userSettings - The path to the user settings for the Maven invocation, may be null to load the user settings from the default location.
    
    Returns:
    
    This invocation request.
  - getGlobalSettingsFile
```
public File getGlobalSettingsFile()
```
    Gets the path to the global settings for the Maven invocation.
    
    Specified by:
    
    getGlobalSettingsFile in interface InvocationRequest
    
    Returns:
    
    The path to the global settings for the Maven invocation or null to load the global settings from the default location.
  - setGlobalSettingsFile
```
public InvocationRequest setGlobalSettingsFile(File globalSettings)
```
    Sets the path to the global settings for the Maven invocation. Equivalent of -gs and --global-settings
    
    Specified by:
    
    setGlobalSettingsFile in interface InvocationRequest
    
    Parameters:
    
    globalSettings - The path to the global settings for the Maven invocation, may be null to load the global settings from the default location.
    
    Returns:
    
    This invocation request.
  - getToolchainsFile
```
public File getToolchainsFile()
```
    Gets the path to the custom toolchains file
    
    Specified by:
    
    getToolchainsFile in interface InvocationRequest
    
    Returns:
    
    The path to the custom toolchains file or null to load the toolchains from the default location
  - setToolchainsFile
```
public InvocationRequest setToolchainsFile(File toolchains)
```
    Sets the alternate path for the user toolchains file Equivalent of -t or --toolchains
    
    Specified by:
    
    setToolchainsFile in interface InvocationRequest
    
    Parameters:
    
    toolchains - the alternate path for the user toolchains file
    
    Returns:
    
    This invocation request
  - getGlobalToolchainsFile
```
public File getGlobalToolchainsFile()
```
    Alternate path for the global toolchains file Note. This is available since Maven 3.3.1
    
    Specified by:
    
    getGlobalToolchainsFile in interface InvocationRequest
    
    Returns:
    
    The path to the custom global toolchains file or null to load the global toolchains from the default location.
  - setGlobalToolchainsFile
```
public InvocationRequest setGlobalToolchainsFile(File toolchains)
```
    Sets the alternate path for the global toolchains file Equivalent of -gt or --global-toolchains
    
    Specified by:
    
    setGlobalToolchainsFile in interface InvocationRequest
    
    Parameters:
    
    toolchains - the alternate path for the global toolchains file
    
    Returns:
    
    This invocation request
  - getGlobalChecksumPolicy
```
public InvocationRequest.CheckSumPolicy getGlobalChecksumPolicy()
```
    Gets the checksum mode of the Maven invocation.
    
    Specified by:
    
    getGlobalChecksumPolicy in interface InvocationRequest
    
    Returns:
    
    The checksum mode, one of InvocationRequest.CheckSumPolicy.Warn and InvocationRequest.CheckSumPolicy.Fail.
  - setGlobalChecksumPolicy
```
public InvocationRequest setGlobalChecksumPolicy(InvocationRequest.CheckSumPolicy globalChecksumPolicy)
```
    Sets the checksum mode of the Maven invocation. Equivalent of -c or --lax-checksums, -C or --strict-checksums
    
    Specified by:
    
    setGlobalChecksumPolicy in interface InvocationRequest
    
    Parameters:
    
    globalChecksumPolicy - The checksum mode, must be one of InvocationRequest.CheckSumPolicy.Warn and InvocationRequest.CheckSumPolicy.Fail.
    
    Returns:
    
    This invocation request.
  - getPomFileName
```
public String getPomFileName()
```
    Gets the (unqualified) filename of the POM for the Maven invocation. This setting is ignored if InvocationRequest.getPomFile() does not return null. Otherwise, the base directory is assumed to contain a POM with this name. By default, a file named pom.xml is used.
    
    Specified by:
    
    getPomFileName in interface InvocationRequest
    
    Returns:
    
    The (unqualified) filename of the POM for the Maven invocation or null if not set.
  - setPomFileName
```
public InvocationRequest setPomFileName(String pomFilename)
```
    Sets the (unqualified) filename of the POM for the Maven invocation. This setting is ignored if InvocationRequest.getPomFile() does not return null. Otherwise, the base directory is assumed to contain a POM with this name.
    
    Specified by:
    
    setPomFileName in interface InvocationRequest
    
    Parameters:
    
    pomFilename - The (unqualified) filename of the POM for the Maven invocation, may be null if not used.
    
    Returns:
    
    This invocation request.
  - getProfiles
```
public List<String> getProfiles()
```
    Gets the profiles for the Maven invocation.
    
    Specified by:
    
    getProfiles in interface InvocationRequest
    
    Returns:
    
    The profiles for the Maven invocation or null if not set.
  - setProfiles
```
public InvocationRequest setProfiles(List<String> profiles)
```
    Sets the profiles for the Maven invocation. Equivalent of -P and --active-profiles
    
    Specified by:
    
    setProfiles in interface InvocationRequest
    
    Parameters:
    
    profiles - The profiles for the Maven invocation, may be null to use the default profiles.
    
    Returns:
    
    This invocation request.
  - isNonPluginUpdates
```
public boolean isNonPluginUpdates()
```
    Indicates whether Maven should check for plugin updates. By default, plugin updates are not suppressed.
    
    Specified by:
    
    isNonPluginUpdates in interface InvocationRequest
    
    Returns:
    
    true if plugin updates should be suppressed, false otherwise.
  - setNonPluginUpdates
```
public InvocationRequest setNonPluginUpdates(boolean nonPluginUpdates)
```
    Specifies whether Maven should check for plugin updates.
    Equivalent of -npu or --no-plugin-updates
    
    note: Ineffective with Maven3, only kept for backward compatibility
    
    Specified by:
    
    setNonPluginUpdates in interface InvocationRequest
    
    Parameters:
    
    nonPluginUpdates - true if plugin updates should be suppressed, false otherwise.
    
    Returns:
    
    This invocation request.
  - addShellEnvironment
```
public InvocationRequest addShellEnvironment(String name,
                                             String value)
```
    Description copied from interface: InvocationRequest
    
    Adds the specified environment variable to the Maven invocation.
    
    Specified by:
    
    addShellEnvironment in interface InvocationRequest
    
    Parameters:
    
    name - The name of the environment variable, must not be null.
    
    value - The value of the environment variable, must not be null.
    
    Returns:
    
    This invocation request.
  - getShellEnvironments
```
public Map<String,String> getShellEnvironments()
```
    Description copied from interface: InvocationRequest
    
    Gets the environment variables for the Maven invocation.
    
    Specified by:
    
    getShellEnvironments in interface InvocationRequest
    
    Returns:
    
    The environment variables for the Maven invocation or null if not set.
  - getMavenOpts
```
public String getMavenOpts()
```
    Description copied from interface: InvocationRequest
    
    Gets the value of the MAVEN_OPTS environment variable.
    
    Specified by:
    
    getMavenOpts in interface InvocationRequest
    
    Returns:
    
    The value of the MAVEN_OPTS environment variable or null if not set.
  - setMavenOpts
```
public InvocationRequest setMavenOpts(String mavenOpts)
```
    Description copied from interface: InvocationRequest
    
    Sets the value of the MAVEN_OPTS environment variable.
    
    Specified by:
    
    setMavenOpts in interface InvocationRequest
    
    Parameters:
    
    mavenOpts - The value of the MAVEN_OPTS environment variable, may be null to use the default options.
    
    Returns:
    
    This invocation request.
  - isShowVersion
```
public boolean isShowVersion()
```
    Description copied from interface: InvocationRequest
    
    The show version behavior (-V option)
    
    Specified by:
    
    isShowVersion in interface InvocationRequest
    
    Returns:
    
    The show version behavior
    
    See Also:
    
    InvocationRequest.isShowVersion()
  - setShowVersion
```
public InvocationRequest setShowVersion(boolean showVersion)
```
    Description copied from interface: InvocationRequest
    
    enable displaying version without stopping the build Equivalent of -V or --show-version
    
    Specified by:
    
    setShowVersion in interface InvocationRequest
    
    Parameters:
    
    showVersion - enable displaying version
    
    Returns:
    
    This invocation request.
    
    See Also:
    
    InvocationRequest.setShowVersion(boolean)
  - getThreads
```
public String getThreads()
```
    Get the value of the threads argument.
    
    Specified by:
    
    getThreads in interface InvocationRequest
    
    Returns:
    
    the value of the threads argument or null if not set
  - setThreads
```
public InvocationRequest setThreads(String threads)
```
    Thread count, for instance 2.0C where C is core multiplied Equivalent of -T or --threads
    note: available since Maven3
    
    Specified by:
    
    setThreads in interface InvocationRequest
    
    Parameters:
    
    threads - the threadcount
    
    Returns:
    
    This invocation request.
  - getProjects
```
public List<String> getProjects()
```
    A list of specified reactor projects to build instead of all projects. A project can be specified by [groupId]:artifactId or by its relative path.
    
    Specified by:
    
    getProjects in interface InvocationRequest
    
    Returns:
    
    the list of projects to add to reactor build, otherwise null
  - setProjects
```
public InvocationRequest setProjects(List<String> projects)
```
    Sets the reactor project list. Equivalent of -pl or --projects
    
    Specified by:
    
    setProjects in interface InvocationRequest
    
    Parameters:
    
    projects - the reactor project list
    
    Returns:
    
    This invocation request.
  - isAlsoMake
```
public boolean isAlsoMake()
```
    Get the value of the also-make argument.
    
    Specified by:
    
    isAlsoMake in interface InvocationRequest
    
    Returns:
    
    true if the argument also-make was specified, otherwise false
  - setAlsoMake
```
public InvocationRequest setAlsoMake(boolean alsoMake)
```
    Enable the 'also make' mode. Equivalent of -am or --also-make
    
    Specified by:
    
    setAlsoMake in interface InvocationRequest
    
    Parameters:
    
    alsoMake - enable 'also make' mode
    
    Returns:
    
    This invocation request.
  - isAlsoMakeDependents
```
public boolean isAlsoMakeDependents()
```
    Get the value of the also-make-dependents
    
    Specified by:
    
    isAlsoMakeDependents in interface InvocationRequest
    
    Returns:
    
    true if the argument also-make-dependents was specified, otherwise false
  - setAlsoMakeDependents
```
public InvocationRequest setAlsoMakeDependents(boolean alsoMakeDependents)
```
    Enable the 'also make dependents' mode. Equivalent of -amd or --also-make-dependents
    
    Specified by:
    
    setAlsoMakeDependents in interface InvocationRequest
    
    Parameters:
    
    alsoMakeDependents - enable 'also make' mode
    
    Returns:
    
    This invocation request.
  - getResumeFrom
```
public String getResumeFrom()
```
    Get the value of resume-from
    
    Specified by:
    
    getResumeFrom in interface InvocationRequest
    
    Returns:
    
    specified reactor project to resume from
  - setResumeFrom
```
public InvocationRequest setResumeFrom(String resumeFrom)
```
    Resume reactor from specified project. Equivalent of -rf or --resume-from
    
    Specified by:
    
    setResumeFrom in interface InvocationRequest
    
    Parameters:
    
    resumeFrom - set the project to resume from
    
    Returns:
    
    This invocation request
  - setBuilder
```
public InvocationRequest setBuilder(String id)
```
    The id of the build strategy to use. equivalent of --builder id. Note. This is available since Maven 3.2.1
    
    Specified by:
    
    setBuilder in interface InvocationRequest
    
    Parameters:
    
    id - The builder id.
    
    Returns:
    
    InvocationRequest FIXME: How to identify if this is a valid command line option?
  - getBuilder
```
public String getBuilder()
```
    Get the current set builder strategy id equivalent of --builder id. Note. This is available since Maven 3.2.1
    
    Specified by:
    
    getBuilder in interface InvocationRequest
    
    Returns:
    
    The current set builder id.
  - getTimeoutInSeconds
```
public int getTimeoutInSeconds()
```
    Specified by:
    
    getTimeoutInSeconds in interface InvocationRequest
    
    Returns:
    
    the timeout in seconds to execute the project
  - setTimeoutInSeconds
```
public void setTimeoutInSeconds(int timeoutInSeconds)
```
    Specified by:
    
    setTimeoutInSeconds in interface InvocationRequest
    
    Parameters:
    
    timeoutInSeconds - the timeout in seconds to execute the project

Class DefaultInvocationRequest

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.maven.shared.invoker.InvocationRequest

Field Summary

Fields inherited from interface org.apache.maven.shared.invoker.InvocationRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultInvocationRequest

Method Detail

getBaseDirectory

getBaseDirectory

getErrorHandler

getReactorFailureBehavior

getGoals

getInputStream

getLocalRepositoryDirectory

getOutputHandler

getPomFile

getProperties

isDebug

isBatchMode

isOffline

isShowErrors

isUpdateSnapshots

isRecursive

setRecursive

setBaseDirectory

setDebug

setErrorHandler

setReactorFailureBehavior

setGoals

setInputStream

setBatchMode

setLocalRepositoryDirectory

setOffline

setOutputHandler

setPomFile

setProperties

setShowErrors

setUpdateSnapshots

isShellEnvironmentInherited

setShellEnvironmentInherited

getJavaHome

setJavaHome

getUserSettingsFile

setUserSettingsFile

getGlobalSettingsFile

setGlobalSettingsFile

getToolchainsFile

setToolchainsFile

getGlobalToolchainsFile

setGlobalToolchainsFile

getGlobalChecksumPolicy

setGlobalChecksumPolicy

getPomFileName

setPomFileName

getProfiles

setProfiles

isNonPluginUpdates

setNonPluginUpdates

addShellEnvironment

getShellEnvironments

getMavenOpts

setMavenOpts

isShowVersion

setShowVersion

getThreads

setThreads

getProjects

setProjects

isAlsoMake

setAlsoMake

isAlsoMakeDependents

setAlsoMakeDependents

getResumeFrom

setResumeFrom

setBuilder

getBuilder