Index (Maven 4 API :: CLI 4.0.0-rc-2 API)

A B C D E F G H I J L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

activatedProfiles() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Returns the list of profiles to activate.
alsoMake() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should also build the specified projects' dependencies.
alsoMakeDependents() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should also build the specified projects' dependents.
alternatePomFile() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Returns the path to an alternate POM file.
altInstallationSettings() - Method in interface org.apache.maven.api.cli.Options: Returns the path to an alternate installation settings file.
altInstallationToolchains() - Method in interface org.apache.maven.api.cli.Options: Returns the path to an alternate installation toolchains file.
altProjectSettings() - Method in interface org.apache.maven.api.cli.Options: Returns the path to an alternate project settings file.
altUserSettings() - Method in interface org.apache.maven.api.cli.Options: Returns the path to an alternate user settings file.
altUserToolchains() - Method in interface org.apache.maven.api.cli.Options: Returns the path to an alternate user toolchains file.
args() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the command-line arguments to be parsed.
artifactId(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtension.Builder

B

build() - Method in class org.apache.maven.api.cli.extensions.CoreExtension.Builder
build() - Method in class org.apache.maven.api.cli.extensions.CoreExtensions.Builder
build() - Method in class org.apache.maven.api.cli.ParserRequest.Builder
builder() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Returns the id of the build strategy to use.
builder(String, String, List<String>, Logger, MessageBuilderFactory) - Static method in interface org.apache.maven.api.cli.ParserRequest: Creates a new Builder instance for constructing a ParserRequest.
Builder(boolean) - Constructor for class org.apache.maven.api.cli.extensions.CoreExtension.Builder
Builder(boolean) - Constructor for class org.apache.maven.api.cli.extensions.CoreExtensions.Builder
Builder(CoreExtension, boolean) - Constructor for class org.apache.maven.api.cli.extensions.CoreExtension.Builder
Builder(CoreExtensions, boolean) - Constructor for class org.apache.maven.api.cli.extensions.CoreExtensions.Builder

C

cacheArtifactNotFound() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should cache the "not found" status of artifacts that were not found in remote repositories.
classLoadingStrategy(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtension.Builder
close() - Method in interface org.apache.maven.api.cli.Invoker: Closes and disposes of this Invoker instance, releasing any resources it may hold.
color() - Method in interface org.apache.maven.api.cli.Options: Returns the color setting for console output.
command() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the Maven command to be executed.
commandName() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the Maven command name (ie "Maven").
configuration(XmlNode) - Method in class org.apache.maven.api.cli.extensions.CoreExtension.Builder
CoreExtension - Class in org.apache.maven.api.cli.extensions: Describes a build extension to utilise.
CoreExtension(CoreExtension.Builder) - Constructor for class org.apache.maven.api.cli.extensions.CoreExtension: Constructor for this class, to be called from its subclasses and CoreExtension.Builder.
CoreExtension.Builder - Class in org.apache.maven.api.cli.extensions: Builder class used to create CoreExtension instances.
coreExtensions() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns a list of core extensions, if configured in the .mvn/extensions.xml file.
CoreExtensions - Class in org.apache.maven.api.cli.extensions: Extensions to load.
CoreExtensions(CoreExtensions.Builder) - Constructor for class org.apache.maven.api.cli.extensions.CoreExtensions: Constructor for this class, to be called from its subclasses and CoreExtensions.Builder.
CoreExtensions.Builder - Class in org.apache.maven.api.cli.extensions: Builder class used to create CoreExtensions instances.
cwd() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the current working directory for the Maven execution.
cwd() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the current working directory for the Maven execution.
cwd(Path) - Method in class org.apache.maven.api.cli.ParserRequest.Builder

D

debug(String) - Method in interface org.apache.maven.api.cli.Logger: Logs a debug message without an associated exception.
debug(String, Throwable) - Method in interface org.apache.maven.api.cli.Logger: Logs a debug message with an associated exception.
DEBUG - Enum constant in enum class org.apache.maven.api.cli.Logger.Level
displayHelp(ParserRequest, Consumer<String>) - Method in interface org.apache.maven.api.cli.Options: Displays help information for these options.

E

EncryptOptions - Interface in org.apache.maven.api.cli.mvnenc: Defines the options specific to the Maven encryption tool.
err() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the error stream for the Maven execution, if running in embedded mode.
err() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the error stream to be used for the Maven execution.
err(OutputStream) - Method in class org.apache.maven.api.cli.ParserRequest.Builder
error(String) - Method in interface org.apache.maven.api.cli.Logger: Logs an error message without an associated exception.
error(String, Throwable) - Method in interface org.apache.maven.api.cli.Logger: Logs an error message with an associated exception.
ERROR - Enum constant in enum class org.apache.maven.api.cli.Logger.Level
ExitException(int) - Constructor for exception org.apache.maven.api.cli.InvokerException.ExitException
extensions(Collection<CoreExtension>) - Method in class org.apache.maven.api.cli.extensions.CoreExtensions.Builder

F

failAtEnd() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should run all builds but defer error reporting to the end.
failFast() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should stop at the first failure in a multi-module build.
failNever() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should never fail the build, regardless of project result.
failOnSeverity() - Method in interface org.apache.maven.api.cli.Options: Returns the severity level at which the build should fail.
force() - Method in interface org.apache.maven.api.cli.mvnenc.EncryptOptions: Should the operation be forced (ie overwrite existing config, if any).
forceInteractive() - Method in interface org.apache.maven.api.cli.Options: Indicates whether to force interactive mode.

G

getArtifactId() - Method in class org.apache.maven.api.cli.extensions.CoreExtension: The artifact ID of the extension.
getClassLoadingStrategy() - Method in class org.apache.maven.api.cli.extensions.CoreExtension: The class loading strategy: 'self-first' (the default), 'parent-first' (loads classes from the parent, then from the extension) or 'plugin' (follows the rules from extensions defined as plugins).
getConfiguration() - Method in class org.apache.maven.api.cli.extensions.CoreExtension
getExitCode() - Method in exception org.apache.maven.api.cli.InvokerException.ExitException
getExtensions() - Method in class org.apache.maven.api.cli.extensions.CoreExtensions: A set of build extensions to use from this project.
getGroupId() - Method in class org.apache.maven.api.cli.extensions.CoreExtension: The group ID of the extension's artifact.
getId() - Method in class org.apache.maven.api.cli.extensions.CoreExtension: Gets the identifier of the extension.
getModelEncoding() - Method in class org.apache.maven.api.cli.extensions.CoreExtensions
getNamespaceUri() - Method in class org.apache.maven.api.cli.extensions.CoreExtensions
getVersion() - Method in class org.apache.maven.api.cli.extensions.CoreExtension: The version of the extension.
goals() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Returns the list of goals and phases to execute.
goals() - Method in interface org.apache.maven.api.cli.mvnenc.EncryptOptions: Returns the list of encryption goals to be executed.
groupId(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtension.Builder

H

help() - Method in interface org.apache.maven.api.cli.Options: Indicates whether to show help information.

I

ignoreTransitiveRepositories() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should ignore transitive repositories.
in() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the input stream for the Maven execution, if running in embedded mode.
in() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the input stream to be used for the Maven execution.
in(InputStream) - Method in class org.apache.maven.api.cli.ParserRequest.Builder
info(String) - Method in interface org.apache.maven.api.cli.Logger: Logs an info message without an associated exception.
info(String, Throwable) - Method in interface org.apache.maven.api.cli.Logger: Logs an info message with an associated exception.
INFO - Enum constant in enum class org.apache.maven.api.cli.Logger.Level
installationDirectory() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the Maven installation directory.
interpolate(Collection<Map<String, String>>) - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Returns a new instance of MavenOptions with values interpolated using the given properties.
interpolate(Collection<Map<String, String>>) - Method in interface org.apache.maven.api.cli.mvnenc.EncryptOptions: Returns a new instance of EncryptOptions with values interpolated using the given properties.
interpolate(Collection<Map<String, String>>) - Method in interface org.apache.maven.api.cli.Options: Returns a new instance of Options with values interpolated using the given properties.
invoke(InvokerRequest) - Method in interface org.apache.maven.api.cli.Invoker: Invokes the Maven application using the provided InvokerRequest.
Invoker - Interface in org.apache.maven.api.cli: Defines the contract for a component responsible for invoking a Maven application using the information provided in an InvokerRequest.
InvokerException - Exception in org.apache.maven.api.cli: Represents an exception that occurs during the invocation of a Maven build or command.
InvokerException(String) - Constructor for exception org.apache.maven.api.cli.InvokerException: Constructs a new InvokerException with the specified detail message.
InvokerException(String, Throwable) - Constructor for exception org.apache.maven.api.cli.InvokerException: Constructs a new InvokerException with the specified detail message and cause.
InvokerException.ExitException - Exception in org.apache.maven.api.cli: Exception for intentional exit: No message or anything will be displayed, just the carried exit code will be returned from invoker Invoker.invoke(InvokerRequest) method.
InvokerRequest - Interface in org.apache.maven.api.cli: Represents a Maven invocation request, encapsulating all necessary information for invoking a Maven build or command.

J

jvmArguments() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the list of extra JVM arguments to be passed to the forked process.

L

log(Logger.Level, String) - Method in interface org.apache.maven.api.cli.Logger: Logs a message at the specified level without an associated exception.
log(Logger.Level, String, Throwable) - Method in interface org.apache.maven.api.cli.Logger: Logs a message at the specified level with an associated exception.
logFile() - Method in interface org.apache.maven.api.cli.Options: Returns the path to the log file.
logger() - Method in interface org.apache.maven.api.cli.InvokerRequest: Shorthand for Logger to use.
logger() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the logger to be used during the parsing process.
Logger - Interface in org.apache.maven.api.cli: Defines a simple logging interface for Maven CLI operations.
Logger.Level - Enum Class in org.apache.maven.api.cli: Represents the severity levels for log messages.
lookup() - Method in interface org.apache.maven.api.cli.InvokerRequest: Shorthand for Lookup.
lookup() - Method in interface org.apache.maven.api.cli.ParserRequest: Per-request Lookup for customization.
lookup(Lookup) - Method in class org.apache.maven.api.cli.ParserRequest.Builder

M

mavenHome() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the Maven home directory.
mavenHome(Path) - Method in class org.apache.maven.api.cli.ParserRequest.Builder
MavenOptions - Interface in org.apache.maven.api.cli.mvn: Defines the options specific to Maven operations.
messageBuilderFactory() - Method in interface org.apache.maven.api.cli.InvokerRequest: Shorthand for MessageBuilderFactory.
messageBuilderFactory() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the factory for creating message builders.
modelEncoding(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtensions.Builder
mvn(String[], Logger, MessageBuilderFactory) - Static method in interface org.apache.maven.api.cli.ParserRequest: Creates a new Builder instance for constructing a Maven ParserRequest.
mvn(List<String>, Logger, MessageBuilderFactory) - Static method in interface org.apache.maven.api.cli.ParserRequest: Creates a new Builder instance for constructing a Maven ParserRequest.
MVN_CMD - Static variable in class org.apache.maven.api.cli.Tools
MVN_NAME - Static variable in class org.apache.maven.api.cli.Tools
mvnenc(String[], Logger, MessageBuilderFactory) - Static method in interface org.apache.maven.api.cli.ParserRequest: Creates a new Builder instance for constructing a Maven Encrypting Tool ParserRequest.
mvnenc(List<String>, Logger, MessageBuilderFactory) - Static method in interface org.apache.maven.api.cli.ParserRequest: Creates a new Builder instance for constructing a Maven Encrypting Tool ParserRequest.
MVNENC_CMD - Static variable in class org.apache.maven.api.cli.Tools
MVNENC_NAME - Static variable in class org.apache.maven.api.cli.Tools

N

namespaceUri(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtensions.Builder
newBuilder() - Static method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension builder instance.
newBuilder() - Static method in class org.apache.maven.api.cli.extensions.CoreExtensions: Creates a new CoreExtensions builder instance.
newBuilder(boolean) - Static method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension builder instance using default values or not.
newBuilder(boolean) - Static method in class org.apache.maven.api.cli.extensions.CoreExtensions: Creates a new CoreExtensions builder instance using default values or not.
newBuilder(CoreExtension) - Static method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension builder instance using the specified object as a basis.
newBuilder(CoreExtension, boolean) - Static method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension builder instance using the specified object as a basis.
newBuilder(CoreExtensions) - Static method in class org.apache.maven.api.cli.extensions.CoreExtensions: Creates a new CoreExtensions builder instance using the specified object as a basis.
newBuilder(CoreExtensions, boolean) - Static method in class org.apache.maven.api.cli.extensions.CoreExtensions: Creates a new CoreExtensions builder instance using the specified object as a basis.
newInstance() - Static method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension instance.
newInstance() - Static method in class org.apache.maven.api.cli.extensions.CoreExtensions: Creates a new CoreExtensions instance.
newInstance(boolean) - Static method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension instance using default values or not.
newInstance(boolean) - Static method in class org.apache.maven.api.cli.extensions.CoreExtensions: Creates a new CoreExtensions instance using default values or not.
nonInteractive() - Method in interface org.apache.maven.api.cli.Options: Indicates whether to run in non-interactive mode.
nonRecursive() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should operate in non-recursive mode (i.e., not build child modules).
noTransferProgress() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should not display transfer progress when downloading or uploading.

O

offline() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should operate in offline mode.
options() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the options associated with this invocation request.
Options - Interface in org.apache.maven.api.cli: Represents the base options supported by Maven tools.
org.apache.maven.api.cli - package org.apache.maven.api.cli
org.apache.maven.api.cli.extensions - package org.apache.maven.api.cli.extensions
org.apache.maven.api.cli.mvn - package org.apache.maven.api.cli.mvn
org.apache.maven.api.cli.mvnenc - package org.apache.maven.api.cli.mvnenc
out() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the output stream for the Maven execution, if running in embedded mode.
out() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the output stream to be used for the Maven execution.
out(OutputStream) - Method in class org.apache.maven.api.cli.ParserRequest.Builder

P

parseInvocation(ParserRequest) - Method in interface org.apache.maven.api.cli.Parser: Parses the given ParserRequest to create an InvokerRequest.
Parser - Interface in org.apache.maven.api.cli: Defines the contract for parsing Maven command-line arguments and creating an execution or invoker requests.
ParserException - Exception in org.apache.maven.api.cli: Represents an exception that occurs during the parsing of Maven command-line arguments.
ParserException(String) - Constructor for exception org.apache.maven.api.cli.ParserException: Constructs a new ParserException with the specified detail message.
ParserException(String, Throwable) - Constructor for exception org.apache.maven.api.cli.ParserException: Constructs a new ParserException with the specified detail message and cause.
parserRequest() - Method in interface org.apache.maven.api.cli.InvokerRequest: The parser request this instance was created from.
ParserRequest - Interface in org.apache.maven.api.cli: Represents a request to parse Maven command-line arguments.
ParserRequest.Builder - Class in org.apache.maven.api.cli
projects() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Returns the list of specified reactor projects to build instead of all projects.

Q

quiet() - Method in interface org.apache.maven.api.cli.Options: Indicates whether to run in quiet mode.

R

rawStreams() - Method in interface org.apache.maven.api.cli.Options: Returns whether raw streams should be logged.
relaxedChecksums() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should use relaxed checksum verification.
resume() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should resume from the last failed project in a previous build.
resumeFrom() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Returns the project to resume the build from.
rootDirectory() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the root directory of the Maven invocation, if found.

S

showErrors() - Method in interface org.apache.maven.api.cli.Options: Indicates whether to show error stack traces.
showVersion() - Method in interface org.apache.maven.api.cli.Options: Indicates whether to show the version information.
showVersionAndExit() - Method in interface org.apache.maven.api.cli.Options: Indicates whether to show the version information and exit.
source() - Method in interface org.apache.maven.api.cli.Options: Returns a simple designator of the options source, such as "cli", "maven.conf", etc.
SOURCE_CLI - Static variable in interface org.apache.maven.api.cli.Options: Constant indicating that the options source is the command-line interface.
strictArtifactDescriptorPolicy() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should use strict artifact descriptor policy.
strictChecksums() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should use strict checksum verification.
suppressSnapshotUpdates() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should suppress SNAPSHOT updates.
systemProperties() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns a map of system properties for the Maven execution.

T

threads() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Returns the number of threads used for parallel builds.
Tools - Class in org.apache.maven.api.cli: Represents most common tools supported by CLIng.
topDirectory() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the top-level directory of the Maven invocation.

U

updateSnapshots() - Method in interface org.apache.maven.api.cli.mvn.MavenOptions: Indicates whether Maven should force a check for updated snapshots on remote repositories.
userHome() - Method in interface org.apache.maven.api.cli.ParserRequest: Returns the user's home directory.
userHome(Path) - Method in class org.apache.maven.api.cli.ParserRequest.Builder
userHomeDirectory() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns the user's home directory.
userProperties() - Method in interface org.apache.maven.api.cli.InvokerRequest: Returns a map of user-defined properties for the Maven execution.
userProperties() - Method in interface org.apache.maven.api.cli.Options: Returns the user-defined properties for the Maven execution.

V

valueOf(String) - Static method in enum class org.apache.maven.api.cli.Logger.Level: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.maven.api.cli.Logger.Level: Returns an array containing the constants of this enum class, in the order they are declared.
verbose() - Method in interface org.apache.maven.api.cli.Options: Indicates whether to run in verbose mode.
version(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtension.Builder

W

warn(String) - Method in interface org.apache.maven.api.cli.Logger: Logs a warning message without an associated exception.
warn(String, Throwable) - Method in interface org.apache.maven.api.cli.Logger: Logs a warning message with an associated exception.
WARN - Enum constant in enum class org.apache.maven.api.cli.Logger.Level
warnAboutDeprecatedOptions(ParserRequest, Consumer<String>) - Method in interface org.apache.maven.api.cli.Options: Emits warning messages if deprecated options are used.
with() - Method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new builder with this object as the basis.
with() - Method in class org.apache.maven.api.cli.extensions.CoreExtensions: Creates a new builder with this object as the basis.
withArtifactId(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension instance using the specified artifactId.
withClassLoadingStrategy(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension instance using the specified classLoadingStrategy.
withConfiguration(XmlNode) - Method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension instance using the specified configuration.
withExtensions(Collection<CoreExtension>) - Method in class org.apache.maven.api.cli.extensions.CoreExtensions: Creates a new CoreExtensions instance using the specified extensions.
withGroupId(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension instance using the specified groupId.
withVersion(String) - Method in class org.apache.maven.api.cli.extensions.CoreExtension: Creates a new CoreExtension instance using the specified version.

Y

yes() - Method in interface org.apache.maven.api.cli.mvnenc.EncryptOptions: Should imply "yes" to all questions.

A B C D E F G H I J L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form