Index

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

A

a(char[]) - Method in interface org.apache.maven.api.services.MessageBuilder

Append content to the message buffer.

a(char[], int, int) - Method in interface org.apache.maven.api.services.MessageBuilder

Append content to the message buffer.

a(CharSequence) - Method in interface org.apache.maven.api.services.MessageBuilder

Append content to the message buffer.

a(CharSequence, int, int) - Method in interface org.apache.maven.api.services.MessageBuilder

Append content to the message buffer.

a(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append content to the message buffer.

accept(NodeVisitor) - Method in interface org.apache.maven.api.Node

Traverses this node and potentially its children using the specified visitor.

addCompileSourceRoot(Project, ProjectScope, Path) - Method in interface org.apache.maven.api.services.ProjectManager

Add a compilation source root to the given project for the given scope.

addDefaultEntities(boolean) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

addResource(Project, ProjectScope, Resource) - Method in interface org.apache.maven.api.services.ProjectManager

Add a resource set to the given project for the given scope.

AGENT - Enum constant in enum class org.apache.maven.api.JavaPathType

The path identified by the Java -agentpath option.

aggregator() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo

if the Mojo uses the Maven project and its child modules.

alias() - Element in annotation interface org.apache.maven.api.plugin.annotations.Parameter

alias supported to get parameter value.

append(char) - Method in interface org.apache.maven.api.services.MessageBuilder

append(CharSequence) - Method in interface org.apache.maven.api.services.MessageBuilder

append(CharSequence, int, int) - Method in interface org.apache.maven.api.services.MessageBuilder

Artifact - Interface in org.apache.maven.api

An artifact points to a resource such as a jar file or war application.

ARTIFACT - Enum constant in enum class org.apache.maven.api.MetadataStorage

artifactCoordinate(ArtifactCoordinate) - Method in class org.apache.maven.api.services.VersionRangeResolverRequest.VersionResolverRequestBuilder

artifactCoordinate(ArtifactCoordinate) - Method in class org.apache.maven.api.services.VersionResolverRequest.VersionResolverRequestBuilder

ArtifactCoordinate - Interface in org.apache.maven.api

The Coordinate object is used to point to an Artifact but the version may be specified as a range instead of an exact version.

ArtifactCoordinateFactory - Interface in org.apache.maven.api.services

Service used to create ArtifactCoordinate objects.

ArtifactCoordinateFactoryRequest - Interface in org.apache.maven.api.services

A request for creating a ArtifactCoordinate object.

ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder - Class in org.apache.maven.api.services

ArtifactDeployer - Interface in org.apache.maven.api.services

Deploys Artifacts to a RemoteRepository.

ArtifactDeployerException - Exception Class in org.apache.maven.api.services

An artifact could not correctly being deployed.

ArtifactDeployerException(String, Exception) - Constructor for exception class org.apache.maven.api.services.ArtifactDeployerException

ArtifactDeployerRequest - Interface in org.apache.maven.api.services

A request for deploying one or more artifacts to a remote repository.

ArtifactDeployerRequest.ArtifactDeployerRequestBuilder - Class in org.apache.maven.api.services

ArtifactFactory - Interface in org.apache.maven.api.services

Service used to create Artifact objects.

ArtifactFactoryRequest - Interface in org.apache.maven.api.services

ArtifactFactoryRequest.ArtifactFactoryRequestBuilder - Class in org.apache.maven.api.services

artifactId(String) - Method in class org.apache.maven.api.services.ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder

artifactId(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder

artifactId(String) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

ArtifactInstaller - Interface in org.apache.maven.api.services

Installs Artifacts to the local repository.

ArtifactInstallerException - Exception Class in org.apache.maven.api.services

ArtifactInstallerException(String, Exception) - Constructor for exception class org.apache.maven.api.services.ArtifactInstallerException

ArtifactInstallerRequest - Interface in org.apache.maven.api.services

A request for installing one or more artifacts in the local repository.

ArtifactInstallerRequest.ArtifactInstallerRequestBuilder - Class in org.apache.maven.api.services

ArtifactManager - Interface in org.apache.maven.api.services

ArtifactResolver - Interface in org.apache.maven.api.services

Resolves the artifact, i.e download the file when required and attach it to the artifact

ArtifactResolverException - Exception Class in org.apache.maven.api.services

ArtifactResolverException(String, Exception) - Constructor for exception class org.apache.maven.api.services.ArtifactResolverException

ArtifactResolverRequest - Interface in org.apache.maven.api.services

A request for resolving an artifact.

ArtifactResolverRequest.ArtifactResolverRequestBuilder - Class in org.apache.maven.api.services

ArtifactResolverResult - Interface in org.apache.maven.api.services

The Artifact Result

artifacts(Collection<Artifact>) - Method in class org.apache.maven.api.services.ArtifactDeployerRequest.ArtifactDeployerRequestBuilder

artifacts(Collection<Artifact>) - Method in class org.apache.maven.api.services.ArtifactInstallerRequest.ArtifactInstallerRequestBuilder

asString() - Method in interface org.apache.maven.api.Node

Returns a string representation of this dependency node.

asString() - Method in interface org.apache.maven.api.Version

Returns a string representation of this version.

asString() - Method in interface org.apache.maven.api.VersionConstraint

Returns a string representation of this version constraint

asString() - Method in interface org.apache.maven.api.VersionRange

Returns a string representation of this version range

attachArtifact(Project, Artifact, Path) - Method in interface org.apache.maven.api.services.ProjectManager

attachArtifact(Session, Project, String, Path) - Method in interface org.apache.maven.api.services.ProjectManager

attachArtifact(Session, Project, Path) - Method in interface org.apache.maven.api.services.ProjectManager

B

BOM - Static variable in interface org.apache.maven.api.Type

Artifact type name for a BOM file.

build() - Method in class org.apache.maven.api.services.ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder

build() - Method in class org.apache.maven.api.services.ArtifactDeployerRequest.ArtifactDeployerRequestBuilder

build() - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder

build() - Method in class org.apache.maven.api.services.ArtifactInstallerRequest.ArtifactInstallerRequestBuilder

build() - Method in class org.apache.maven.api.services.ArtifactResolverRequest.ArtifactResolverRequestBuilder

build() - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

build() - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

build() - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

build() - Method in interface org.apache.maven.api.services.MessageBuilder

Return the built message.

build() - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder

build() - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder

build() - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder

build() - Method in class org.apache.maven.api.services.VersionRangeResolverRequest.VersionResolverRequestBuilder

build() - Method in class org.apache.maven.api.services.VersionResolverRequest.VersionResolverRequestBuilder

build() - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

build() - Method in class org.apache.maven.api.services.xml.XmlWriterRequest.XmlWriterRequestBuilder

build(ProjectBuilderRequest) - Method in interface org.apache.maven.api.services.ProjectBuilder

Creates a Project from a POM file.

build(SettingsBuilderRequest) - Method in interface org.apache.maven.api.services.SettingsBuilder

Builds the effective settings of the specified settings files.

build(ToolchainsBuilderRequest) - Method in interface org.apache.maven.api.services.ToolchainsBuilder

Builds the effective toolchains for the specified toolchains files.

build(Session, String) - Static method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

build(Session, String, String, String, String) - Static method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

build(Session, String, String, String, String) - Static method in interface org.apache.maven.api.services.ArtifactFactoryRequest

build(Session, String, String, String, String, String, String) - Static method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

build(Session, String, String, String, String, String, String) - Static method in interface org.apache.maven.api.services.ArtifactFactoryRequest

build(Session, String, String, String, String, String, String) - Static method in interface org.apache.maven.api.services.DependencyCoordinateFactoryRequest

build(Session, Path) - Method in interface org.apache.maven.api.services.ProjectBuilder

Creates a Project from a POM file.

build(Session, Path) - Static method in interface org.apache.maven.api.services.ProjectBuilderRequest

build(Session, Path, Path) - Method in interface org.apache.maven.api.services.SettingsBuilder

Builds the effective settings of the specified settings paths.

build(Session, Path, Path) - Static method in interface org.apache.maven.api.services.SettingsBuilderRequest

build(Session, Path, Path) - Static method in interface org.apache.maven.api.services.ToolchainsBuilderRequest

build(Session, Path, Path, Path) - Method in interface org.apache.maven.api.services.SettingsBuilder

Builds the effective settings of the specified settings paths.

build(Session, Path, Path, Path) - Static method in interface org.apache.maven.api.services.SettingsBuilderRequest

build(Session, Collection<? extends ArtifactCoordinate>) - Static method in interface org.apache.maven.api.services.ArtifactResolverRequest

build(Session, Collection<Artifact>) - Static method in interface org.apache.maven.api.services.ArtifactInstallerRequest

build(Session, List<DependencyCoordinate>) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest

build(Session, List<DependencyCoordinate>, PathScope) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest

build(Session, Artifact) - Static method in interface org.apache.maven.api.services.DependencyCollectorRequest

build(Session, ArtifactCoordinate) - Static method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

build(Session, ArtifactCoordinate) - Static method in interface org.apache.maven.api.services.DependencyCoordinateFactoryRequest

build(Session, ArtifactCoordinate) - Static method in interface org.apache.maven.api.services.VersionRangeResolverRequest

build(Session, ArtifactCoordinate) - Static method in interface org.apache.maven.api.services.VersionResolverRequest

build(Session, Dependency) - Static method in interface org.apache.maven.api.services.DependencyCoordinateFactoryRequest

build(Session, DependencyCoordinate) - Static method in interface org.apache.maven.api.services.DependencyCollectorRequest

build(Session, DependencyCoordinate) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest

build(Session, DependencyCoordinate, PathScope) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest

build(Session, Project) - Static method in interface org.apache.maven.api.services.DependencyCollectorRequest

build(Session, Project) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest

build(Session, Project, PathScope) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest

build(Session, RemoteRepository, Collection<Artifact>) - Static method in interface org.apache.maven.api.services.ArtifactDeployerRequest

build(Session, Source) - Method in interface org.apache.maven.api.services.ProjectBuilder

Creates a Project from a POM file.

build(Session, Source) - Static method in interface org.apache.maven.api.services.ProjectBuilderRequest

build(Session, Source, Source) - Method in interface org.apache.maven.api.services.SettingsBuilder

Builds the effective settings of the specified settings sources.

build(Session, Source, Source) - Static method in interface org.apache.maven.api.services.SettingsBuilderRequest

build(Session, Source, Source) - Method in interface org.apache.maven.api.services.ToolchainsBuilder

Builds the effective toolchains for the specified toolchains sources.

build(Session, Source, Source) - Static method in interface org.apache.maven.api.services.ToolchainsBuilderRequest

build(Session, Source, Source, Source) - Method in interface org.apache.maven.api.services.SettingsBuilder

Builds the effective settings of the specified settings sources.

build(Session, Source, Source, Source) - Static method in interface org.apache.maven.api.services.SettingsBuilderRequest

buildConsumer(Map<String, String>) - Static method in class org.apache.maven.api.feature.Features

Check if the build/consumer POM feature is active.

buildConsumer(Properties) - Static method in class org.apache.maven.api.feature.Features

Check if the build/consumer POM feature is active.

buildConsumer(Session) - Static method in class org.apache.maven.api.feature.Features

Check if the build/consumer POM feature is active.

BUILDCONSUMER - Static variable in class org.apache.maven.api.feature.Features

Name of the Maven user property to enable or disable the build/consumer POM feature.

builder() - Static method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

builder() - Static method in interface org.apache.maven.api.services.ArtifactDeployerRequest

builder() - Static method in interface org.apache.maven.api.services.ArtifactFactoryRequest

builder() - Static method in interface org.apache.maven.api.services.ArtifactInstallerRequest

builder() - Static method in interface org.apache.maven.api.services.ArtifactResolverRequest

builder() - Static method in interface org.apache.maven.api.services.DependencyCollectorRequest

builder() - Static method in interface org.apache.maven.api.services.DependencyCoordinateFactoryRequest

builder() - Static method in interface org.apache.maven.api.services.DependencyResolverRequest

builder() - Method in interface org.apache.maven.api.services.MessageBuilderFactory

Creates a new message builder.

builder() - Static method in interface org.apache.maven.api.services.ProjectBuilderRequest

builder() - Static method in interface org.apache.maven.api.services.SettingsBuilderRequest

builder() - Static method in interface org.apache.maven.api.services.ToolchainsBuilderRequest

builder() - Static method in interface org.apache.maven.api.services.VersionRangeResolverRequest

builder() - Static method in interface org.apache.maven.api.services.VersionResolverRequest

builder() - Static method in interface org.apache.maven.api.services.xml.XmlReaderRequest

builder() - Static method in interface org.apache.maven.api.services.xml.XmlWriterRequest

builder(int) - Method in interface org.apache.maven.api.services.MessageBuilderFactory

Creates a new message builder of the specified size.

BuilderProblem - Interface in org.apache.maven.api.services

Describes a problem that was encountered during project building.

BuilderProblem.Severity - Enum Class in org.apache.maven.api.services

The different severity levels for a problem, in decreasing order.

C

calculate(byte[], Collection<ChecksumAlgorithmService.ChecksumAlgorithm>) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService

Calculates checksums for specified data.

calculate(InputStream, Collection<ChecksumAlgorithmService.ChecksumAlgorithm>) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService

Calculates checksums for specified stream.

calculate(ByteBuffer, Collection<ChecksumAlgorithmService.ChecksumAlgorithm>) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService

Calculates checksums for specified data.

calculate(Path, Collection<ChecksumAlgorithmService.ChecksumAlgorithm>) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService

Calculates checksums for specified file.

CENTRAL_ID - Static variable in interface org.apache.maven.api.Repository

The reserved id for Maven Central

checksum() - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService.ChecksumCalculator

Returns the algorithm end result as string, never null.

ChecksumAlgorithmService - Interface in org.apache.maven.api.services

Checksum algorithms service.

ChecksumAlgorithmService.ChecksumAlgorithm - Interface in org.apache.maven.api.services

The checksum algorithm.

ChecksumAlgorithmService.ChecksumCalculator - Interface in org.apache.maven.api.services

The checksum calculator.

ChecksumAlgorithmServiceException - Exception Class in org.apache.maven.api.services

ChecksumAlgorithmServiceException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.ChecksumAlgorithmServiceException

CLASSES - Enum constant in enum class org.apache.maven.api.JavaPathType

The path identified by the Java --class-path option.

classifier(String) - Method in class org.apache.maven.api.services.ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder

classifier(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder

classifier(String) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

CLASSPATH_JAR - Static variable in interface org.apache.maven.api.Type

Artifact type name for a JAR file to unconditionally place on the class-path.

CLEAN - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

collect(DependencyCollectorRequest) - Method in interface org.apache.maven.api.services.DependencyCollector

Collects the transitive dependencies and builds a dependency graph.

collect(Session, Artifact) - Method in interface org.apache.maven.api.services.DependencyCollector

Collects the transitive dependencies of some artifacts and builds a dependency graph.

collect(Session, DependencyCoordinate) - Method in interface org.apache.maven.api.services.DependencyCollector

Collects the transitive dependencies of some artifacts and builds a dependency graph.

collect(Session, Project) - Method in interface org.apache.maven.api.services.DependencyCollector

Collects the transitive dependencies of some artifacts and builds a dependency graph.

collectDependencies(Artifact) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyCollector.class).collect(...)

collectDependencies(DependencyCoordinate) - Method in interface org.apache.maven.api.Session

Collects the transitive dependencies of some artifacts and builds a dependency graph.

collectDependencies(Project) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyCollector.class).collect(...)

COMPILE - Enum constant in enum class org.apache.maven.api.DependencyScope

Compile, runtime and test.

COMPILE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

COMPILE_ONLY - Enum constant in enum class org.apache.maven.api.DependencyScope

Compile only.

computeIfAbsent(SessionData.Key<T>, Supplier<T>) - Method in interface org.apache.maven.api.SessionData

Retrieve of compute the data associated with the specified key.

configurator() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo

TODO: v4: add a SPI for the configurator configurator bean name.

contains(Version) - Method in interface org.apache.maven.api.VersionConstraint

Determines whether the specified version is contained within this constraint.

contains(Version) - Method in interface org.apache.maven.api.VersionRange

Determines whether the specified version is contained within this range.

content(T) - Method in class org.apache.maven.api.services.xml.XmlWriterRequest.XmlWriterRequestBuilder

coordinates(Collection<? extends ArtifactCoordinate>) - Method in class org.apache.maven.api.services.ArtifactResolverRequest.ArtifactResolverRequestBuilder

coordinateString(String) - Method in class org.apache.maven.api.services.ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder

coordinateString(String) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

create(ArtifactCoordinateFactoryRequest) - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactory

Creates a coordinate.

create(ArtifactFactoryRequest) - Method in interface org.apache.maven.api.services.ArtifactFactory

Creates an artifact.

create(DependencyCoordinateFactoryRequest) - Method in interface org.apache.maven.api.services.DependencyCoordinateFactory

Creates a new DependencyCoordinate object from the request.

create(Session, String) - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactory

Creates a coordinate out of string that is formatted like: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>

create(Session, String, String, String, String) - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactory

create(Session, String, String, String, String) - Method in interface org.apache.maven.api.services.ArtifactFactory

create(Session, String, String, String, String, String, String) - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactory

create(Session, String, String, String, String, String, String) - Method in interface org.apache.maven.api.services.ArtifactFactory

create(Session, Artifact) - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactory

create(Session, ArtifactCoordinate) - Method in interface org.apache.maven.api.services.DependencyCoordinateFactory

create(Session, Dependency) - Method in interface org.apache.maven.api.services.DependencyCoordinateFactory

create(Session, Dependency) - Method in interface org.apache.maven.api.services.DependencyCoordinateFactory

create(Session, Plugin) - Method in interface org.apache.maven.api.services.DependencyCoordinateFactory

create(Session, ReportPlugin) - Method in interface org.apache.maven.api.services.DependencyCoordinateFactory

createArtifact(String, String, String, String) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactFactory.class).create(...).

createArtifact(String, String, String, String, String, String) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactFactory.class).create(...).

createArtifactCoordinate(String) - Method in interface org.apache.maven.api.Session

Creates a coordinate out of string that is formatted like: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>.

createArtifactCoordinate(String, String, String, String) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactFactory.class).create(...).

createArtifactCoordinate(String, String, String, String, String, String) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactFactory.class).create(...).

createArtifactCoordinate(Artifact) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactFactory.class).create(...).

createDependencyCoordinate(ArtifactCoordinate) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyFactory.class).create(...).

createDependencyCoordinate(Dependency) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyFactory.class).create(...).

createLocal(Path) - Method in interface org.apache.maven.api.services.RepositoryFactory

createLocalRepository(Path) - Method in interface org.apache.maven.api.Session

Shortcut for getService(RepositoryFactory.class).createLocal(...).

createRemote(String, String) - Method in interface org.apache.maven.api.services.RepositoryFactory

createRemote(Repository) - Method in interface org.apache.maven.api.services.RepositoryFactory

createRemoteRepository(String, String) - Method in interface org.apache.maven.api.Session

Shortcut for getService(RepositoryFactory.class).createRemote(...).

createRemoteRepository(Repository) - Method in interface org.apache.maven.api.Session

Shortcut for getService(RepositoryFactory.class).createRemote(...).

customPhase() - Element in annotation interface org.apache.maven.api.plugin.annotations.Execute

Custom lifecycle phase to fork.

D

debug(CharSequence) - Method in interface org.apache.maven.api.plugin.Log

Send a message to the user in the debug error level.

debug(CharSequence, Throwable) - Method in interface org.apache.maven.api.plugin.Log

Send a message (and accompanying exception) to the user in the debug error level.
The error's stacktrace will be output when this error level is enabled.

debug(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in debug style.

debug(Throwable) - Method in interface org.apache.maven.api.plugin.Log

Send an exception to the user in the debug error level.
The stack trace for this exception will be output when this error level is enabled.

debug(Supplier<String>) - Method in interface org.apache.maven.api.plugin.Log

debug(Supplier<String>, Throwable) - Method in interface org.apache.maven.api.plugin.Log

defaultPhase() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo

default phase to bind your mojo.

defaultValue() - Element in annotation interface org.apache.maven.api.plugin.annotations.Parameter

parameter default value, may contain ${...} expressions which will be interpreted at inject time: see PluginParameterExpressionEvaluator.

dependencies(List<DependencyCoordinate>) - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

Sets the direct dependencies.

dependencies(List<DependencyCoordinate>) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

dependency(DependencyCoordinate) - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

Adds the specified direct dependency.

dependency(DependencyCoordinate) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

Dependency - Interface in org.apache.maven.api

DependencyCollector - Interface in org.apache.maven.api.services

The DependencyCollector service can be used to collect dependencies for a given artifact and builds a graph of them.

DependencyCollectorException - Exception Class in org.apache.maven.api.services

Thrown in case of bad artifact descriptors, version ranges or other issues encountered during calculation of the dependency graph.

DependencyCollectorException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.DependencyCollectorException

DependencyCollectorRequest - Interface in org.apache.maven.api.services

A request to collect the transitive dependencies and to build a dependency graph from them.

DependencyCollectorRequest.DependencyCollectorRequestBuilder - Class in org.apache.maven.api.services

DependencyCollectorResult - Interface in org.apache.maven.api.services

The result of a dependency collection request.

DependencyCoordinate - Interface in org.apache.maven.api

DependencyCoordinateFactory - Interface in org.apache.maven.api.services

DependencyCoordinateFactoryRequest - Interface in org.apache.maven.api.services

DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder - Class in org.apache.maven.api.services

DependencyResolver - Interface in org.apache.maven.api.services

Collects, flattens and resolves dependencies.

DependencyResolverException - Exception Class in org.apache.maven.api.services

DependencyResolverException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.DependencyResolverException

DependencyResolverRequest - Interface in org.apache.maven.api.services

DependencyResolverRequest.DependencyResolverRequestBuilder - Class in org.apache.maven.api.services

DependencyResolverRequestBuilder() - Constructor for class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

DependencyResolverResult - Interface in org.apache.maven.api.services

DependencyScope - Enum Class in org.apache.maven.api

Dependency scope.

dependencyScopes() - Method in interface org.apache.maven.api.PathScope

deploy(ArtifactDeployerRequest) - Method in interface org.apache.maven.api.services.ArtifactDeployer

deploy(Session, RemoteRepository, Collection<Artifact>) - Method in interface org.apache.maven.api.services.ArtifactDeployer

DEPLOY - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

deployArtifact(RemoteRepository, Artifact...) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactDeployer.class).deploy(...).

DOCLET - Enum constant in enum class org.apache.maven.api.JavaPathType

The path identified by the Javadoc -doclet option.

E

enter(Node) - Method in interface org.apache.maven.api.NodeVisitor

Starts the visit to the specified dependency node.

equals(Object) - Method in class org.apache.maven.api.SessionData.Key

error(CharSequence) - Method in interface org.apache.maven.api.plugin.Log

Send a message to the user in the error error level.

error(CharSequence, Throwable) - Method in interface org.apache.maven.api.plugin.Log

Send a message (and accompanying exception) to the user in the error error level.
The error's stacktrace will be output when this error level is enabled.

error(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in error style.

error(Throwable) - Method in interface org.apache.maven.api.plugin.Log

Send an exception to the user in the error error level.
The stack trace for this exception will be output when this error level is enabled.

error(Supplier<String>) - Method in interface org.apache.maven.api.plugin.Log

error(Supplier<String>, Throwable) - Method in interface org.apache.maven.api.plugin.Log

ERROR - Enum constant in enum class org.apache.maven.api.services.BuilderProblem.Severity

Event - Interface in org.apache.maven.api

Event sent by maven during various phases of the build process.

EventType - Enum Class in org.apache.maven.api

The possible types of execution events.

exclusion(Exclusion) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

Exclusion - Interface in org.apache.maven.api

A dependency exclusion.

exclusions(Collection<Exclusion>) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

execute() - Method in interface org.apache.maven.api.plugin.Mojo

Perform whatever build-process behavior this Mojo implements.
This is the main trigger for the Mojo inside the Maven system, and allows the Mojo to communicate errors.

Execute - Annotation Interface in org.apache.maven.api.plugin.annotations

Used if your Mojo needs to fork a lifecycle.

ExtensibleEnum - Interface in org.apache.maven.api

Interface that defines some kind of enums that can be extended by Maven plugins or extensions.

ExtensibleEnumRegistry<T> - Interface in org.apache.maven.api.services

extension(String) - Method in class org.apache.maven.api.services.ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder

extension(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder

extension(String) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

F

failure(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in failure style.

FATAL - Enum constant in enum class org.apache.maven.api.services.BuilderProblem.Severity

Features - Class in org.apache.maven.api.feature

Centralized class for Maven Core feature information.

filter(Predicate<Node>) - Method in interface org.apache.maven.api.Node

Returns a new tree starting at this node, filtering the children.

findTool(String) - Method in interface org.apache.maven.api.Toolchain

Gets the platform tool executable.

flatten(Session, Node, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver

flattenDependencies(Node, PathScope) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyResolver.class).flatten(...).

forId(String) - Static method in enum class org.apache.maven.api.DependencyScope

FORK_FAILED - Enum constant in enum class org.apache.maven.api.EventType

FORK_STARTED - Enum constant in enum class org.apache.maven.api.EventType

FORK_SUCCEEDED - Enum constant in enum class org.apache.maven.api.EventType

FORKED_PROJECT_FAILED - Enum constant in enum class org.apache.maven.api.EventType

FORKED_PROJECT_STARTED - Enum constant in enum class org.apache.maven.api.EventType

FORKED_PROJECT_SUCCEEDED - Enum constant in enum class org.apache.maven.api.EventType

format(String, Object...) - Method in interface org.apache.maven.api.services.MessageBuilder

Append formatted content to the buffer.

formatOption(PathType) - Method in interface org.apache.maven.api.services.DependencyResolverResult

Formats the command-line option for the path of the specified type.

fromXmlString(String) - Method in interface org.apache.maven.api.services.xml.XmlFactory

Simply parse the given xml string.

G

GENERATE_RESOURCES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

GENERATE_SOURCES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

GENERATE_TEST_RESOURCES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

GENERATE_TEST_SOURCES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

get(URI, Path) - Method in interface org.apache.maven.api.services.Transport

GETs the source URI content into target (does not have to exist, or will be overwritten if exist).

get(SessionData.Key<T>) - Method in interface org.apache.maven.api.SessionData

Gets the session data associated with the specified key.

getAllArtifacts(Project) - Method in interface org.apache.maven.api.services.ProjectManager

Returns project's all artifacts as immutable collection.

getArtifact() - Method in interface org.apache.maven.api.Node

getArtifact() - Method in interface org.apache.maven.api.Plugin

getArtifactCoordinate() - Method in interface org.apache.maven.api.services.VersionRangeResolverRequest

getArtifactCoordinate() - Method in interface org.apache.maven.api.services.VersionResolverRequest

getArtifactId() - Method in interface org.apache.maven.api.Artifact

The artifactId of the artifact.

getArtifactId() - Method in interface org.apache.maven.api.ArtifactCoordinate

The artifactId of the artifact.

getArtifactId() - Method in interface org.apache.maven.api.Exclusion

getArtifactId() - Method in interface org.apache.maven.api.Project

Returns the project artifactId.

getArtifactId() - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

getArtifactId() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest

getArtifactPath(Artifact) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactManager.class).getPath(...).

getArtifacts() - Method in interface org.apache.maven.api.Project

Returns the project artifacts as immutable list.

getArtifacts() - Method in interface org.apache.maven.api.services.ArtifactDeployerRequest

getArtifacts() - Method in interface org.apache.maven.api.services.ArtifactInstallerRequest

getArtifacts() - Method in interface org.apache.maven.api.services.ArtifactResolverResult

getAttachedArtifacts(Project) - Method in interface org.apache.maven.api.services.ProjectManager

Returns an immutable collection of attached artifacts for given project.

getBasedir() - Method in interface org.apache.maven.api.Project

Returns the project base directory, i.e.

getBaseVersion() - Method in interface org.apache.maven.api.Artifact

The base version of the artifact.

getBuild() - Method in interface org.apache.maven.api.Project

Shorthand method.

getBytes(URI) - Method in interface org.apache.maven.api.services.Transport

GETs the source URI content as byte array.

getCalculator() - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService.ChecksumAlgorithm

Each invocation of this method returns a new instance of calculator, never null value.

getChecksumAlgorithmNames() - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService

Returns immutable collection of all supported algorithm names.

getChildren() - Method in interface org.apache.maven.api.Node

Gets the child nodes of this node.

getClassifier() - Method in interface org.apache.maven.api.Artifact

The classifier of the artifact.

getClassifier() - Method in interface org.apache.maven.api.ArtifactCoordinate

The classifier of the artifact.

getClassifier() - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

getClassifier() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest

getClassifier() - Method in interface org.apache.maven.api.Type

Get the default classifier associated to the dependency type.

getClassLoader() - Method in interface org.apache.maven.api.Plugin

getColumnNumber() - Method in interface org.apache.maven.api.services.BuilderProblem

Gets the one-based index of the column containing the problem.

getCompileSourceRoots(Project, ProjectScope) - Method in interface org.apache.maven.api.services.ProjectManager

Obtain an immutable list of compile source roots for the given project and scope.

getConfiguration() - Method in interface org.apache.maven.api.MojoExecution

getContent() - Method in interface org.apache.maven.api.services.xml.XmlWriterRequest

getCoordinates() - Method in interface org.apache.maven.api.services.ArtifactResolverRequest

getCoordinateString() - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

getData() - Method in interface org.apache.maven.api.Session

getDegreeOfConcurrency() - Method in interface org.apache.maven.api.Session

getDependencies() - Method in interface org.apache.maven.api.Plugin

getDependencies() - Method in interface org.apache.maven.api.Project

Returns the project direct dependencies (directly specified or inherited).

getDependencies() - Method in interface org.apache.maven.api.services.DependencyCollectorRequest

getDependencies() - Method in interface org.apache.maven.api.services.DependencyResolverResult

getDependenciesMap() - Method in interface org.apache.maven.api.Plugin

getDependency() - Method in interface org.apache.maven.api.Node

getDependencyResolverResult() - Method in interface org.apache.maven.api.services.ProjectBuilderResult

Gets the result of the dependency resolution for the project.

getDescriptor() - Method in interface org.apache.maven.api.MojoExecution

getDescriptor() - Method in interface org.apache.maven.api.Plugin

getDispatchedPaths() - Method in interface org.apache.maven.api.services.DependencyResolverResult

Returns the file paths of all dependencies, dispatched according the tool options where to place them.

getEffectiveProperties(Project) - Method in interface org.apache.maven.api.Session

Each invocation computes a new map of effective properties.

getEffectiveSettings() - Method in interface org.apache.maven.api.services.SettingsBuilderResult

Gets the assembled settings.

getEffectiveToolchains() - Method in interface org.apache.maven.api.services.ToolchainsBuilderResult

Gets the assembled toolchains.

getException() - Method in interface org.apache.maven.api.Event

Gets the exception that caused the event (if any).

getException() - Method in interface org.apache.maven.api.services.BuilderProblem

Gets the exception that caused this problem (if any).

getExceptions() - Method in interface org.apache.maven.api.services.DependencyCollectorResult

Gets the exceptions that occurred while building the dependency graph.

getExceptions() - Method in interface org.apache.maven.api.services.VersionRangeResolverResult

getExceptions() - Method in interface org.apache.maven.api.services.VersionResolverResult

getExclusions() - Method in interface org.apache.maven.api.DependencyCoordinate

getExclusions() - Method in interface org.apache.maven.api.services.DependencyCoordinateFactoryRequest

getExecutionId() - Method in interface org.apache.maven.api.MojoExecution

getExecutionProject(Project) - Method in interface org.apache.maven.api.services.ProjectManager

getExtension() - Method in interface org.apache.maven.api.Artifact

The file extension of the artifact.

getExtension() - Method in interface org.apache.maven.api.ArtifactCoordinate

The extension of the artifact.

getExtension() - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

getExtension() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest

getExtension() - Method in interface org.apache.maven.api.Type

Get the file extension of artifacts of this type.

getFileExtension() - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService.ChecksumAlgorithm

Returns the file extension to be used for given checksum file (without leading dot), never null.

getGlobalSettingsPath() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest

Gets the global settings path.

getGlobalSettingsSource() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest

Gets the global settings source.

getGlobalToolchainsPath() - Method in interface org.apache.maven.api.services.ToolchainsBuilderRequest

Gets the global Toolchains path.

getGlobalToolchainsSource() - Method in interface org.apache.maven.api.services.ToolchainsBuilderRequest

Gets the global Toolchains source.

getGoal() - Method in interface org.apache.maven.api.MojoExecution

getGroupId() - Method in interface org.apache.maven.api.Artifact

The groupId of the artifact.

getGroupId() - Method in interface org.apache.maven.api.ArtifactCoordinate

The groupId of the artifact.

getGroupId() - Method in interface org.apache.maven.api.Exclusion

getGroupId() - Method in interface org.apache.maven.api.Project

Returns the project groupId.

getGroupId() - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

getGroupId() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest

getHigherVersion() - Method in interface org.apache.maven.api.services.VersionRangeResolverResult

getId() - Method in interface org.apache.maven.api.ArtifactCoordinate

Unique id identifying this artifact

getId() - Method in interface org.apache.maven.api.Project

Returns the project ID, usable as key.

getId() - Method in interface org.apache.maven.api.Repository

Gets the identifier of this repository.

getInputStream() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest

getJavaHome() - Method in interface org.apache.maven.api.JavaToolchain

getLanguage() - Method in interface org.apache.maven.api.Project

Returns the project language.

getLanguage() - Method in interface org.apache.maven.api.Type

Returns the dependency type language.

getLifecyclePhase() - Method in interface org.apache.maven.api.MojoExecution

getLifecycles() - Method in interface org.apache.maven.api.Plugin

getLifecycles() - Method in interface org.apache.maven.api.plugin.LifecycleProvider

getLineNumber() - Method in interface org.apache.maven.api.services.BuilderProblem

Gets the one-based index of the line containing the problem.

getListeners() - Method in interface org.apache.maven.api.Session

Returns the list of registered listeners.

getLocalRepository() - Method in interface org.apache.maven.api.Session

getLocation() - Method in interface org.apache.maven.api.services.BuilderProblem

Gets the location of the problem.

getLocation() - Method in interface org.apache.maven.api.services.Source

Provides a user-friendly hint about the location of the source.

getLocation() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest

getLongMessage() - Method in exception class org.apache.maven.api.plugin.MojoException

getLowerBoundary() - Method in interface org.apache.maven.api.VersionRange

Returns the lower boundary of this range, or null if none.

getLowerVersion() - Method in interface org.apache.maven.api.services.VersionRangeResolverResult

getMainArtifact() - Method in interface org.apache.maven.api.Project

Returns the project main artifact, which is the artifact produced by this project build, if applicable.

getManagedDependencies() - Method in interface org.apache.maven.api.Project

Returns the project managed dependencies (directly specified or inherited).

getManagedDependencies() - Method in interface org.apache.maven.api.services.DependencyCollectorRequest

getMavenVersion() - Method in interface org.apache.maven.api.Session

Returns the current maven version

getMessage() - Method in interface org.apache.maven.api.services.BuilderProblem

Gets the message that describes this problem.

getModel() - Method in interface org.apache.maven.api.MojoExecution

getModel() - Method in interface org.apache.maven.api.Plugin

getModel() - Method in interface org.apache.maven.api.Project

Returns the project model.

getModelId() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest

getMojoExecution() - Method in interface org.apache.maven.api.Event

Gets the current mojo execution (if any).

getName() - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService.ChecksumAlgorithm

Returns the algorithm name, usually used as key, never null value.

getNodes() - Method in interface org.apache.maven.api.services.DependencyResolverResult

The ordered list of the flattened dependency nodes.

getOptional() - Method in interface org.apache.maven.api.DependencyCoordinate

getOutputStream() - Method in interface org.apache.maven.api.services.xml.XmlWriterRequest

getPackaging() - Method in interface org.apache.maven.api.Project

Returns the project packaging.

getParent() - Method in interface org.apache.maven.api.Project

Returns project parent project, if any.

getPath() - Method in interface org.apache.maven.api.LocalRepository

getPath() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest

getPath() - Method in interface org.apache.maven.api.services.Source

Provides access the file to be parsed, if this source is backed by a file.

getPath() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest

getPath() - Method in interface org.apache.maven.api.services.xml.XmlWriterRequest

getPath(Artifact) - Method in interface org.apache.maven.api.services.ArtifactManager

Returns the path of the file previously associated to this artifact or Optional.empty() if no path has been associated.

getPath(Project) - Method in interface org.apache.maven.api.services.ProjectManager

Returns the path to the built project artifact file, if the project has been built.

getPathForLocalArtifact(Artifact) - Method in interface org.apache.maven.api.Session

Gets the relative path for a locally installed artifact.

getPathForLocalArtifact(Session, LocalRepository, Artifact) - Method in interface org.apache.maven.api.services.LocalRepositoryManager

Gets the relative path for a locally installed artifact.

getPathForRemoteArtifact(RemoteRepository, Artifact) - Method in interface org.apache.maven.api.Session

Gets the relative path for an artifact cached from a remote repository.

getPathForRemoteArtifact(Session, LocalRepository, RemoteRepository, Artifact) - Method in interface org.apache.maven.api.services.LocalRepositoryManager

Gets the relative path for an artifact cached from a remote repository.

getPaths() - Method in interface org.apache.maven.api.services.DependencyResolverResult

Returns the file paths of all dependencies, regardless on which tool option those paths should be placed.

getPathScope() - Method in interface org.apache.maven.api.services.DependencyResolverRequest

getPathTypeFilter() - Method in interface org.apache.maven.api.services.DependencyResolverRequest

Returns a filter for the types of path (class-path, module-path, …) accepted by the tool.

getPathTypes() - Method in interface org.apache.maven.api.Type

Types of path (class-path, module-path, …) where the dependency can be placed.

getPlugin() - Method in interface org.apache.maven.api.MojoExecution

getPluginContext(Project) - Method in interface org.apache.maven.api.Session

Returns the plugin context for mojo being executed and the specified Project, never returns null as if context not present, creates it.

getPomArtifact() - Method in interface org.apache.maven.api.Project

Returns the project POM artifact, which is the artifact of the POM of this project.

getPomFile() - Method in interface org.apache.maven.api.services.ProjectBuilderResult

Gets the POM file from which the project was built.

getPomPath() - Method in interface org.apache.maven.api.Project

Returns the path to the pom file for this project.

getProblems() - Method in interface org.apache.maven.api.services.ProjectBuilderResult

Gets the problems that were encountered during the project building.

getProblems() - Method in interface org.apache.maven.api.services.SettingsBuilderResult

Gets the problems that were encountered during the settings building.

getProblems() - Method in interface org.apache.maven.api.services.ToolchainsBuilderResult

Gets the problems that were encountered during the settings building.

getProject() - Method in interface org.apache.maven.api.Event

Gets the current project (if any).

getProject() - Method in interface org.apache.maven.api.services.DependencyCollectorRequest

getProject() - Method in interface org.apache.maven.api.services.ProjectBuilderResult

Gets the project that was built.

getProjectId() - Method in interface org.apache.maven.api.services.ProjectBuilderResult

Gets the identifier of the project that could not be built.

getProjects() - Method in interface org.apache.maven.api.Session

getProjectSettingsPath() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest

Gets the project settings path.

getProjectSettingsSource() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest

Gets the project settings source.

getProperties(Project) - Method in interface org.apache.maven.api.services.ProjectManager

Returns an immutable map of the project properties.

getProtocol() - Method in interface org.apache.maven.api.RemoteRepository

getReader() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest

getRecommendedVersion() - Method in interface org.apache.maven.api.VersionConstraint

Returns the recommended version of this constraint, or null if none.

getRemotePluginRepositories(Project) - Method in interface org.apache.maven.api.services.ProjectManager

Returns an immutable list of project remote plugin repositories (directly specified or inherited).

getRemoteProjectRepositories(Project) - Method in interface org.apache.maven.api.services.ProjectManager

Returns an immutable list of project remote repositories (directly specified or inherited).

getRemoteRepositories() - Method in interface org.apache.maven.api.Node

getRemoteRepositories() - Method in interface org.apache.maven.api.Session

getRepository() - Method in interface org.apache.maven.api.Node

The repository where this artifact has been downloaded from.

getRepository() - Method in interface org.apache.maven.api.services.ArtifactDeployerRequest

getRepository() - Method in interface org.apache.maven.api.services.VersionResolverResult

getRepository(Version) - Method in interface org.apache.maven.api.services.VersionRangeResolverResult

getResources(Project, ProjectScope) - Method in interface org.apache.maven.api.services.ProjectManager

Get the list of resources for the given project and scope

getRetryFailedDeploymentCount() - Method in interface org.apache.maven.api.services.ArtifactDeployerRequest

getRoot() - Method in interface org.apache.maven.api.services.DependencyCollectorRequest

getRoot() - Method in interface org.apache.maven.api.services.DependencyCollectorResult

Gets the root node of the dependency graph.

getRootArtifact() - Method in interface org.apache.maven.api.services.DependencyCollectorRequest

getRootDirectory() - Method in interface org.apache.maven.api.Project

Gets the root directory of the project, which is the parent directory containing the .mvn directory or flagged with root="true".

getRootDirectory() - Method in interface org.apache.maven.api.Session

Gets the root directory of the session, which is the root directory for the top directory project.

getScope() - Method in interface org.apache.maven.api.Dependency

getScope() - Method in interface org.apache.maven.api.DependencyCoordinate

getScope() - Method in interface org.apache.maven.api.services.DependencyCoordinateFactoryRequest

getService(Class<T>) - Method in interface org.apache.maven.api.Session

Retrieves the service for the interface

getSession() - Method in interface org.apache.maven.api.Event

Gets the session from which this event originates.

getSession() - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

getSession() - Method in interface org.apache.maven.api.services.ArtifactDeployerRequest

getSession() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest

getSession() - Method in interface org.apache.maven.api.services.ArtifactInstallerRequest

getSession() - Method in interface org.apache.maven.api.services.ArtifactResolverRequest

getSession() - Method in interface org.apache.maven.api.services.DependencyCollectorRequest

getSession() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest

getSession() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest

getSession() - Method in interface org.apache.maven.api.services.ToolchainsBuilderRequest

getSession() - Method in interface org.apache.maven.api.services.VersionRangeResolverRequest

getSession() - Method in interface org.apache.maven.api.services.VersionResolverRequest

getSettings() - Method in interface org.apache.maven.api.Session

getSeverity() - Method in interface org.apache.maven.api.services.BuilderProblem

Gets the severity level of this problem.

getSource() - Method in exception class org.apache.maven.api.plugin.MojoException

getSource() - Method in interface org.apache.maven.api.services.BuilderProblem

Gets the hint about the source of the problem.

getSource() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest

getStartTime() - Method in interface org.apache.maven.api.Session

getString(URI) - Method in interface org.apache.maven.api.services.Transport

GETs the source URI content as string using UTF8 charset.

getString(URI, Charset) - Method in interface org.apache.maven.api.services.Transport

GETs the source URI content as string.

getSuperPom(String) - Method in interface org.apache.maven.api.services.SuperPomProvider

Gets the super POM for the specified model version.

getSystemProperties() - Method in interface org.apache.maven.api.Session

Returns immutable system properties to use for interpolation.

getTerminalWidth() - Method in interface org.apache.maven.api.services.MessageBuilderFactory

Returns the terminal width or -1 if not supported.

getToolchainFromBuildContext(Session, String) - Method in interface org.apache.maven.api.services.ToolchainManager

getToolchains(Session, String, Map<String, String>) - Method in interface org.apache.maven.api.services.ToolchainManager

getToolchainsForType(Session, String) - Method in interface org.apache.maven.api.services.ToolchainManager

getTopDirectory() - Method in interface org.apache.maven.api.Session

Gets the directory of the topmost project being built, usually the current directory or the directory pointed at by the -f/--file command line argument.

getTransformer() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest

getType() - Method in interface org.apache.maven.api.Dependency

The dependency type.

getType() - Method in interface org.apache.maven.api.DependencyCoordinate

The type of the artifact.

getType() - Method in interface org.apache.maven.api.Event

Gets the type of the event.

getType() - Method in interface org.apache.maven.api.Packaging

The type of main artifact produced by this packaging.

getType() - Method in interface org.apache.maven.api.Repository

Gets the type of the repository, for example "default".

getType() - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

getType() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest

getType() - Method in interface org.apache.maven.api.Toolchain

get the type of toolchain.

getUpperBoundary() - Method in interface org.apache.maven.api.VersionRange

Returns the upper boundary of this range, or null if none.

getUrl() - Method in interface org.apache.maven.api.RemoteRepository

getURL() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest

getUserProperties() - Method in interface org.apache.maven.api.Session

Returns immutable user properties to use for interpolation.

getUserSettingsPath() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest

Gets the user settings path.

getUserSettingsSource() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest

Gets the user settings source.

getUserToolchainsPath() - Method in interface org.apache.maven.api.services.ToolchainsBuilderRequest

Gets the user Toolchains path.

getUserToolchainsSource() - Method in interface org.apache.maven.api.services.ToolchainsBuilderRequest

Gets the user Toolchains source.

getVerbose() - Method in interface org.apache.maven.api.services.DependencyCollectorRequest

getVersion() - Method in interface org.apache.maven.api.Artifact

The version of the artifact.

getVersion() - Method in interface org.apache.maven.api.ArtifactCoordinate

The version of the artifact.

getVersion() - Method in interface org.apache.maven.api.Project

Returns the project version.

getVersion() - Method in interface org.apache.maven.api.services.ArtifactCoordinateFactoryRequest

getVersion() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest

getVersion() - Method in interface org.apache.maven.api.services.VersionResolverResult

getVersion() - Method in interface org.apache.maven.api.VersionRange.Boundary

The bounding version.

getVersionRange() - Method in interface org.apache.maven.api.VersionConstraint

Returns the range of this constraint, or null if none.

getVersions() - Method in interface org.apache.maven.api.services.VersionRangeResolverResult

getWriter() - Method in interface org.apache.maven.api.services.xml.XmlWriterRequest

globalSettingsPath(Path) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder

globalSettingsSource(Source) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder

globalToolchainsPath(Path) - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder

globalToolchainsSource(Source) - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder

goal() - Element in annotation interface org.apache.maven.api.plugin.annotations.Execute

Goal to fork.

GROUP - Enum constant in enum class org.apache.maven.api.MetadataStorage

groupId(String) - Method in class org.apache.maven.api.services.ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder

groupId(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder

groupId(String) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

H

hashCode() - Method in class org.apache.maven.api.SessionData.Key

I

id() - Method in enum class org.apache.maven.api.DependencyScope

The id uniquely represents a value for this extensible enum.

id() - Method in interface org.apache.maven.api.ExtensibleEnum

The id uniquely represents a value for this extensible enum.

id() - Method in enum class org.apache.maven.api.JavaPathType

id() - Method in class org.apache.maven.api.JavaPathType.Modular

id() - Method in interface org.apache.maven.api.Packaging

The packaging id.

id() - Method in interface org.apache.maven.api.PathType

Returns the unique name of this path type, including the module to patch if any.

id() - Method in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

id() - Method in interface org.apache.maven.api.Type

Returns the dependency type id.

info(CharSequence) - Method in interface org.apache.maven.api.plugin.Log

Send a message to the user in the info error level.

info(CharSequence, Throwable) - Method in interface org.apache.maven.api.plugin.Log

Send a message (and accompanying exception) to the user in the info error level.
The error's stacktrace will be output when this error level is enabled.

info(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in info style.

info(Throwable) - Method in interface org.apache.maven.api.plugin.Log

Send an exception to the user in the info error level.
The stack trace for this exception will be output when this error level is enabled.

info(Supplier<String>) - Method in interface org.apache.maven.api.plugin.Log

info(Supplier<String>, Throwable) - Method in interface org.apache.maven.api.plugin.Log

INITIALIZE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

inputStream(InputStream) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

install(ArtifactInstallerRequest) - Method in interface org.apache.maven.api.services.ArtifactInstaller

install(Session, Collection<Artifact>) - Method in interface org.apache.maven.api.services.ArtifactInstaller

install(Session, Artifact) - Method in interface org.apache.maven.api.services.ArtifactInstaller

INSTALL - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

installArtifacts(Collection<Artifact>) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactInstaller.class).install(...).

installArtifacts(Artifact...) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactInstaller.class).install(...).

INTEGRATION_TEST - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

is(String) - Method in enum class org.apache.maven.api.DependencyScope

isAddDefaultEntities() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest

isAllowStubModel() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest

isColorEnabled() - Method in interface org.apache.maven.api.services.MessageBuilderFactory

Checks if the underlying output does support styling or not.

isDebugEnabled() - Method in interface org.apache.maven.api.plugin.Log

isErrorEnabled() - Method in interface org.apache.maven.api.plugin.Log

isIncludesDependencies() - Method in interface org.apache.maven.api.Type

Specifies if the artifact already embeds its own dependencies.

isInclusive() - Method in interface org.apache.maven.api.VersionRange.Boundary

Returns true if version is included of the range.

isInfoEnabled() - Method in interface org.apache.maven.api.plugin.Log

isOptional() - Method in interface org.apache.maven.api.Dependency

isOptional() - Method in interface org.apache.maven.api.services.DependencyCoordinateFactoryRequest

isProcessPlugins() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest

isRecursive() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest

isRootProject() - Method in interface org.apache.maven.api.Project

Returns a boolean indicating if the project is a root project, meaning that the Project.getRootDirectory() and Project.getBasedir() points to the same directory, and that either Model.isRoot() is true or that basedir contains a .mvn child directory.

isSnapshot() - Method in interface org.apache.maven.api.Artifact

Determines whether this artifact uses a snapshot version.

isSnapshot(String) - Method in interface org.apache.maven.api.services.VersionParser

Checks whether a given artifact version is considered a SNAPSHOT or not.

isStrict() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest

isTopProject() - Method in interface org.apache.maven.api.Project

Returns a boolean indicating if the project is the top level project for this reactor build.

isTransitive() - Method in enum class org.apache.maven.api.DependencyScope

isVersionSnapshot(String) - Method in interface org.apache.maven.api.Session

Checks whether a given artifact version is considered a SNAPSHOT or not.

isWarnEnabled() - Method in interface org.apache.maven.api.plugin.Log

J

JAR - Static variable in interface org.apache.maven.api.Type

Artifact type name for a JAR file that can be placed either on the class-path or on the module-path.

JAVA_FAMILY - Static variable in interface org.apache.maven.api.Language

JAVA_SOURCE - Static variable in interface org.apache.maven.api.Type

Artifact type name for source code packaged in a JAR file.

JAVADOC - Static variable in interface org.apache.maven.api.Type

Artifact type name for javadoc packaged in a JAR file.

JavaPathType - Enum Class in org.apache.maven.api

The option of a Java command-line tool where to place the paths to some dependencies.

JavaPathType.Modular - Class in org.apache.maven.api

Type of path which is applied to only one specific Java module.

JavaToolchain - Interface in org.apache.maven.api

A specific Toolchain dedicated for Java.

K

key() - Method in interface org.apache.maven.api.Artifact

Returns a unique identifier for this artifact.

key(Class<T>) - Static method in interface org.apache.maven.api.SessionData

Create a key using the given class as an identifier and as the type of the object.

key(Class<T>, Object) - Static method in interface org.apache.maven.api.SessionData

Create a key using the given class and id.

L

language() - Method in interface org.apache.maven.api.Packaging

The language of this packaging.

Language - Interface in org.apache.maven.api

Language.

LanguageRegistry - Interface in org.apache.maven.api.services

leave(Node) - Method in interface org.apache.maven.api.NodeVisitor

Ends the visit to the specified dependency node.

lifecycle() - Element in annotation interface org.apache.maven.api.plugin.annotations.Execute

Lifecycle id of the lifecycle that defines Execute.phase().

LifecyclePhase - Enum Class in org.apache.maven.api.plugin.annotations

Lifecycle phases.

LifecycleProvider - Interface in org.apache.maven.api.plugin

Interface that can be provided by the plugin to wire in custom lifecycles leveraged using the Execute annotation.

Listener - Interface in org.apache.maven.api

A listener for session events.

LocalRepository - Interface in org.apache.maven.api

The local repository is used to cache artifacts downloaded from RemoteRepository and to hold artifacts that have been build locally.

LocalRepositoryManager - Interface in org.apache.maven.api.services

location(String) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

Log - Interface in org.apache.maven.api.plugin

This interface supplies the API for providing feedback to the user from the Mojo, using standard Maven channels.
There should be no big surprises here, although you may notice that the methods accept java.lang.CharSequence rather than java.lang.String.

longMessage - Variable in exception class org.apache.maven.api.plugin.MojoException

lookup(Class<T>) - Method in interface org.apache.maven.api.services.Lookup

Performs a lookup for given typed component.

lookup(Class<T>, String) - Method in interface org.apache.maven.api.services.Lookup

Performs a lookup for given typed component.

lookup(String) - Method in interface org.apache.maven.api.services.ExtensibleEnumRegistry

Lookup - Interface in org.apache.maven.api.services

LookupException - Exception Class in org.apache.maven.api.services

The Exception class throw by the Lookup service.

LookupException(Exception) - Constructor for exception class org.apache.maven.api.services.LookupException

LookupException(String, Exception) - Constructor for exception class org.apache.maven.api.services.LookupException

lookupList(Class<T>) - Method in interface org.apache.maven.api.services.Lookup

Performs a collection lookup for given typed components.

lookupMap(Class<T>) - Method in interface org.apache.maven.api.services.Lookup

Performs a collection lookup for given typed components.

lookupOptional(Class<T>) - Method in interface org.apache.maven.api.services.Lookup

Performs a lookup for optional typed component.

lookupOptional(Class<T>, String) - Method in interface org.apache.maven.api.services.Lookup

Performs a lookup for optional typed component.

M

MAIN - Static variable in interface org.apache.maven.api.ProjectScope

Main scope.

MAIN_COMPILE - Static variable in interface org.apache.maven.api.PathScope

MAIN_RUNTIME - Static variable in interface org.apache.maven.api.PathScope

managedDependencies(List<DependencyCoordinate>) - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

Sets the dependency management to apply to transitive dependencies.

managedDependencies(List<DependencyCoordinate>) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

managedDependency(DependencyCoordinate) - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

Adds the specified managed dependency.

managedDependency(DependencyCoordinate) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

matchesRequirements(Map<String, String>) - Method in interface org.apache.maven.api.Toolchain

Let the toolchain decide if it matches requirements defined in the toolchain plugin configuration.

MAVEN_PLUGIN - Static variable in interface org.apache.maven.api.Type

Artifact type name for a Maven plugin.

MavenException - Exception Class in org.apache.maven.api.services

Base class for all maven exceptions.

MavenException() - Constructor for exception class org.apache.maven.api.services.MavenException

MavenException(String) - Constructor for exception class org.apache.maven.api.services.MavenException

MavenException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.MavenException

MavenException(Throwable) - Constructor for exception class org.apache.maven.api.services.MavenException

MessageBuilder - Interface in org.apache.maven.api.services

Message builder that supports configurable styling.

MessageBuilderFactory - Interface in org.apache.maven.api.services

A factory for MessageBuilder.

MetadataStorage - Enum Class in org.apache.maven.api

Storage location for metadata

modelId(String) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

ModelXmlFactory - Interface in org.apache.maven.api.services.xml

Reads or writes a Model using XML.

MODULAR_JAR - Static variable in interface org.apache.maven.api.Type

Artifact type name for a JAR file to unconditionally place on the module-path.

moduleName() - Method in class org.apache.maven.api.JavaPathType.Modular

Returns the name of the module for which a path is specified

MODULES - Enum constant in enum class org.apache.maven.api.JavaPathType

The path identified by the Java --module-path option.

mojo(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in mojo style.

Mojo - Interface in org.apache.maven.api.plugin

This interface forms the contract required for Mojos to interact with the Maven infrastructure.
It features an execute() method, which triggers the Mojo's build-process behavior, and can throw a MojoException if error conditions occur.

Mojo - Annotation Interface in org.apache.maven.api.plugin.annotations

This annotation will mark your class as a Mojo (ie.

MOJO_FAILED - Enum constant in enum class org.apache.maven.api.EventType

MOJO_SKIPPED - Enum constant in enum class org.apache.maven.api.EventType

MOJO_STARTED - Enum constant in enum class org.apache.maven.api.EventType

MOJO_SUCCEEDED - Enum constant in enum class org.apache.maven.api.EventType

MojoException - Exception Class in org.apache.maven.api.plugin

An exception occurring during the execution of a plugin.

MojoException(Object, String, String) - Constructor for exception class org.apache.maven.api.plugin.MojoException

Construct a new MojoException exception providing the source and a short and long message: these messages are used to improve the message written at the end of Maven build.

MojoException(String) - Constructor for exception class org.apache.maven.api.plugin.MojoException

Construct a new MojoExecutionException exception providing a message.

MojoException(String, Throwable) - Constructor for exception class org.apache.maven.api.plugin.MojoException

Construct a new MojoExecutionException exception wrapping an underlying Throwable and providing a message.

MojoException(Throwable) - Constructor for exception class org.apache.maven.api.plugin.MojoException

Constructs a new MojoExecutionException exception wrapping an underlying Throwable.

MojoExecution - Interface in org.apache.maven.api

A MojoExecution represents a single execution of a Maven Plugin during a given build.

MojoExecutionScoped - Annotation Interface in org.apache.maven.api.di

Indicates that the annotated bean has a lifespan limited to a given mojo execution, which means each mojo execution will result in a different instance being injected.

N

name() - Method in class org.apache.maven.api.JavaPathType.Modular

Returns the name of the tool option for this path, not including the module name.

name() - Method in interface org.apache.maven.api.PathType

Returns the name of this path type.

name() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo

goal name (required).

name() - Element in annotation interface org.apache.maven.api.plugin.annotations.Parameter

name of the bean property used to get/set the field: by default, field name is used.

newline() - Method in interface org.apache.maven.api.services.MessageBuilder

Append newline to the message buffer.

Node - Interface in org.apache.maven.api

Represents a dependency node within a Maven project's dependency collector.

NodeVisitor - Interface in org.apache.maven.api

Defines a hierarchical visitor for collecting dependency node trees.

NONE - Enum constant in enum class org.apache.maven.api.DependencyScope

None.

NONE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

NONE - Static variable in interface org.apache.maven.api.Language

The "none" language.

O

onEvent(Event) - Method in interface org.apache.maven.api.Listener

onlineRequired() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo

does this Mojo need to be online to be executed?

openStream() - Method in interface org.apache.maven.api.services.Source

Creates a new byte stream to the source contents.

option() - Method in class org.apache.maven.api.JavaPathType.Modular

Returns the name of the tool option for this path.

option() - Method in enum class org.apache.maven.api.JavaPathType

Returns the name of the tool option for this path.

option() - Method in interface org.apache.maven.api.PathType

Returns the name of the tool option for this path.

option(Iterable<? extends Path>) - Method in class org.apache.maven.api.JavaPathType.Modular

Returns the option followed by a string representation of the given path elements.

option(Iterable<? extends Path>) - Method in enum class org.apache.maven.api.JavaPathType

Returns the option followed by a string representation of the given path elements.

option(Iterable<? extends Path>) - Method in interface org.apache.maven.api.PathType

Returns the option followed by a string representation of the given path elements.

optional(boolean) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

org.apache.maven.api - package org.apache.maven.api

org.apache.maven.api.di - package org.apache.maven.api.di

org.apache.maven.api.feature - package org.apache.maven.api.feature

org.apache.maven.api.plugin - package org.apache.maven.api.plugin

org.apache.maven.api.plugin.annotations - package org.apache.maven.api.plugin.annotations

org.apache.maven.api.services - package org.apache.maven.api.services

org.apache.maven.api.services.xml - package org.apache.maven.api.services.xml

outputStream(OutputStream) - Method in class org.apache.maven.api.services.xml.XmlWriterRequest.XmlWriterRequestBuilder

P

PACKAGE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

Packaging - Interface in org.apache.maven.api

Interface representing a Maven project packaging.

PackagingRegistry - Interface in org.apache.maven.api.services

Parameter - Annotation Interface in org.apache.maven.api.plugin.annotations

Used to configure your Mojo parameters to be injected by MavenPluginManager.getConfiguredMojo(...).

parseVersion(String) - Method in interface org.apache.maven.api.services.VersionParser

Parses the specified version string, for example "1.0".

parseVersion(String) - Method in interface org.apache.maven.api.Session

Parses the specified version string, for example "1.0".

parseVersionConstraint(String) - Method in interface org.apache.maven.api.services.VersionParser

Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0)".

parseVersionConstraint(String) - Method in interface org.apache.maven.api.Session

Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0)".

parseVersionRange(String) - Method in interface org.apache.maven.api.services.VersionParser

Parses the specified version range specification, for example "[1.0,2.0)".

parseVersionRange(String) - Method in interface org.apache.maven.api.Session

Parses the specified version range specification, for example "[1.0,2.0)".

PATCH_MODULE - Enum constant in enum class org.apache.maven.api.JavaPathType

The path identified by the Java --patch-module option.

patchModule(String) - Static method in enum class org.apache.maven.api.JavaPathType

Creates a path identified by the Java --patch-module option.

path(Path) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder

path(Path) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

path(Path) - Method in class org.apache.maven.api.services.xml.XmlWriterRequest.XmlWriterRequestBuilder

pathScope(PathScope) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

PathScope - Interface in org.apache.maven.api

Path scope.

PathScopeRegistry - Interface in org.apache.maven.api.services

PathType - Interface in org.apache.maven.api

The option of a command-line tool where to place the paths to some dependencies.

pathTypeFilter(Collection<PathType>) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

Specifies the type of paths to include in the result.

pathTypeFilter(Predicate<PathType>) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

Filters the types of paths to include in the result.

phase() - Element in annotation interface org.apache.maven.api.plugin.annotations.Execute

Lifecycle phase to fork.

Plugin - Interface in org.apache.maven.api

Represents a maven plugin runtime

PluginXmlFactory - Interface in org.apache.maven.api.services.xml

Reads and writes a PluginDescriptor object to/from XML.

POM - Static variable in interface org.apache.maven.api.Type

Artifact type name for a POM file.

POST_CLEAN - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

POST_INTEGRATION_TEST - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

POST_SITE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PRE_CLEAN - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PRE_INTEGRATION_TEST - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PRE_SITE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PREPARE_PACKAGE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PROCESS_CLASSES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PROCESS_RESOURCES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PROCESS_SOURCES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PROCESS_TEST_CLASSES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PROCESS_TEST_RESOURCES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PROCESS_TEST_SOURCES - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

PROCESSOR_CLASSES - Enum constant in enum class org.apache.maven.api.JavaPathType

The path identified by the Java --processor-path option.

PROCESSOR_MODULES - Enum constant in enum class org.apache.maven.api.JavaPathType

The path identified by the Java --processor-module-path option.

processPlugins(boolean) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder

project(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in project style.

project(Project) - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

project(Project) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

Project - Interface in org.apache.maven.api

Interface representing a Maven project which can be created using the ProjectBuilder service.

PROJECT_DISCOVERY_STARTED - Enum constant in enum class org.apache.maven.api.EventType

PROJECT_FAILED - Enum constant in enum class org.apache.maven.api.EventType

PROJECT_SKIPPED - Enum constant in enum class org.apache.maven.api.EventType

PROJECT_STARTED - Enum constant in enum class org.apache.maven.api.EventType

PROJECT_SUCCEEDED - Enum constant in enum class org.apache.maven.api.EventType

ProjectBuilder - Interface in org.apache.maven.api.services

ProjectBuilderException - Exception Class in org.apache.maven.api.services

The Exception class throw by the ProjectBuilder service.

ProjectBuilderException(String, Exception) - Constructor for exception class org.apache.maven.api.services.ProjectBuilderException

ProjectBuilderRequest - Interface in org.apache.maven.api.services

Request used to build a Project using the ProjectBuilder service.

ProjectBuilderRequest.ProjectBuilderRequestBuilder - Class in org.apache.maven.api.services

ProjectBuilderResult - Interface in org.apache.maven.api.services

Result of a project build call.

ProjectManager - Interface in org.apache.maven.api.services

Interface to manage the project during its lifecycle.

projectRequired() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo

does your mojo requires a project to be executed?

projectScope() - Method in interface org.apache.maven.api.PathScope

ProjectScope - Interface in org.apache.maven.api

Project scope.

ProjectScopeRegistry - Interface in org.apache.maven.api.services

Manager for ProjectScope.

projectSettingsPath(Path) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder

projectSettingsSource(Source) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder

prompt(String) - Method in interface org.apache.maven.api.services.Prompter

Prompts the user for a string.

prompt(String, String) - Method in interface org.apache.maven.api.services.Prompter

Prompts the user for a string using a default value.

prompt(String, List<String>) - Method in interface org.apache.maven.api.services.Prompter

Prompts the user for a string using a list of possible values.

prompt(String, List<String>, String) - Method in interface org.apache.maven.api.services.Prompter

Prompts the user for a string using a list of possible values and a default reply.

Prompter - Interface in org.apache.maven.api.services

Service used to interact with the end user.

PrompterException - Exception Class in org.apache.maven.api.services

The Exception class throw by the Prompter service.

PrompterException(String, Exception) - Constructor for exception class org.apache.maven.api.services.PrompterException

promptForPassword(String) - Method in interface org.apache.maven.api.services.Prompter

Prompts the user for a password.

property() - Element in annotation interface org.apache.maven.api.plugin.annotations.Parameter

Property to use to retrieve a value.

PROVIDED - Enum constant in enum class org.apache.maven.api.DependencyScope

Provided.

put(Path, URI) - Method in interface org.apache.maven.api.services.Transport

PUTs the source file (must exist as file) to target URI.

putBytes(byte[], URI) - Method in interface org.apache.maven.api.services.Transport

PUTs the source byte array to target URI.

putString(String, URI) - Method in interface org.apache.maven.api.services.Transport

PUTs the source string using UTF8 charset to target URI.

putString(String, Charset, URI) - Method in interface org.apache.maven.api.services.Transport

PUTs the source string to target URI.

R

rawType() - Method in class org.apache.maven.api.JavaPathType.Modular

Returns the type of path without indication about the target module.

read(InputStream) - Method in interface org.apache.maven.api.services.xml.XmlFactory

read(InputStream, boolean) - Method in interface org.apache.maven.api.services.xml.XmlFactory

read(Reader) - Method in interface org.apache.maven.api.services.xml.XmlFactory

read(Reader, boolean) - Method in interface org.apache.maven.api.services.xml.XmlFactory

read(Path) - Method in interface org.apache.maven.api.services.xml.XmlFactory

read(Path, boolean) - Method in interface org.apache.maven.api.services.xml.XmlFactory

read(XmlReaderRequest) - Method in interface org.apache.maven.api.services.xml.XmlFactory

reader(Reader) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

readonly() - Element in annotation interface org.apache.maven.api.plugin.annotations.Parameter

Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).

registerListener(Listener) - Method in interface org.apache.maven.api.Session

Register the given listener which will receive all events.

RemoteRepository - Interface in org.apache.maven.api

A remote repository that can be used to download or upload artifacts.

replace(SessionData.Key<T>, T, T) - Method in interface org.apache.maven.api.SessionData

Associates the specified session data with the given key if the key is currently mapped to the given value.

repository(RemoteRepository) - Method in class org.apache.maven.api.services.ArtifactDeployerRequest.ArtifactDeployerRequestBuilder

Repository - Interface in org.apache.maven.api

A repository holds artifacts.

RepositoryFactory - Interface in org.apache.maven.api.services

Factory service to create LocalRepository or RemoteRepository objects.

require(String) - Method in interface org.apache.maven.api.services.ExtensibleEnumRegistry

require(String) - Method in interface org.apache.maven.api.services.TypeRegistry

Obtain the Type from the specified id.

required() - Element in annotation interface org.apache.maven.api.plugin.annotations.Parameter

is the parameter required?

requireDependencyScope(String) - Method in interface org.apache.maven.api.Session

Obtain the DependencyScope from the specified id.

requireLanguage(String) - Method in interface org.apache.maven.api.Session

Obtain the Language from the specified id.

requirePackaging(String) - Method in interface org.apache.maven.api.Session

Obtain the Packaging from the specified id.

requirePathScope(String) - Method in interface org.apache.maven.api.Session

Obtain the PathScope from the specified id.

requireProjectScope(String) - Method in interface org.apache.maven.api.Session

Obtain the ProjectScope from the specified id.

requireType(String) - Method in interface org.apache.maven.api.Session

Obtain the Type from the specified id.

resetStyle() - Method in interface org.apache.maven.api.services.MessageBuilder

resolve(String) - Method in interface org.apache.maven.api.services.Source

Returns a new source identified by a relative path.

resolve(ArtifactResolverRequest) - Method in interface org.apache.maven.api.services.ArtifactResolver

resolve(DependencyResolverRequest) - Method in interface org.apache.maven.api.services.DependencyResolver

This method collects, flattens and resolves the dependencies.

resolve(VersionRangeResolverRequest) - Method in interface org.apache.maven.api.services.VersionRangeResolver

resolve(VersionResolverRequest) - Method in interface org.apache.maven.api.services.VersionResolver

Resolves an artifact's meta version (if any) to a concrete version.

resolve(Session, Collection<? extends ArtifactCoordinate>) - Method in interface org.apache.maven.api.services.ArtifactResolver

resolve(Session, List<DependencyCoordinate>) - Method in interface org.apache.maven.api.services.DependencyResolver

resolve(Session, List<DependencyCoordinate>, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver

resolve(Session, ArtifactCoordinate) - Method in interface org.apache.maven.api.services.VersionRangeResolver

Expands a version range to a list of matching versions, in ascending order.

resolve(Session, ArtifactCoordinate) - Method in interface org.apache.maven.api.services.VersionResolver

Resolves an artifact's meta version (if any) to a concrete version.

resolve(Session, DependencyCoordinate) - Method in interface org.apache.maven.api.services.DependencyResolver

resolve(Session, DependencyCoordinate, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver

resolve(Session, Project) - Method in interface org.apache.maven.api.services.DependencyResolver

resolve(Session, Project, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver

resolveArtifact(Artifact) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactResolver.class).resolve(...).

resolveArtifact(ArtifactCoordinate) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactResolver.class).resolve(...).

resolveArtifacts(Collection<? extends ArtifactCoordinate>) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactResolver.class).resolve(...).

resolveArtifacts(Artifact...) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactResolver.class).resolve(...).

resolveArtifacts(ArtifactCoordinate...) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactResolver.class).resolve(...).

resolveDependencies(List<DependencyCoordinate>) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().

resolveDependencies(DependencyCoordinate) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().

resolveDependencies(DependencyCoordinate, PathScope, Collection<PathType>) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyResolver.class).resolve(...).getDispatchedPaths().

resolveDependencies(Project, PathScope) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyResolver.class).resolve(...).getPaths().

resolveDependencies(Project, PathScope, Collection<PathType>) - Method in interface org.apache.maven.api.Session

Shortcut for getService(DependencyResolver.class).resolve(...).getDispatchedPaths().

resolveVersion(ArtifactCoordinate) - Method in interface org.apache.maven.api.Session

Resolves an artifact's meta version (if any) to a concrete version.

resolveVersionRange(ArtifactCoordinate) - Method in interface org.apache.maven.api.Session

Expands a version range to a list of matching versions, in ascending order.

retryFailedDeploymentCount(int) - Method in class org.apache.maven.api.services.ArtifactDeployerRequest.ArtifactDeployerRequestBuilder

root(DependencyCoordinate) - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

root(DependencyCoordinate) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

rootArtifact(Artifact) - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

Sets the root artifact for the dependency graph.

rootArtifact(Artifact) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

RUNTIME - Enum constant in enum class org.apache.maven.api.DependencyScope

Runtime and test.

S

scope(String) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

select(String) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService

Returns ChecksumAlgorithmService.ChecksumAlgorithm for given algorithm name, or throws if algorithm not supported.

select(Collection<String>) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService

Returns a collection of ChecksumAlgorithmService.ChecksumAlgorithm in same order as algorithm names are ordered, or throws if any of the algorithm name is not supported.

Service - Interface in org.apache.maven.api

Marker interface for all services provided by the Session.

session(Session) - Method in class org.apache.maven.api.services.ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.ArtifactDeployerRequest.ArtifactDeployerRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.ArtifactInstallerRequest.ArtifactInstallerRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.ArtifactResolverRequest.ArtifactResolverRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.VersionRangeResolverRequest.VersionResolverRequestBuilder

session(Session) - Method in class org.apache.maven.api.services.VersionResolverRequest.VersionResolverRequestBuilder

Session - Interface in org.apache.maven.api

The session to install / deploy / resolve artifacts and dependencies.

SESSION_ENDED - Enum constant in enum class org.apache.maven.api.EventType

SESSION_STARTED - Enum constant in enum class org.apache.maven.api.EventType

SessionData - Interface in org.apache.maven.api

A container for data that is specific to a session.

SessionData.Key<T> - Class in org.apache.maven.api

Key used to query the session data

SessionScoped - Annotation Interface in org.apache.maven.api.di

Indicates that annotated component should be instantiated before session execution starts and discarded after session execution completes.

set(SessionData.Key<T>, T) - Method in interface org.apache.maven.api.SessionData

Associates the specified session data with the given key.

setArtifactPath(Artifact, Path) - Method in interface org.apache.maven.api.Session

Shortcut for getService(ArtifactManager.class).setPath(...).

setLength(int) - Method in interface org.apache.maven.api.services.MessageBuilder

Set the buffer length.

setPath(Artifact, Path) - Method in interface org.apache.maven.api.services.ArtifactManager

Associates the given file path to the artifact.

setProperty(Project, String, String) - Method in interface org.apache.maven.api.services.ProjectManager

Set a given project property.

SettingsBuilder - Interface in org.apache.maven.api.services

Builds the effective settings from a user settings file and/or a global settings file.

SettingsBuilderException - Exception Class in org.apache.maven.api.services

The Exception class throw by the SettingsBuilder.

SettingsBuilderException(String, Exception) - Constructor for exception class org.apache.maven.api.services.SettingsBuilderException

SettingsBuilderRequest - Interface in org.apache.maven.api.services

Collects settings that control the building of effective settings.

SettingsBuilderRequest.SettingsBuilderRequestBuilder - Class in org.apache.maven.api.services

SettingsBuilderRequestBuilder() - Constructor for class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder

SettingsBuilderResult - Interface in org.apache.maven.api.services

SettingsXmlFactory - Interface in org.apache.maven.api.services.xml

Reads and writes a Settings object to/from XML.

showMessage(String) - Method in interface org.apache.maven.api.services.Prompter

Displays a message to the user.

SITE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

SITE_DEPLOY - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

source - Variable in exception class org.apache.maven.api.plugin.MojoException

source(Source) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder

Source - Interface in org.apache.maven.api.services

Provides access to the contents of a source independently of the backing store (e.g.

storeToolchainToBuildContext(Session, Toolchain) - Method in interface org.apache.maven.api.services.ToolchainManager

stream() - Method in interface org.apache.maven.api.Node

Obtain a Stream containing this node and all its descendant.

strict(boolean) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

strong(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in strong style.

style(String) - Method in interface org.apache.maven.api.services.MessageBuilder

style(String, Object) - Method in interface org.apache.maven.api.services.MessageBuilder

success(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in success style.

SuperPomProvider - Interface in org.apache.maven.api.services

Provides the super POM that all models implicitly inherit from.

SuperPomProviderException - Exception Class in org.apache.maven.api.services

Exceptions thrown by the SuperPomProvider service.

SuperPomProviderException() - Constructor for exception class org.apache.maven.api.services.SuperPomProviderException

SuperPomProviderException(String) - Constructor for exception class org.apache.maven.api.services.SuperPomProviderException

SuperPomProviderException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.SuperPomProviderException

SuperPomProviderException(Throwable) - Constructor for exception class org.apache.maven.api.services.SuperPomProviderException

SYSTEM - Enum constant in enum class org.apache.maven.api.DependencyScope

System scope.

T

TAGLETS - Enum constant in enum class org.apache.maven.api.JavaPathType

The path identified by the Javadoc -tagletpath option.

TEST - Enum constant in enum class org.apache.maven.api.DependencyScope

Test compile and test runtime.

TEST - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

TEST - Static variable in interface org.apache.maven.api.ProjectScope

Test scope.

TEST_COMPILE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

TEST_COMPILE - Static variable in interface org.apache.maven.api.PathScope

TEST_JAR - Static variable in interface org.apache.maven.api.Type

Artifact type name for a JAR file containing test classes.

TEST_ONLY - Enum constant in enum class org.apache.maven.api.DependencyScope

Test compile only.

TEST_RUNTIME - Enum constant in enum class org.apache.maven.api.DependencyScope

Test runtime.

TEST_RUNTIME - Static variable in interface org.apache.maven.api.PathScope

toCoordinate() - Method in interface org.apache.maven.api.Artifact

Shortcut for session.createArtifactCoordinate(artifact)

toCoordinate() - Method in interface org.apache.maven.api.Dependency

Creates a DependencyCoordinate based on this Dependency.

Toolchain - Interface in org.apache.maven.api

Toolchain interface.

ToolchainFactory - Interface in org.apache.maven.api.services

ToolchainManager - Interface in org.apache.maven.api.services

Service to manage Toolchains.

ToolchainManagerException - Exception Class in org.apache.maven.api.services

The Exception class throw by the ToolchainManager.

ToolchainManagerException(String, Exception) - Constructor for exception class org.apache.maven.api.services.ToolchainManagerException

ToolchainsBuilder - Interface in org.apache.maven.api.services

Builds the effective toolchains from a user toolchains file and/or a global toolchains file.

ToolchainsBuilderException - Exception Class in org.apache.maven.api.services

The Exception class throw by the ToolchainsBuilder.

ToolchainsBuilderException(String, Exception) - Constructor for exception class org.apache.maven.api.services.ToolchainsBuilderException

ToolchainsBuilderRequest - Interface in org.apache.maven.api.services

ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder - Class in org.apache.maven.api.services

ToolchainsBuilderRequestBuilder() - Constructor for class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder

ToolchainsBuilderResult - Interface in org.apache.maven.api.services

ToolchainsXmlFactory - Interface in org.apache.maven.api.services.xml

Reads and writes a PersistedToolchains object to/from XML.

toString() - Method in class org.apache.maven.api.JavaPathType.Modular

Returns the programmatic name of this path type, including the module to patch.

toString() - Method in enum class org.apache.maven.api.JavaPathType

toString() - Method in interface org.apache.maven.api.PathType

Returns a string representation for this extensible enum describing a path type.

toXmlString(T) - Method in interface org.apache.maven.api.services.xml.XmlFactory

Simply converts the given content to an xml string.

trace(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in trace style.

transform(String, String) - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest.Transformer

Interpolate the value read from the xml document

transformer(XmlReaderRequest.Transformer) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

transport(Session, RemoteRepository) - Method in interface org.apache.maven.api.services.TransportProvider

Provides new Transport instance for given RemoteRepository, if possible.

Transport - Interface in org.apache.maven.api.services

Transport for specified remote repository (using provided remote repository base URI as root).

TransportProvider - Interface in org.apache.maven.api.services

Transporter provider is a service that provides somewhat trivial transport capabilities backed by Maven internals.

TransportProviderException - Exception Class in org.apache.maven.api.services

TransportProviderException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.TransportProviderException

type() - Method in class org.apache.maven.api.SessionData.Key

type(String) - Method in class org.apache.maven.api.services.ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder

type(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder

type(String) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

Type - Interface in org.apache.maven.api

A dependency's Type is uniquely identified by a String, and semantically represents a known kind of dependency.

TypeRegistry - Interface in org.apache.maven.api.services

Access to Type registry.

U

UNDEFINED - Enum constant in enum class org.apache.maven.api.DependencyScope

Undefined.

unregisterListener(Listener) - Method in interface org.apache.maven.api.Session

Unregisters a previously registered listener.

UNRESOLVED - Static variable in interface org.apache.maven.api.PathType

The type for all paths that could not be placed in any of the types requested by a caller.

update(ByteBuffer) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService.ChecksumCalculator

Updates the checksum algorithm inner state with input.

UPGRADE_MODULES - Enum constant in enum class org.apache.maven.api.JavaPathType

The path identified by the Java --upgrade-module-path option.

url(URL) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

userSettingsPath(Path) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder

userSettingsSource(Source) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder

userToolchainsPath(Path) - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder

userToolchainsSource(Source) - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder

V

VALIDATE - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

valueOf(String) - Static method in enum class org.apache.maven.api.DependencyScope

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.apache.maven.api.EventType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.apache.maven.api.JavaPathType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.apache.maven.api.MetadataStorage

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.apache.maven.api.services.BuilderProblem.Severity

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.apache.maven.api.DependencyScope

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.apache.maven.api.EventType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.apache.maven.api.JavaPathType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.apache.maven.api.MetadataStorage

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.apache.maven.api.services.BuilderProblem.Severity

Returns an array containing the constants of this enum class, in the order they are declared.

verbose(boolean) - Method in class org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

Specifies that the collection should be verbose.

verbose(boolean) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder

VERIFY - Enum constant in enum class org.apache.maven.api.plugin.annotations.LifecyclePhase

version(String) - Method in class org.apache.maven.api.services.ArtifactCoordinateFactoryRequest.ArtifactFactoryRequestBuilder

version(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder

version(String) - Method in class org.apache.maven.api.services.DependencyCoordinateFactoryRequest.DependencyCoordinateFactoryRequestBuilder

Version - Interface in org.apache.maven.api

A version usually parsed using the VersionParser service.

VERSION - Enum constant in enum class org.apache.maven.api.MetadataStorage

VersionConstraint - Interface in org.apache.maven.api

Version constraint for dependency.

VersionParser - Interface in org.apache.maven.api.services

Service interface to parse Version and VersionRange.

VersionParserException - Exception Class in org.apache.maven.api.services

The Exception class thrown by VersionParser.

VersionParserException(String, Exception) - Constructor for exception class org.apache.maven.api.services.VersionParserException

VersionRange - Interface in org.apache.maven.api

A range of versions.

VersionRange.Boundary - Interface in org.apache.maven.api

Represents range boundary.

VersionRangeResolver - Interface in org.apache.maven.api.services

Parses and evaluates version ranges encountered in dependency declarations.

VersionRangeResolverException - Exception Class in org.apache.maven.api.services

VersionRangeResolverException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.VersionRangeResolverException

VersionRangeResolverRequest - Interface in org.apache.maven.api.services

VersionRangeResolverRequest.VersionResolverRequestBuilder - Class in org.apache.maven.api.services

VersionRangeResolverResult - Interface in org.apache.maven.api.services

VersionResolver - Interface in org.apache.maven.api.services

Resolves artifact meta/pseudo versions.

VersionResolverException - Exception Class in org.apache.maven.api.services

VersionResolverException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.VersionResolverException

VersionResolverRequest - Interface in org.apache.maven.api.services

VersionResolverRequest.VersionResolverRequestBuilder - Class in org.apache.maven.api.services

VersionResolverRequestBuilder() - Constructor for class org.apache.maven.api.services.VersionRangeResolverRequest.VersionResolverRequestBuilder

VersionResolverRequestBuilder() - Constructor for class org.apache.maven.api.services.VersionResolverRequest.VersionResolverRequestBuilder

VersionResolverResult - Interface in org.apache.maven.api.services

W

warn(CharSequence) - Method in interface org.apache.maven.api.plugin.Log

Send a message to the user in the warn error level.

warn(CharSequence, Throwable) - Method in interface org.apache.maven.api.plugin.Log

Send a message (and accompanying exception) to the user in the warn error level.
The error's stacktrace will be output when this error level is enabled.

warn(Throwable) - Method in interface org.apache.maven.api.plugin.Log

Send an exception to the user in the warn error level.
The stack trace for this exception will be output when this error level is enabled.

warn(Supplier<String>) - Method in interface org.apache.maven.api.plugin.Log

warn(Supplier<String>, Throwable) - Method in interface org.apache.maven.api.plugin.Log

warning(Object) - Method in interface org.apache.maven.api.services.MessageBuilder

Append message content in warning style.

WARNING - Enum constant in enum class org.apache.maven.api.services.BuilderProblem.Severity

withLocalRepository(LocalRepository) - Method in interface org.apache.maven.api.Session

Creates a derived session using the given local repository.

withRemoteRepositories(List<RemoteRepository>) - Method in interface org.apache.maven.api.Session

Creates a derived session using the given remote repositories.

write(XmlWriterRequest<T>) - Method in interface org.apache.maven.api.services.xml.XmlFactory

write(T, OutputStream) - Method in interface org.apache.maven.api.services.xml.XmlFactory

write(T, Writer) - Method in interface org.apache.maven.api.services.xml.XmlFactory

write(T, Path) - Method in interface org.apache.maven.api.services.xml.XmlFactory

writer(Writer) - Method in class org.apache.maven.api.services.xml.XmlWriterRequest.XmlWriterRequestBuilder

X

XmlFactory<T> - Interface in org.apache.maven.api.services.xml

Generic interface to read/write objects to/from XML.

XmlReaderException - Exception Class in org.apache.maven.api.services.xml

An exception thrown during the reading of an xml file.

XmlReaderException(String, Exception) - Constructor for exception class org.apache.maven.api.services.xml.XmlReaderException

XmlReaderRequest - Interface in org.apache.maven.api.services.xml

An XML reader request.

XmlReaderRequest.Transformer - Interface in org.apache.maven.api.services.xml

XmlReaderRequest.XmlReaderRequestBuilder - Class in org.apache.maven.api.services.xml

XmlReaderRequestBuilder() - Constructor for class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder

XmlWriterException - Exception Class in org.apache.maven.api.services.xml

An exception thrown during the writing of an xml file.

XmlWriterException(String, Exception) - Constructor for exception class org.apache.maven.api.services.xml.XmlWriterException

XmlWriterRequest<T> - Interface in org.apache.maven.api.services.xml

An XML writer request.

XmlWriterRequest.XmlWriterRequestBuilder<T> - Class in org.apache.maven.api.services.xml

XmlWriterRequestBuilder() - Constructor for class org.apache.maven.api.services.xml.XmlWriterRequest.XmlWriterRequestBuilder

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