org.jboss.shrinkwrap.resolver.api.maven.embedded.pom.equipped

Interface ConfigurationStage<DIST_OR_CONFIG extends ConfigurationStage>

All Superinterfaces:

BuildStage

All Known Subinterfaces:

ConfigurationDistributionStage, PomEquippedEmbeddedMaven

public interface ConfigurationStage<DIST_OR_CONFIG extends ConfigurationStage>
extends BuildStage

Author:

Matous Jobanek

Method Summary

Modifier and Type	Method and Description
DIST_OR_CONFIG	activateReactor(String[] includes, String[] excludes) Dynamically constructs a reactor using the subdirectories of the current directory
DIST_OR_CONFIG	addProperty(String key, String value) Adds the property to the list of properties.
DIST_OR_CONFIG	addShellEnvironment(String name, String value) Adds the specified environment variable to the Maven invocation.
DIST_OR_CONFIG	setAlsoMake(boolean alsoMake) Enable the 'also make' mode.
DIST_OR_CONFIG	setAlsoMakeDependents(boolean alsoMakeDependents) Enable the 'also make dependents' mode.
DIST_OR_CONFIG	setDebug(boolean debug) Sets the debug mode of the Maven invocation.
DIST_OR_CONFIG	setFailureBehavior(String failureBehavior) Sets the failure mode of the Maven invocation.
DIST_OR_CONFIG	setGlobalChecksumPolicy(String globalChecksumPolicy) Sets the checksum mode of the Maven invocation.
DIST_OR_CONFIG	setGlobalSettingsFile(File globalSettingsFile) Sets the path to the global settings for the Maven invocation.
DIST_OR_CONFIG	setGoals(List<String> goals) Sets the goals for the Maven invocation.
DIST_OR_CONFIG	setGoals(String... goals) Sets the goals for the Maven invocation.
DIST_OR_CONFIG	setInputStream(InputStream inputStream) Sets the input stream used to provide input for the invoked Maven build.
DIST_OR_CONFIG	setInteractive(boolean interactive) Sets the interaction mode of the Maven invocation.
DIST_OR_CONFIG	setJavaHome(File javaHome) Sets the path to the base directory of the Java installation used to run Maven.
DIST_OR_CONFIG	setLocalRepositoryDirectory(File localRepositoryDirectory) Sets the path to the base directory of the local repository to use for the Maven invocation.
DIST_OR_CONFIG	setLogger(org.apache.maven.shared.invoker.InvokerLogger invokerLogger) Sets the input stream used to provide input for the invoked Maven build.
DIST_OR_CONFIG	setMavenOpts(String mavenOpts) Sets the value of the MAVEN_OPTS environment variable.
DIST_OR_CONFIG	setNonPluginUpdates(boolean nonPluginUpdates) Specifies whether Maven should check for plugin updates.
DIST_OR_CONFIG	setOffline(boolean offline) Sets the network mode of the Maven invocation.
DIST_OR_CONFIG	setProfiles(List<String> profiles) Sets the profiles for the Maven invocation.
DIST_OR_CONFIG	setProfiles(String... profiles) Sets the profiles for the Maven invocation.
DIST_OR_CONFIG	setProjects(List<String> projects) Sets the reactor project list.
DIST_OR_CONFIG	setProjects(String... projects) Sets the reactor project list.
DIST_OR_CONFIG	setProperties(Properties properties) Sets the system properties for the Maven invocation.
DIST_OR_CONFIG	setQuiet() Puts the build output into the quiet mode.
DIST_OR_CONFIG	setQuiet(boolean quiet) Sets if the build output shold be in the quiet mode or not.
DIST_OR_CONFIG	setRecursive(boolean recursive) Sets the recursion behavior of a reactor invocation.
DIST_OR_CONFIG	setResumeFrom(String resumeFrom) Resume reactor from specified project.
DIST_OR_CONFIG	setShellEnvironmentInherited(boolean shellEnvironmentInherited) Specifies whether the environment variables of the current process should be propagated to the Maven invocation.
DIST_OR_CONFIG	setShowErrors(boolean showErrors) Sets the exception output mode of the Maven invocation.
DIST_OR_CONFIG	setShowVersion(boolean showVersion) enable displaying version without stopping the build Equivalent of -V or --show-version
DIST_OR_CONFIG	setThreads(String threads) Thread count, for instance 2.0C where C is core multiplied Equivalent of -T or --threads
DIST_OR_CONFIG	setToolchainsFile(File toolchainsFile) Sets the alternate path for the user toolchains file Equivalent of -t or --toolchains
DIST_OR_CONFIG	setUpdateSnapshots(boolean updateSnapshots) Specifies whether Maven should enforce an update check for plugins and snapshots.
DIST_OR_CONFIG	setUserSettingsFile(File userSettingsFile) Sets the path to the user settings for the Maven invocation.
DIST_OR_CONFIG	setWorkingDirectory(File workingDirectory) Sets the working directory for the Maven invocation.
DIST_OR_CONFIG	skipTests(boolean skipTests) Specifies whether the test of the project should be skipped during Maven build - Equivalent of --skipTests.

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.maven.embedded.BuildStage

build, ignoreFailure, ignoreFailure

Method Detail

setInteractive

DIST_OR_CONFIG setInteractive(boolean interactive)

Sets the interaction mode of the Maven invocation. Inverse equivalent of -B and --batch-mode

Parameters:

interactive - true if Maven should be executed in interactive mode, false if the batch mode is used.

Returns:

Modified instance of EmbeddedMaven

setOffline

DIST_OR_CONFIG setOffline(boolean offline)

Sets the network mode of the Maven invocation. Equivalent of -o and --offline

Parameters:

offline - true if Maven should be executed in offline mode, false if the online mode is used.

Returns:

Modified instance of EmbeddedMaven

setDebug

DIST_OR_CONFIG setDebug(boolean debug)

Sets the debug mode of the Maven invocation. Equivalent of -X and --debug

Parameters:

debug - true if Maven should be executed in debug mode, false if the normal mode should be used.

Returns:

Modified instance of EmbeddedMaven

setShowErrors

DIST_OR_CONFIG setShowErrors(boolean showErrors)

Sets the exception output mode of the Maven invocation. Equivalent of -e and --errors

Parameters:

showErrors - true if Maven should print stack traces, false otherwise.

Returns:

Modified instance of EmbeddedMaven

setUpdateSnapshots

DIST_OR_CONFIG setUpdateSnapshots(boolean updateSnapshots)

Specifies whether Maven should enforce an update check for plugins and snapshots. Equivalent of -U and --update-snapshots

Parameters:

updateSnapshots - true if plugins and snapshots should be updated, false otherwise.

Returns:

Modified instance of EmbeddedMaven

setFailureBehavior

DIST_OR_CONFIG setFailureBehavior(String failureBehavior)

Sets the failure mode of the Maven invocation. Equivalent of -ff and --fail-fast, -fae and --fail-at-end, -fn and --fail-never

Parameters:

failureBehavior - The failure mode, must be one of REACTOR_FAIL_FAST, REACTOR_FAIL_AT_END and REACTOR_FAIL_NEVER.

Returns:

Modified instance of EmbeddedMaven

activateReactor

DIST_OR_CONFIG activateReactor(String[] includes,
                               String[] excludes)

Dynamically constructs a reactor using the subdirectories of the current directory

Parameters:

includes - a list of filename patterns to include, or null, in which case the default is */pom.xml

excludes - a list of filename patterns to exclude, or null, in which case nothing is excluded

Returns:

Modified instance of EmbeddedMaven

setLocalRepositoryDirectory

DIST_OR_CONFIG setLocalRepositoryDirectory(File localRepositoryDirectory)

Sets the path to the base directory of the local repository to use for the Maven invocation.

Parameters:

localRepositoryDirectory - The path to the base directory of the local repository, may be null.

Returns:

Modified instance of EmbeddedMaven

setLogger

DIST_OR_CONFIG setLogger(org.apache.maven.shared.invoker.InvokerLogger invokerLogger)

Sets the input stream used to provide input for the invoked Maven build. This is in particular useful when invoking Maven in interactive mode.

Parameters:

invokerLogger - The input stream used to provide input for the invoked Maven build, may be null if not required.

Returns:

Modified instance of EmbeddedMaven

setWorkingDirectory

DIST_OR_CONFIG setWorkingDirectory(File workingDirectory)

Sets the working directory for the Maven invocation.

Parameters:

workingDirectory - The working directory for the Maven invocation, may be null to derive the working directory from the base directory of the processed POM.

Returns:

Modified instance of EmbeddedMaven

setInputStream

DIST_OR_CONFIG setInputStream(InputStream inputStream)

Sets the input stream used to provide input for the invoked Maven build. This is in particular useful when invoking Maven in interactive mode.

Parameters:

inputStream - The input stream used to provide input for the invoked Maven build, may be null if not required.

Returns:

Modified instance of EmbeddedMaven

setJavaHome

DIST_OR_CONFIG setJavaHome(File javaHome)

Sets the path to the base directory of the Java installation used to run Maven.

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:

Modified instance of EmbeddedMaven

setProperties

DIST_OR_CONFIG setProperties(Properties properties)

Sets the system properties for the Maven invocation.

Parameters:

properties - The system properties for the Maven invocation, may be null if not set.

Returns:

Modified instance of EmbeddedMaven

addProperty

DIST_OR_CONFIG addProperty(String key,
                           String value)

Adds the property to the list of properties.

Parameters:

key - The key of the property to be added

value - The value of the property to be added

Returns:

Modified instance of EmbeddedMaven

skipTests

DIST_OR_CONFIG skipTests(boolean skipTests)

Specifies whether the test of the project should be skipped during Maven build - Equivalent of --skipTests. Default is true

Parameters:

skipTests - false the test of the project should be invoked

Returns:

Modified instance of EmbeddedMaven

setGoals

DIST_OR_CONFIG setGoals(List<String> goals)

Sets the goals for the Maven invocation.

Parameters:

goals - The goals for the Maven invocation, may be null to execute the POMs default goal.

Returns:

Modified instance of EmbeddedMaven

setGoals

DIST_OR_CONFIG setGoals(String... goals)

Sets the goals for the Maven invocation.

Parameters:

goals - The goals for the Maven invocation, may be null to execute the POMs default goal.

Returns:

Modified instance of EmbeddedMaven

setProfiles

DIST_OR_CONFIG setProfiles(List<String> profiles)

Sets the profiles for the Maven invocation. Equivalent of -P and --active-profiles

Parameters:

profiles - The profiles for the Maven invocation, may be null to use the default profiles.

Returns:

Modified instance of EmbeddedMaven

setProfiles

DIST_OR_CONFIG setProfiles(String... profiles)

Sets the profiles for the Maven invocation. Equivalent of -P and --active-profiles

Parameters:

profiles - The profiles for the Maven invocation, may be null to use the default profiles.

Returns:

Modified instance of EmbeddedMaven

setShellEnvironmentInherited

DIST_OR_CONFIG setShellEnvironmentInherited(boolean shellEnvironmentInherited)

Specifies whether the environment variables of the current process should be propagated to the Maven invocation.

Parameters:

shellEnvironmentInherited - true if the environment variables should be propagated, false otherwise.

Returns:

Modified instance of EmbeddedMaven

setUserSettingsFile

DIST_OR_CONFIG setUserSettingsFile(File userSettingsFile)

Sets the path to the user settings for the Maven invocation. Equivalent of -s and --settings

Parameters:

userSettingsFile - The path to the user settings for the Maven invocation, may be null to load the user settings from the default location.

Returns:

Modified instance of EmbeddedMaven

setGlobalSettingsFile

DIST_OR_CONFIG setGlobalSettingsFile(File globalSettingsFile)

Sets the path to the global settings for the Maven invocation. Equivalent of -gs and --global-settings

Parameters:

globalSettingsFile - The path to the global settings for the Maven invocation, may be null to load the global settings from the default location.

Returns:

Modified instance of EmbeddedMaven

setToolchainsFile

DIST_OR_CONFIG setToolchainsFile(File toolchainsFile)

Sets the alternate path for the user toolchains file Equivalent of -t or --toolchains

Parameters:

toolchainsFile - the alternate path for the user toolchains file

Returns:

Modified instance of EmbeddedMaven

setGlobalChecksumPolicy

DIST_OR_CONFIG setGlobalChecksumPolicy(String globalChecksumPolicy)

Sets the checksum mode of the Maven invocation. Equivalent of -c or --lax-checksums, -C or --strict-checksums

Parameters:

globalChecksumPolicy - The checksum mode, must be one of $CHECKSUM_POLICY_WARN and $CHECKSUM_POLICY_FAIL.

Returns:

Modified instance of EmbeddedMaven

setNonPluginUpdates

DIST_OR_CONFIG 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

Parameters:

nonPluginUpdates - true if plugin updates should be suppressed, false otherwise.

Returns:

Modified instance of EmbeddedMaven

setRecursive

DIST_OR_CONFIG setRecursive(boolean recursive)

Sets the recursion behavior of a reactor invocation. Inverse equivalent of -N and --non-recursive

Parameters:

recursive - true if sub modules should be build, false otherwise.

Returns:

Modified instance of EmbeddedMaven

addShellEnvironment

DIST_OR_CONFIG addShellEnvironment(String name,
                                   String value)

Adds the specified environment variable to the Maven invocation.

Parameters:

name - The name of the environment variable, must not be null.

value - The value of the environment variable, must not be null.

Returns:

Modified instance of EmbeddedMaven

setMavenOpts

DIST_OR_CONFIG setMavenOpts(String mavenOpts)

Sets the value of the MAVEN_OPTS environment variable.

Parameters:

mavenOpts - The value of the MAVEN_OPTS environment variable, may be null to use the default options.

Returns:

Modified instance of EmbeddedMaven

setShowVersion

DIST_OR_CONFIG setShowVersion(boolean showVersion)

enable displaying version without stopping the build Equivalent of -V or --show-version

Parameters:

showVersion - enable displaying version

Returns:

Modified instance of EmbeddedMaven

setThreads

DIST_OR_CONFIG setThreads(String threads)

Thread count, for instance 2.0C where C is core multiplied Equivalent of -T or --threads

Parameters:

threads - the threadcount

Returns:

Modified instance of EmbeddedMaven

setProjects

DIST_OR_CONFIG setProjects(List<String> projects)

Sets the reactor project list. Equivalent of -P or --projects

Parameters:

projects - the reactor project list

Returns:

Modified instance of EmbeddedMaven

setProjects

DIST_OR_CONFIG setProjects(String... projects)

Sets the reactor project list. Equivalent of -P or --projects

Parameters:

projects - the reactor project list

Returns:

Modified instance of EmbeddedMaven

setAlsoMake

DIST_OR_CONFIG setAlsoMake(boolean alsoMake)

Enable the 'also make' mode. Equivalent of -am or --also-make

Parameters:

alsoMake - enable 'also make' mode

Returns:

Modified instance of EmbeddedMaven

setAlsoMakeDependents

DIST_OR_CONFIG setAlsoMakeDependents(boolean alsoMakeDependents)

Enable the 'also make dependents' mode. Equivalent of -amd or --also-make-dependents

Parameters:

alsoMakeDependents - enable 'also make' mode

Returns:

Modified instance of EmbeddedMaven

setResumeFrom

DIST_OR_CONFIG setResumeFrom(String resumeFrom)

Resume reactor from specified project. Equivalent of -rf or --resume-from

Parameters:

resumeFrom - set the project to resume from

Returns:

Modified instance of EmbeddedMaven

setQuiet

DIST_OR_CONFIG setQuiet(boolean quiet)

Sets if the build output shold be in the quiet mode or not. It means that the output will not be printed on standard output, but it will be accessible via the BuiltProject.getMavenLog(). Default is false

Parameters:

quiet - If the build should be in quite mode;

Returns:

Modified EmbeddedMaven instance

setQuiet

DIST_OR_CONFIG setQuiet()

Puts the build output into the quiet mode. It means that the output will not be printed on standard output, but it will be accessible via the BuiltProject.getMavenLog().

Returns:

Modified EmbeddedMaven instance