Index
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.
- activeProfileIds(List) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- add(BuilderProblem.Severity, ModelProblem.Version, String) - Method in interface org.apache.maven.api.services.ModelProblemCollector
- add(BuilderProblem.Severity, ModelProblem.Version, String, Exception) - Method in interface org.apache.maven.api.services.ModelProblemCollector
- add(BuilderProblem.Severity, ModelProblem.Version, String, InputLocation) - Method in interface org.apache.maven.api.services.ModelProblemCollector
- add(BuilderProblem.Severity, ModelProblem.Version, String, InputLocation, Exception) - Method in interface org.apache.maven.api.services.ModelProblemCollector
- add(ModelProblem) - Method in interface org.apache.maven.api.services.ModelProblemCollector
- addDefaultEntities(boolean) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder
- addLocationInformation(boolean) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder
- addSourceRoot(Project, ProjectScope, Language, Path) - Method in interface org.apache.maven.api.services.ProjectManager
-
Resolves and adds the given directory as a source with the given scope and language.
- addSourceRoot(Project, SourceRoot) - Method in interface org.apache.maven.api.services.ProjectManager
-
Adds the given source to the given project.
- After - Annotation Interface in org.apache.maven.api.plugin.annotations
-
Specifies that the mojo should be run after the specific phase.
- AFTER - Enum constant in enum class org.apache.maven.api.Lifecycle.Link.Kind
- AFTER - Static variable in interface org.apache.maven.api.Lifecycle
- After.Type - Enum Class in org.apache.maven.api.plugin.annotations
-
Type of pointer.
- Afters - Annotation Interface in org.apache.maven.api.plugin.annotations
-
Container annotation for repeatable
Afterannotations. - AGENT - Enum constant in enum class org.apache.maven.api.JavaPathType
-
The path identified by the Java
-agentpathoption. - aggregate(Session, List, List, boolean) - Method in interface org.apache.maven.api.services.RepositoryFactory
- aggregator() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo
-
if the Mojo uses the Maven project and its subprojects.
- alias() - Element in annotation interface org.apache.maven.api.plugin.annotations.Parameter
-
alias supported to get parameter value.
- aliases() - Method in interface org.apache.maven.api.Lifecycle
-
Collection of aliases for this lifecycle.
- ALL - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- allPhases() - Method in interface org.apache.maven.api.Lifecycle
-
Stream of phases containing all child phases recursively.
- allPhases() - Method in interface org.apache.maven.api.Lifecycle.Phase
-
Returns a stream of all phases, including this phase and all nested phases.
- 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
- Application to Java - Section in org.apache.maven.api.services.DependencyResolverRequest.getTargetVersion()
- arch() - Method in interface org.apache.maven.api.services.OsService
-
Returns the OS architecture as reported by the system property "os.arch".
- Artifact - Interface in org.apache.maven.api
-
A Maven artifact is a file, typically a JAR, that is produced and used by Maven projects.
- artifactCoordinates(ArtifactCoordinates) - Method in class org.apache.maven.api.services.VersionRangeResolverRequest.VersionResolverRequestBuilder
-
Sets the artifact coordinates whose version range should be resolved.
- artifactCoordinates(ArtifactCoordinates) - Method in class org.apache.maven.api.services.VersionResolverRequest.VersionResolverRequestBuilder
- ArtifactCoordinates - Interface in org.apache.maven.api
-
Partial identification of an
Artifactin a Maven repository. - ArtifactCoordinatesFactory - Interface in org.apache.maven.api.services
-
Service used to create
ArtifactCoordinatesobjects. - ArtifactCoordinatesFactoryRequest - Interface in org.apache.maven.api.services
-
A request for creating a
ArtifactCoordinatesobject. - ArtifactCoordinatesFactoryRequest.ArtifactFactoryRequestBuilder - Class in org.apache.maven.api.services
- ArtifactDeployer - Interface in org.apache.maven.api.services
-
Deploys
ProducedArtifacts to aRemoteRepository. - 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
Artifactobjects. - 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.ArtifactCoordinatesFactoryRequest.ArtifactFactoryRequestBuilder
- artifactId(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder
- artifactId(String) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- ArtifactInstaller - Interface in org.apache.maven.api.services
-
Installs
ProducedArtifacts 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.
- ArtifactResolverException - Exception Class in org.apache.maven.api.services
- ArtifactResolverException(String, Exception, ArtifactResolverResult) - 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
-
Represents the result of resolving an artifact.
- ArtifactResolverResult.ResultItem - Interface in org.apache.maven.api.services
-
Represents an individual resolution result for an artifact.
- artifacts(Collection) - Method in class org.apache.maven.api.services.ArtifactDeployerRequest.ArtifactDeployerRequestBuilder
- artifacts(Collection) - Method in class org.apache.maven.api.services.ArtifactInstallerRequest.ArtifactInstallerRequestBuilder
- asString() - Method in interface org.apache.maven.api.Node
-
Returns a detailed string representation of this dependency node.
- AT - Static variable in interface org.apache.maven.api.Lifecycle
- attachArtifact(Project, ProducedArtifact, Path) - Method in interface org.apache.maven.api.services.ProjectManager
-
Attaches a produced artifact to the project at the specified path.
- attachArtifact(Session, Project, String, Path) - Method in interface org.apache.maven.api.services.ProjectManager
-
Attaches an artifact to the project with an explicitly specified type.
- attachArtifact(Session, Project, Path) - Method in interface org.apache.maven.api.services.ProjectManager
-
Attaches an artifact to the project using the given file path.
B
- BASE - Enum constant in enum class org.apache.maven.api.services.ModelProblem.Version
-
Base validation level that applies to all POM versions.
- BatchRequestException - Exception Class in org.apache.maven.api.cache
-
Exception thrown when a batch request operation fails.
- BatchRequestException(String, List) - Constructor for exception class org.apache.maven.api.cache.BatchRequestException
-
Constructs a new BatchRequestException with the specified message and results.
- BEFORE - Enum constant in enum class org.apache.maven.api.Lifecycle.Link.Kind
- BEFORE - Static variable in interface org.apache.maven.api.Lifecycle
- 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.ProtoSession.Builder
- build() - Method in class org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest.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.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- 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.ModelBuilderRequest.ModelBuilderRequestBuilder
- build() - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder
-
Builds a new ProjectBuilderRequest with the current builder settings.
- 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
-
Builds the version range resolver request.
- 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(ProtoSession, Path, Path) - Static method in interface org.apache.maven.api.services.SettingsBuilderRequest
- build(ProtoSession, Path, Path) - Static method in interface org.apache.maven.api.services.ToolchainsBuilderRequest
- build(ProtoSession, Path, Path, Path) - Static method in interface org.apache.maven.api.services.SettingsBuilderRequest
- build(ProtoSession, Source, Source) - Static method in interface org.apache.maven.api.services.SettingsBuilderRequest
- build(ProtoSession, Source, Source) - Static method in interface org.apache.maven.api.services.ToolchainsBuilderRequest
- build(ProtoSession, Source, Source, Source) - Static method in interface org.apache.maven.api.services.SettingsBuilderRequest
- build(ModelBuilderRequest) - Method in interface org.apache.maven.api.services.ModelBuilder.ModelBuilderSession
- build(ModelBuilderRequest, ModelSource) - Static method in interface org.apache.maven.api.services.ModelBuilderRequest
- build(ProjectBuilderRequest) - Method in interface org.apache.maven.api.services.ProjectBuilder
-
Creates a
Projectfrom 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.ArtifactCoordinatesFactoryRequest
- build(Session, String, String, String, String) - Static method in interface org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest
- 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.ArtifactCoordinatesFactoryRequest
- 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.DependencyCoordinatesFactoryRequest
- build(Session, Path) - Static method in interface org.apache.maven.api.services.ModelBuilderRequest
- build(Session, Path) - Method in interface org.apache.maven.api.services.ProjectBuilder
-
Creates a
Projectfrom a POM file. - build(Session, Path) - Static method in interface org.apache.maven.api.services.ProjectBuilderRequest
-
Creates a new ProjectBuilderRequest with the specified session and path.
- 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, Path) - Method in interface org.apache.maven.api.services.SettingsBuilder
-
Builds the effective settings of the specified settings paths.
- build(Session, Collection) - Static method in interface org.apache.maven.api.services.ArtifactResolverRequest
- build(Session, Collection, List) - Static method in interface org.apache.maven.api.services.ArtifactResolverRequest
- build(Session, Collection) - Static method in interface org.apache.maven.api.services.ArtifactInstallerRequest
- build(Session, ArtifactCoordinates) - Static method in interface org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest
- build(Session, ArtifactCoordinates) - Static method in interface org.apache.maven.api.services.DependencyCoordinatesFactoryRequest
- build(Session, ArtifactCoordinates) - Static method in interface org.apache.maven.api.services.VersionRangeResolverRequest
-
Creates a version range resolver request using the session's repositories.
- build(Session, ArtifactCoordinates) - Static method in interface org.apache.maven.api.services.VersionResolverRequest
- build(Session, ArtifactCoordinates, List) - Static method in interface org.apache.maven.api.services.VersionRangeResolverRequest
-
Creates a version range resolver request.
- build(Session, ArtifactCoordinates, List) - Static method in interface org.apache.maven.api.services.VersionResolverRequest
- build(Session, ArtifactCoordinates, List, VersionRangeResolverRequest.Nature) - Static method in interface org.apache.maven.api.services.VersionRangeResolverRequest
-
Creates a version range resolver request.
- build(Session, Dependency) - Static method in interface org.apache.maven.api.services.DependencyCoordinatesFactoryRequest
- build(Session, RemoteRepository, Collection) - Static method in interface org.apache.maven.api.services.ArtifactDeployerRequest
- build(Session, DependencyResolverRequest.RequestType, List) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest
- build(Session, DependencyResolverRequest.RequestType, List, PathScope) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest
- build(Session, DependencyResolverRequest.RequestType, Artifact) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest
- build(Session, DependencyResolverRequest.RequestType, Artifact, PathScope) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest
- build(Session, DependencyResolverRequest.RequestType, DependencyCoordinates) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest
- build(Session, DependencyResolverRequest.RequestType, DependencyCoordinates, PathScope) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest
- build(Session, DependencyResolverRequest.RequestType, Project) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest
- build(Session, DependencyResolverRequest.RequestType, Project, PathScope) - Static method in interface org.apache.maven.api.services.DependencyResolverRequest
- build(Session, ModelSource) - Static method in interface org.apache.maven.api.services.ModelBuilderRequest
- build(Session, Source) - Method in interface org.apache.maven.api.services.ProjectBuilder
-
Creates a
Projectfrom a POM file. - build(Session, Source) - Static method in interface org.apache.maven.api.services.ProjectBuilderRequest
-
Creates a new ProjectBuilderRequest with the specified session and source.
- 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) - Method in interface org.apache.maven.api.services.ToolchainsBuilder
-
Builds the effective toolchains for the specified toolchains sources.
- build(Session, Source, Source, Source) - Method in interface org.apache.maven.api.services.SettingsBuilder
-
Builds the effective settings of the specified settings sources.
- BUILD - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- BUILD_CONSUMER - Enum constant in enum class org.apache.maven.api.services.ModelBuilderRequest.RequestType
-
The request is used specifically to parse the POM used as a basis for creating the consumer POM.
- BUILD_EFFECTIVE - Enum constant in enum class org.apache.maven.api.services.ModelBuilderRequest.RequestType
-
The request is for rebuilding the effective POM in a project on the filesystem.
- BUILD_PROJECT - Enum constant in enum class org.apache.maven.api.services.ModelBuilderRequest.RequestType
-
The request is for building an initial model from a POM file in a project on the filesystem.
- builder() - Static method in interface org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest
- 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.DependencyCoordinatesFactoryRequest
- 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.ModelBuilderRequest
- builder() - Static method in interface org.apache.maven.api.services.ProjectBuilderRequest
-
Creates a new builder for constructing a 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
-
Creates a new builder for version range resolver requests.
- 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.
- builder(ModelBuilderRequest) - Static method in interface org.apache.maven.api.services.ModelBuilderRequest
- 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.
- buildMessage(String, ProblemCollector) - Static method in exception class org.apache.maven.api.services.MavenBuilderException
-
Formats message out of problems: problems are sorted (in natural order of
BuilderProblem.Severity) and then a list is built. - buildRawModel(ModelBuilderRequest) - Method in interface org.apache.maven.api.services.ModelBuilder
- buildSource(Path) - Static method in class org.apache.maven.api.services.Sources
-
Creates a new build source for the specified path.
C
- CacheMetadata - Interface in org.apache.maven.api.cache
-
Interface defining metadata for cache behavior and lifecycle management.
- CacheRetention - Enum Class in org.apache.maven.api.cache
-
Enumeration defining different retention periods for cached data.
- calculate(byte[], Collection) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService
-
Calculates checksums for specified data.
- calculate(InputStream, Collection) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService
-
Calculates checksums for specified stream.
- calculate(ByteBuffer, Collection) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService
-
Calculates checksums for specified data.
- calculate(Path, Collection) - 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
- chain(Collection) - Static method in interface org.apache.maven.api.services.Interpolator
-
Creates a composite function from a collection of functions.
- chain(UnaryOperator...) - Static method in interface org.apache.maven.api.services.Interpolator
- 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
- child(String) - Method in interface org.apache.maven.api.plugin.Log
-
Returns a child logger whose name is derived from this logger's name by appending a dot and the given suffix.
- CHILDREN - Enum constant in enum class org.apache.maven.api.Lifecycle.Pointer.Type
- CHILDREN - Enum constant in enum class org.apache.maven.api.plugin.annotations.After.Type
- CLASSES - Enum constant in enum class org.apache.maven.api.JavaPathType
-
The path identified by the Java
--class-pathoption. - classifier(String) - Method in class org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest.ArtifactFactoryRequestBuilder
- classifier(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder
- classifier(String) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- 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.
- CLASSPATH_PROCESSOR - Static variable in interface org.apache.maven.api.Type
-
Artifact type name for a JAR file to unconditionally place on the annotation processor class path.
- CLEAN - Static variable in interface org.apache.maven.api.Lifecycle
- CLEAN - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- collect(DependencyResolverRequest) - Method in interface org.apache.maven.api.services.DependencyResolver
-
Collects the transitive dependencies and builds a dependency graph.
- collect(Session, Artifact, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver
-
Collects the transitive dependencies of some artifacts and builds a dependency graph for the given path scope.
- collect(Session, DependencyCoordinates, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver
-
Collects the transitive dependencies of some artifacts and builds a dependency graph for the given path scope.
- collect(Session, Project, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver
-
Collects the transitive dependencies of some artifacts and builds a dependency graph for the given path scope.
- COLLECT - Enum constant in enum class org.apache.maven.api.services.DependencyResolverRequest.RequestType
- collectDependencies(Artifact, PathScope) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(DependencyResolver.class).collect(...) - collectDependencies(DependencyCoordinates, PathScope) - Method in interface org.apache.maven.api.Session
-
Collects the transitive dependencies of some artifacts and builds a dependency graph.
- collectDependencies(Project, PathScope) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(DependencyResolver.class).collect(...) - COMPILE - Enum constant in enum class org.apache.maven.api.DependencyScope
-
Compile, runtime and test.
- COMPILE - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- COMPILE_ONLY - Enum constant in enum class org.apache.maven.api.DependencyScope
-
Compile only.
- computeIfAbsent(SessionData.Key, Supplier) - Method in interface org.apache.maven.api.SessionData
-
Retrieve of compute the data associated with the specified key.
- computePhases(Lifecycle) - Method in interface org.apache.maven.api.services.LifecycleRegistry
- configurator() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo
-
TODO: v4: add a SPI for the configurator configurator bean name.
- Constants - Class in org.apache.maven.api
-
Configuration constants.
- CONSUMER_DEPENDENCY - Enum constant in enum class org.apache.maven.api.services.ModelBuilderRequest.RequestType
-
The request is for building a model from a dependency POM file from a downloaded artifact.
- CONSUMER_PARENT - Enum constant in enum class org.apache.maven.api.services.ModelBuilderRequest.RequestType
-
The request is for building a model from a parent POM file from a downloaded artifact.
- consumerPom(Map) - Static method in class org.apache.maven.api.feature.Features
-
Check if the consumer POM feature is active.
- consumerPomFlatten(Map) - Static method in class org.apache.maven.api.feature.Features
-
Check if consumer POM flattening is enabled.
- consumerPomRemoveUnusedManagedDependencies(Map) - Static method in class org.apache.maven.api.feature.Features
-
Check if unused managed dependency removal is enabled during consumer POM flattening.
- consumerPomSanitizeRepositories(Map) - Static method in class org.apache.maven.api.feature.Features
-
Check if consumer POM repository sanitization is enabled: when active, only repositories declared in the project's own POM file are published in the consumer POM, while repositories inherited from parent POMs or injected by active settings.xml profiles are removed.
- 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
- context() - Method in record class org.apache.maven.api.services.RequestTrace
-
Returns the value of the
contextrecord component. - CONTEXT_BOOTSTRAP - Static variable in record class org.apache.maven.api.services.RequestTrace
- CONTEXT_PLUGIN - Static variable in record class org.apache.maven.api.services.RequestTrace
- CONTEXT_PROJECT - Static variable in record class org.apache.maven.api.services.RequestTrace
- Context-sensitive interpretation - Section in org.apache.maven.api.JavaPathType.CLASSES
- Context-sensitive interpretation - Section in org.apache.maven.api.JavaPathType.MODULES
- Context-sensitive interpretation - Section in org.apache.maven.api.JavaPathType.patchModule(String)
- convert(Profile) - Method in interface org.apache.maven.api.services.SettingsBuilder
-
Convert a model profile to a settings profile.
- convert(Profile) - Method in interface org.apache.maven.api.services.SettingsBuilder
-
Convert a settings profile to a model profile.
- coordinates(Collection) - Method in class org.apache.maven.api.services.ArtifactResolverRequest.ArtifactResolverRequestBuilder
- coordinateString(String) - Method in class org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest.ArtifactFactoryRequestBuilder
- coordinateString(String) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- create(int) - Static method in interface org.apache.maven.api.services.ProblemCollector
-
Creates new instance of problem collector with the specified maximum problem count limit.
- create(ProtoSession) - Static method in interface org.apache.maven.api.services.ProblemCollector
-
Creates new instance of problem collector with configuration from the provided session.
- create(ArtifactCoordinatesFactoryRequest) - Method in interface org.apache.maven.api.services.ArtifactCoordinatesFactory
-
Creates artifact coordinates.
- create(ArtifactFactoryRequest) - Method in interface org.apache.maven.api.services.ArtifactFactory
-
Creates an artifact.
- create(DependencyCoordinatesFactoryRequest) - Method in interface org.apache.maven.api.services.DependencyCoordinatesFactory
-
Creates a new
DependencyCoordinatesobject from the request. - create(Session, String) - Method in interface org.apache.maven.api.services.ArtifactCoordinatesFactory
-
Creates coordinates 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.ArtifactCoordinatesFactory
- 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.ArtifactCoordinatesFactory
- 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.ArtifactCoordinatesFactory
- create(Session, ArtifactCoordinates) - Method in interface org.apache.maven.api.services.DependencyCoordinatesFactory
- create(Session, Dependency) - Method in interface org.apache.maven.api.services.DependencyCoordinatesFactory
- create(Session, Dependency) - Method in interface org.apache.maven.api.services.DependencyCoordinatesFactory
- create(Session, Plugin) - Method in interface org.apache.maven.api.services.DependencyCoordinatesFactory
- create(Session, ReportPlugin) - Method in interface org.apache.maven.api.services.DependencyCoordinatesFactory
- 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(...). - createArtifactCoordinates(String) - Method in interface org.apache.maven.api.Session
-
Creates a coordinates out of string that is formatted like:
<groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>. - createArtifactCoordinates(String, String, String, String) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactFactory.class).create(...). - createArtifactCoordinates(String, String, String, String, String, String) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactFactory.class).create(...). - createArtifactCoordinates(Artifact) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactFactory.class).create(...). - createCache() - Method in interface org.apache.maven.api.cache.RequestCacheFactory
-
Creates a new RequestCache instance.
- createDefaultToolchain() - Method in interface org.apache.maven.api.services.ToolchainFactory
-
Creates a default toolchain instance using system defaults.
- createDependencyCoordinates(ArtifactCoordinates) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(DependencyFactory.class).create(...). - createDependencyCoordinates(Dependency) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(DependencyFactory.class).create(...). - createExcludeOnlyMatcher(Path, Collection, boolean) - Method in interface org.apache.maven.api.services.PathMatcherFactory
-
Creates a path matcher that includes all files except those matching the exclude patterns.
- createIncludeOnlyMatcher(Path, Collection) - Method in interface org.apache.maven.api.services.PathMatcherFactory
-
Creates a path matcher that only includes files matching the include patterns.
- 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(...). - createPathMatcher(Path, Collection, Collection) - Method in interface org.apache.maven.api.services.PathMatcherFactory
-
Creates a path matcher for filtering files based on include and exclude patterns, without using default exclusion patterns.
- createPathMatcher(Path, Collection, Collection, boolean) - Method in interface org.apache.maven.api.services.PathMatcherFactory
-
Creates a path matcher for filtering files based on include and exclude patterns.
- createProduced(ArtifactFactoryRequest) - Method in interface org.apache.maven.api.services.ArtifactFactory
-
Creates an artifact.
- createProduced(Session, String, String, String, String) - Method in interface org.apache.maven.api.services.ArtifactFactory
- createProduced(Session, String, String, String, String, String, String) - Method in interface org.apache.maven.api.services.ArtifactFactory
- createProducedArtifact(String, String, String, String) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactFactory.class).createProduced(...). - createProducedArtifact(String, String, String, String, String, String) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactFactory.class).createProduced(...). - 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(...). - createToolchain(ToolchainModel) - Method in interface org.apache.maven.api.services.ToolchainFactory
-
Creates a toolchain instance from the provided model configuration.
D
- data() - Method in record class org.apache.maven.api.services.RequestTrace
-
Returns the value of the
datarecord component. - debug(CharSequence) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a message to the user in the debug error level.
- debug(CharSequence, Throwable) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a message (and accompanying exception) to the user in the debug error level.
- 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
-
Sends an exception to the user in the debug error level.
- debug(Supplier) - Method in interface org.apache.maven.api.plugin.Log
- debug(Supplier, Throwable) - Method in interface org.apache.maven.api.plugin.Log
- DEFAULT - Static variable in interface org.apache.maven.api.Lifecycle
- Default implementation - Section in org.apache.maven.api.SourceRoot.directory()
- 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. - Default values - Section in interface org.apache.maven.api.SourceRoot
- dependencies(List) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
-
Sets the direct dependencies.
- DEPENDENCIES - Enum constant in enum class org.apache.maven.api.Lifecycle.Pointer.Type
- DEPENDENCIES - Enum constant in enum class org.apache.maven.api.plugin.annotations.After.Type
- dependency(DependencyCoordinates) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
-
Adds the specified direct dependency.
- Dependency - Interface in org.apache.maven.api
-
A result of collecting, flattening, and resolving
DependencyCoordinatess. - dependencyCollection() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo
-
Indicates whether dependency collection will be required when executing the Mojo.
- DependencyCoordinates - Interface in org.apache.maven.api
-
ArtifactCoordinatescompleted with information about how the artifact will be used. - DependencyCoordinatesFactory - Interface in org.apache.maven.api.services
- DependencyCoordinatesFactoryRequest - Interface in org.apache.maven.api.services
- DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder - Class in org.apache.maven.api.services
- Dependency management - Section in package org.apache.maven.api
- dependencyResolutionPathScopes() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo
-
Comma separated list of path scopes that will be required for dependency resolution.
- 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
-
A request to collect the transitive dependencies and to build a dependency graph from them.
- DependencyResolverRequest.DependencyResolverRequestBuilder - Class in org.apache.maven.api.services
- DependencyResolverRequest.RequestType - Enum Class in org.apache.maven.api.services
- DependencyResolverResult - Interface in org.apache.maven.api.services
-
The result of a dependency resolution request.
- DependencyScope - Enum Class in org.apache.maven.api
-
Indicates when the dependency will be used.
- dependencyScopes() - Method in interface org.apache.maven.api.PathScope
- deploy(ArtifactDeployerRequest) - Method in interface org.apache.maven.api.services.ArtifactDeployer
- deploy(Session, RemoteRepository, Collection) - Method in interface org.apache.maven.api.services.ArtifactDeployer
- DEPLOY - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- deployArtifact(RemoteRepository, ProducedArtifact...) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactDeployer.class).deploy(...). - deriveDirectoryMatcher(PathMatcher) - Method in interface org.apache.maven.api.services.PathMatcherFactory
-
Returns a filter for directories that may contain paths accepted by the given matcher.
- Design note - Section in org.apache.maven.api.services.DependencyResolverResult.getDispatchedPaths()
- directory() - Method in interface org.apache.maven.api.SourceRoot
-
Returns the root directory where the sources are stored.
- DISABLED - Enum constant in enum class org.apache.maven.api.cache.CacheRetention
-
Caching should be disabled for this data.
- discoverSubprojects(Map) - Static method in class org.apache.maven.api.feature.Features
-
Check if automatic subproject discovery is enabled for POM-packaged projects.
- DOCLET - Enum constant in enum class org.apache.maven.api.JavaPathType
-
The path identified by the Javadoc
-docletoption. - DownloadedArtifact - Interface in org.apache.maven.api
-
An
Artifactthat has been resolved, i.e. - DownloadedDependency - Interface in org.apache.maven.api
-
A
Dependencythat has been resolved, i.e.
E
- EACH - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- elapsed() - Static method in class org.apache.maven.api.MonotonicClock
-
Returns the elapsed time since clock initialization.
- elapsedTime() - Method in class org.apache.maven.api.MonotonicClock
-
Returns the duration elapsed since this clock was initialized.
- empty() - Static method in interface org.apache.maven.api.services.ProblemCollector
-
Creates an "empty" problem collector that doesn't store any problems.
- enabled() - Method in interface org.apache.maven.api.SourceRoot
-
Returns whether the directory described by this source element should be included in the build.
- enter(Node) - Method in interface org.apache.maven.api.NodeVisitor
-
Starts the visit to the specified dependency node.
- equals(Object) - Method in record class org.apache.maven.api.cache.RequestResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class org.apache.maven.api.JavaPathType.Modular
-
Returns whether the given object represents the same type of path as this object.
- equals(Object) - Method in interface org.apache.maven.api.services.Request
-
Returns
trueif the specified object is equal to this request. - equals(Object) - Method in record class org.apache.maven.api.services.RequestTrace
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class org.apache.maven.api.SessionData.Key
- error() - Method in record class org.apache.maven.api.cache.RequestResult
-
Returns the value of the
errorrecord component. - error(CharSequence) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a message to the user in the error error level.
- error(CharSequence, Throwable) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a message (and accompanying exception) to the user in the error error level.
- 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
-
Sends an exception to the user in the error error level.
- error(Supplier) - Method in interface org.apache.maven.api.plugin.Log
- error(Supplier, 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.
- Examples - Section in org.apache.maven.api.PathType.option(Iterable)
- excludes() - Method in interface org.apache.maven.api.SourceRoot
-
Returns the list of patterns for the files to exclude.
- exclusion(Exclusion) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- Exclusion - Interface in org.apache.maven.api
-
A dependency exclusion.
- exclusions(Collection) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- execute() - Method in interface org.apache.maven.api.plugin.Mojo
-
Executes the behavior defined by this
Mojo. - 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
-
Registry for extensible enum values that allows looking up enum instances by their identifiers.
- extension(String) - Method in class org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest.ArtifactFactoryRequestBuilder
- extension(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder
- extension(String) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
F
- failure(Object) - Method in interface org.apache.maven.api.services.MessageBuilder
-
Append message content in failure style.
- family() - Method in interface org.apache.maven.api.services.OsService
-
Returns the OS family name based on OS detection rules.
- FATAL - Enum constant in enum class org.apache.maven.api.services.BuilderProblem.Severity
- FATJAR - Static variable in interface org.apache.maven.api.Type
-
Artifact type name for a fat-JAR file that can be only on the class path.
- Features - Class in org.apache.maven.api.feature
-
Centralized class for Maven Core feature information.
- filter(Predicate) - 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(DependencyResolverRequest) - Method in interface org.apache.maven.api.services.DependencyResolver
- flatten(Session, Node, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver
-
Flattens a list of nodes.
- flatten(Session, Project, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver
- FLATTEN - Enum constant in enum class org.apache.maven.api.services.DependencyResolverRequest.RequestType
- 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
-
Returns the dependency scope for the given identifier, or
nullif none. - 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.
- fromPath(Path) - Static method in class org.apache.maven.api.services.Sources
-
Creates a new source for the specified path.
- fromXmlString(String) - Method in interface org.apache.maven.api.services.xml.XmlFactory
-
Simply parse the given xml string.
G
- get() - Static method in class org.apache.maven.api.MonotonicClock
-
Returns the singleton instance of MonotonicClock.
- 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) - Method in interface org.apache.maven.api.SessionData
-
Gets the session data associated with the specified key.
- getActiveExternalProfiles() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the external profiles that were active during model building.
- getActivePomProfiles() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the profiles that were active during model building.
- getActivePomProfiles(String) - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the profiles that were active during model building for a specific model in the hierarchy.
- getActivePomProfilesByModel() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets a map of all active POM profiles organized by model ID.
- getActiveProfileIds() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
-
List of profile ids that have been explicitly activated by the user.
- getAllArtifacts(Project) - Method in interface org.apache.maven.api.services.ProjectManager
-
Returns project's all artifacts as an immutable ordered collection.
- getArtifact() - Method in interface org.apache.maven.api.Node
- getArtifact() - Method in interface org.apache.maven.api.Plugin
- getArtifact() - Method in interface org.apache.maven.api.services.ArtifactResolverResult.ResultItem
-
Returns the resolved artifact.
- getArtifactCoordinates() - Method in interface org.apache.maven.api.services.VersionRangeResolverRequest
-
Gets the artifact coordinates whose version range should be resolved.
- getArtifactCoordinates() - Method in interface org.apache.maven.api.services.VersionResolverRequest
- getArtifactId() - Method in interface org.apache.maven.api.Artifact
-
Returns the identifier of the artifact.
- getArtifactId() - Method in interface org.apache.maven.api.ArtifactCoordinates
-
Returns the identifier 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.ArtifactCoordinatesFactoryRequest
- 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
-
Returns a collection of resolved artifacts.
- getAttachedArtifacts(Project) - Method in interface org.apache.maven.api.services.ProjectManager
-
Returns an immutable collection of attached artifacts for the 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
-
Returns the version or meta-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.
- getCacheRetention() - Method in interface org.apache.maven.api.cache.CacheMetadata
-
Returns the cache retention that should be applied to the associated data.
- getCalculator() - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService.ChecksumAlgorithm
-
Each invocation of this method returns a new instance of calculator, never
nullvalue. - getCharacterOffset() - Method in interface org.apache.maven.api.services.xml.Location
-
Return the byte or character offset into the input source this location is pointing to.
- 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.
- getChildren() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the children of this result.
- getClassifier() - Method in interface org.apache.maven.api.Artifact
-
Returns the classifier of the artifact.
- getClassifier() - Method in interface org.apache.maven.api.ArtifactCoordinates
-
Returns the classifier of the artifact.
- getClassifier() - Method in interface org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest
- 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.
- getColumnNumber() - Method in interface org.apache.maven.api.services.xml.Location
-
Return the column number where the current event ends, returns -1 if none is available.
- 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
- getCoordinates() - Method in interface org.apache.maven.api.services.ArtifactResolverResult.ResultItem
-
Returns the coordinates of the resolved artifact.
- getCoordinatesString() - Method in interface org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest
- getData() - Method in interface org.apache.maven.api.Session
-
Retrieves the session data associated with this session.
- getDeclaredActiveProfiles() - Method in interface org.apache.maven.api.Project
-
Returns all active profiles for the current project build.
- getDeclaredProfiles() - Method in interface org.apache.maven.api.Project
-
Returns all profiles defined in this project.
- getDegreeOfConcurrency() - Method in interface org.apache.maven.api.Session
-
Returns the degree of concurrency for the build.
- 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.DependencyResolverRequest
- getDependencies() - Method in interface org.apache.maven.api.services.DependencyResolverResult
-
Returns all dependencies associated with their paths.
- 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 and their assignments to different paths.
- getEffectiveActiveProfiles() - Method in interface org.apache.maven.api.Project
-
Returns all active profiles for this project and all of its parent projects.
- getEffectiveModel() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the assembled model with inheritance, interpolation and profile injection.
- getEffectiveProfiles() - Method in interface org.apache.maven.api.Project
-
Returns all profiles defined in this project and all of its parent projects.
- getEffectiveProperties() - Method in interface org.apache.maven.api.ProtoSession
-
Returns the properly overlaid map of properties: system + user.
- getEffectiveProperties() - Method in interface org.apache.maven.api.Session
-
Default implementation at
ProtoSessionlevel, as the notion of project does not exist there. - 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.
- getEnabledSourceRoots(Project, ProjectScope, Language) - Method in interface org.apache.maven.api.services.ProjectManager
-
Returns all enabled sources that provide files in the given language for the given scope.
- 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.ArtifactResolverResult.ResultItem
-
Returns a mapping of repositories to the exceptions encountered while resolving the artifact.
- getExceptions() - Method in interface org.apache.maven.api.services.DependencyResolverResult
-
Gets the exceptions that occurred while building the dependency graph.
- getExceptions() - Method in interface org.apache.maven.api.services.VersionRangeResolverResult
-
Gets the exceptions that occurred while resolving the version range.
- getExceptions() - Method in interface org.apache.maven.api.services.VersionResolverResult
- getExclusions() - Method in interface org.apache.maven.api.DependencyCoordinates
-
Returns transitive dependencies to exclude.
- getExclusions() - Method in interface org.apache.maven.api.services.DependencyCoordinatesFactoryRequest
- getExecutionId() - Method in interface org.apache.maven.api.MojoExecution
- getExecutionProject(Project) - Method in interface org.apache.maven.api.services.ProjectManager
-
Returns the original project being built when the input project is a forked project.
- getExtension() - Method in interface org.apache.maven.api.Artifact
-
Returns the file extension of the artifact.
- getExtension() - Method in interface org.apache.maven.api.ArtifactCoordinates
-
Returns the file extension of the artifact.
- getExtension() - Method in interface org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest
- 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. - getFileModel() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the file model.
- getGoal() - Method in interface org.apache.maven.api.MojoExecution
- getGroupId() - Method in interface org.apache.maven.api.Artifact
-
Returns the group identifier of the artifact.
- getGroupId() - Method in interface org.apache.maven.api.ArtifactCoordinates
-
Returns the group identifier 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.ArtifactCoordinatesFactoryRequest
- getGroupId() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest
- getHighestVersion() - Method in interface org.apache.maven.api.services.VersionRangeResolverResult
-
Gets the highest version matching the requested range.
- getId() - Method in interface org.apache.maven.api.ArtifactCoordinates
-
Returns a unique string representation 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.
- getInactiveProfileIds() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
-
List of profile ids that have been explicitly deactivated by the user.
- getInputLocationFormatter() - Method in interface org.apache.maven.api.services.xml.XmlWriterRequest
- getInputStream() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest
- getInstallationSettingsSource() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest
-
Gets the installation settings source.
- getInstallationToolchainsSource() - Method in interface org.apache.maven.api.services.ToolchainsBuilderRequest
-
Gets the installation Toolchains source.
- getInterpolationSource() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest
-
The optional interpolation source used for interpolation.
- getJavaHome() - Method in interface org.apache.maven.api.JavaToolchain
- getJavaVersion() - 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.
- getLifecycleBindingsInjector() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
- 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.
- getLineNumber() - Method in interface org.apache.maven.api.services.xml.Location
-
Return the line number where the current event ends, returns -1 if none is available.
- getListeners() - Method in interface org.apache.maven.api.Session
-
Returns the list of registered listeners.
- getLocalRepository() - Method in interface org.apache.maven.api.Session
-
Retrieves the local repository associated with this 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
-
Returns a human-readable description of where this source came from, used primarily for error messages and debugging.
- getLocation() - Method in exception class org.apache.maven.api.services.xml.XmlReaderException
- getLocation() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest
- getLocation() - Method in exception class org.apache.maven.api.services.xml.XmlWriterException
- 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
nullif none. - getLowestVersion() - Method in interface org.apache.maven.api.services.VersionRangeResolverResult
-
Gets the lowest version matching the requested range.
- getMainArtifact() - Method in interface org.apache.maven.api.Project
-
Returns the project main artifact.
- 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.DependencyResolverRequest
- 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.
- getModel() - Method in interface org.apache.maven.api.Toolchain
-
Gets the underlying toolchain model.
- getModelId() - Method in exception class org.apache.maven.api.services.ModelBuilderException
-
Gets the identifier of the POM whose effective model could not be built.
- getModelId() - Method in interface org.apache.maven.api.services.ModelProblem
-
Gets the identifier of the model from which the problem originated.
- getModelId() - Method in interface org.apache.maven.api.services.ModelSource
-
Returns the model identifier in the format
groupId:artifactId:versionif this source represents a resolved artifact with known coordinates. - getModelId() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest
- getModuleDescriptor(Path) - Method in interface org.apache.maven.api.services.DependencyResolverResult
-
Returns the Java module descriptor of the dependency at the given path.
- getModuleName(Path) - Method in interface org.apache.maven.api.services.DependencyResolverResult
-
Returns the Java module name of the dependency at the given path.
- 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
nullvalue. - getNature() - Method in interface org.apache.maven.api.services.VersionRangeResolverRequest
-
Gets the nature of repositories to query when resolving the version range.
- 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.DependencyCoordinates
-
Returns whether the dependency is optional, mandatory, or of unspecified obligation.
- getOutputDirectory(ProjectScope) - Method in interface org.apache.maven.api.Project
-
Returns the absolute path to the directory where files generated by the build are placed.
- 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.
- getParentModel() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the effective model of the parent POM.
- getPath() - Method in interface org.apache.maven.api.DownloadedArtifact
-
Returns the actual file that has been downloaded in the file system.
- getPath() - Method in interface org.apache.maven.api.LocalRepository
- getPath() - Method in interface org.apache.maven.api.services.ArtifactResolverResult.ResultItem
-
Returns the file system path to the resolved artifact.
- getPath() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest
-
Gets the path to the project to build.
- getPath() - Method in interface org.apache.maven.api.services.Source
-
Provides access to the file backing this source, if available.
- 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(Artifact) - Method in interface org.apache.maven.api.services.ArtifactResolverResult
-
Retrieves the file system path associated with a specific artifact.
- 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 of which tool option those paths should be placed on.
- 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 returnsnullas if context not present, creates it. - getPomArtifact() - Method in interface org.apache.maven.api.Project
-
Returns the project POM artifact.
- 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.
- getProblemCollector() - Method in exception class org.apache.maven.api.services.MavenBuilderException
-
Returns the problem collector associated with this exception.
- getProblemCollector() - Method in exception class org.apache.maven.api.services.ModelBuilderException
-
Gets the problems that caused this exception.
- getProblemCollector() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the problem collector that collected problems encountered during the project building.
- getProblemCollector() - Method in interface org.apache.maven.api.services.ModelProblemCollector
- 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.
- getProfiles() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
-
Defines external profiles that may be activated for the given model.
- getProject() - Method in interface org.apache.maven.api.Event
-
Gets the current project (if any).
- getProject() - Method in interface org.apache.maven.api.services.DependencyResolverRequest
- 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
-
Retrieves a list of projects associated with the session.
- 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
- getPublicId() - Method in interface org.apache.maven.api.services.xml.Location
-
Returns the public ID of the XML
- getRawModel() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the file model + build pom transformation, without inheritance nor interpolation.
- 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
nullif none. - getRemotePluginRepositories(Project) - Method in interface org.apache.maven.api.services.ProjectManager
-
Returns an immutable list of project plugin remote 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
-
Retrieves a list of remote repositories associated with this session.
- getRepositories() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest
-
Gets the list of remote repositories to use for resolving dependencies during project building.
- getRepositories() - Method in interface org.apache.maven.api.services.RepositoryAwareRequest
-
Returns the list of remote repositories to be used for this request.
- getRepository() - Method in interface org.apache.maven.api.Node
-
Returns the remote repository from which this artifact was downloaded, if known.
- getRepository() - Method in interface org.apache.maven.api.services.ArtifactDeployerRequest
- getRepository() - Method in interface org.apache.maven.api.services.ArtifactResolverResult.ResultItem
-
Returns the repository from which the artifact was resolved.
- getRepository() - Method in interface org.apache.maven.api.services.VersionResolverResult
- getRepository(Version) - Method in interface org.apache.maven.api.services.VersionRangeResolverResult
-
Gets the repository from which the specified version was resolved.
- getRepositoryMerging() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
- getRequest() - Method in interface org.apache.maven.api.services.Result
-
Returns the request that produced this result.
- getRequestType() - Method in interface org.apache.maven.api.services.DependencyResolverRequest
- getRequestType() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
- getResult() - Method in exception class org.apache.maven.api.services.ArtifactResolverException
- getResult() - Method in exception class org.apache.maven.api.services.ModelBuilderException
-
Gets the interim result of the model building up to the point where it failed.
- getResult(ArtifactCoordinates) - Method in interface org.apache.maven.api.services.ArtifactResolverResult
-
Retrieves the resolution result for a specific set of artifact coordinates.
- getResults() - Method in exception class org.apache.maven.api.cache.BatchRequestException
-
Returns the list of results from all requests that were part of the batch operation.
- getResults() - Method in interface org.apache.maven.api.services.ArtifactResolverResult
-
Returns a mapping of artifact coordinates to their corresponding resolution results.
- getRetryFailedDeploymentCount() - Method in interface org.apache.maven.api.services.ArtifactDeployerRequest
- getRoot() - Method in interface org.apache.maven.api.services.DependencyResolverRequest
- getRoot() - Method in interface org.apache.maven.api.services.DependencyResolverResult
-
Gets the root node of the dependency graph.
- getRootArtifact() - Method in interface org.apache.maven.api.services.DependencyResolverRequest
- getRootDirectory() - Method in interface org.apache.maven.api.Project
-
Gets the root directory of the project, which is the parent directory containing the
.mvndirectory or flagged withroot="true". - getRootDirectory() - Method in interface org.apache.maven.api.ProtoSession
-
Gets the root directory of the session, which is the root directory for the top directory project.
- getRootDirectory() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest
- getRootModel() - Method in interface org.apache.maven.api.services.ModelProblemCollector
- getScope() - Method in interface org.apache.maven.api.Dependency
-
Returns the time at which the dependency will be used.
- getScope() - Method in interface org.apache.maven.api.DependencyCoordinates
-
Returns the time at which the dependency will be used.
- getScope() - Method in interface org.apache.maven.api.services.DependencyCoordinatesFactoryRequest
- getService(Class) - 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.Request
-
Returns the session associated with this request.
- getSettings() - Method in interface org.apache.maven.api.Session
-
Retrieves the settings for the current 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.ModelBuilderRequest
- getSource() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Gets the source from which the model was read.
- getSource() - Method in interface org.apache.maven.api.services.ModelProblemCollector
- getSource() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest
-
Gets the source of the project to build.
- getSourceRoots(Project) - Method in interface org.apache.maven.api.services.ProjectManager
-
Returns all source root directories.
- getStartTime() - Method in interface org.apache.maven.api.ProtoSession
-
Returns the start time of the 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.
- getSystemId() - Method in interface org.apache.maven.api.services.xml.Location
-
Returns the system ID of the XML
- getSystemProperties() - Method in interface org.apache.maven.api.ProtoSession
-
Returns immutable system properties to use for interpolation.
- getSystemProperties() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
-
Provides a map of system properties.
- getTargetVersion() - Method in interface org.apache.maven.api.services.DependencyResolverRequest
-
Returns the version of the platform where the code will be executed.
- getTerminalWidth() - Method in interface org.apache.maven.api.services.MessageBuilderFactory
-
Returns the terminal width or
-1if not supported. - getToolchainFromBuildContext(Session, String) - Method in interface org.apache.maven.api.services.ToolchainManager
-
Retrieves the currently active toolchain from the build context.
- getToolchains() - Method in interface org.apache.maven.api.Session
-
Retrieves toolchain models that have been explicitly configured.
- getToolchains(Session, String) - Method in interface org.apache.maven.api.services.ToolchainManager
-
Retrieves all toolchains of the specified type without additional requirements.
- getToolchains(Session, String, Map) - Method in interface org.apache.maven.api.services.ToolchainManager
-
Retrieves toolchains matching the specified type and requirements.
- getTopDirectory() - Method in interface org.apache.maven.api.ProtoSession
-
Gets the directory of the topmost project being built, usually the current directory or the directory pointed at by the
-f/--filecommand line argument. - getTrace() - Method in interface org.apache.maven.api.services.Request
-
Returns the trace information associated with this request, if any.
- getTransformer() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest
- getType() - Method in interface org.apache.maven.api.Dependency
-
Returns the type of the dependency.
- getType() - Method in interface org.apache.maven.api.DependencyCoordinates
-
Returns the type of the dependency.
- getType() - Method in interface org.apache.maven.api.Event
-
Gets the type of the event.
- 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.ArtifactCoordinatesFactoryRequest
- getType() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest
- getType() - Method in interface org.apache.maven.api.Toolchain
-
Gets the type of toolchain.
- getType() - Method in interface org.apache.maven.api.WorkspaceRepository
-
Returns the type of the repository, i.e. "workspace".
- getUpperBoundary() - Method in interface org.apache.maven.api.VersionRange
-
Returns the upper boundary of this range, or
nullif 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.ProtoSession
-
Returns immutable user properties to use for interpolation.
- getUserProperties() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
-
Provides a map of user properties.
- getUserSettingsSource() - Method in interface org.apache.maven.api.services.SettingsBuilderRequest
-
Gets the user settings source.
- getUserToolchainsSource() - Method in interface org.apache.maven.api.services.ToolchainsBuilderRequest
-
Gets the user Toolchains source.
- getVerbose() - Method in interface org.apache.maven.api.services.DependencyResolverRequest
- getVersion() - Method in interface org.apache.maven.api.Artifact
-
Returns 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.ArtifactCoordinatesFactoryRequest
- getVersion() - Method in interface org.apache.maven.api.services.ArtifactFactoryRequest
- getVersion() - Method in interface org.apache.maven.api.services.ModelProblem
-
Gets the applicable maven version/validation level of this problem
- getVersion() - Method in interface org.apache.maven.api.services.VersionResolverResult
- getVersion() - Method in interface org.apache.maven.api.VersionRange.Boundary
-
The bounding version.
- getVersionConstraint() - Method in interface org.apache.maven.api.ArtifactCoordinates
-
Returns the specific version, range of versions or meta-version of the artifact.
- getVersionRange() - Method in interface org.apache.maven.api.VersionConstraint
-
Returns the range of this constraint, or
nullif none. - getVersions() - Method in interface org.apache.maven.api.services.VersionRangeResolverResult
-
Gets the versions (in ascending order) that matched the requested range.
- getWriter() - Method in interface org.apache.maven.api.services.xml.XmlWriterRequest
- getZone() - Method in class org.apache.maven.api.MonotonicClock
-
Returns the zone ID of this clock.
- goal() - Element in annotation interface org.apache.maven.api.plugin.annotations.Execute
-
Goal to fork.
- groupId(String) - Method in class org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest.ArtifactFactoryRequestBuilder
- groupId(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder
- groupId(String) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
H
- hasErrorProblems() - Method in interface org.apache.maven.api.services.ProblemCollector
-
Returns
trueif there is at least one problem collected with severity equal or more severe thanBuilderProblem.Severity.ERROR. - hasErrors() - Method in interface org.apache.maven.api.services.ModelProblemCollector
- hasFatalErrors() - Method in interface org.apache.maven.api.services.ModelProblemCollector
- hasFatalProblems() - Method in interface org.apache.maven.api.services.ProblemCollector
-
Returns
trueif there is at least one problem collected with severity equal or more severe thanBuilderProblem.Severity.FATAL. - hashCode() - Method in record class org.apache.maven.api.cache.RequestResult
-
Returns a hash code value for this object.
- hashCode() - Method in class org.apache.maven.api.JavaPathType.Modular
-
Returns a hash code value based on the raw type and module name.
- hashCode() - Method in interface org.apache.maven.api.services.Request
-
Returns a hashcode value for this request, based on all significant fields.
- hashCode() - Method in record class org.apache.maven.api.services.RequestTrace
-
Returns a hash code value for this object.
- hashCode() - Method in class org.apache.maven.api.SessionData.Key
- hasProblemsFor(BuilderProblem.Severity) - Method in interface org.apache.maven.api.services.ProblemCollector
-
Returns
trueif there is at least one problem collected with severity equal or more severe than passed in severity. - hasWarningProblems() - Method in interface org.apache.maven.api.services.ProblemCollector
-
Returns
trueif there is at least one problem collected with severity equal or more severe thanBuilderProblem.Severity.WARNING.
I
- id() - Method in enum class org.apache.maven.api.DependencyScope
-
The
iduniquely represents a value for this extensible enum. - id() - Method in interface org.apache.maven.api.ExtensibleEnum
-
The
iduniquely represents a value for this extensible enum. - id() - Method in enum class org.apache.maven.api.JavaPathType
-
Returns the unique name of this path type.
- id() - Method in class org.apache.maven.api.JavaPathType.Modular
-
Returns the name of the tool option for this path, including the module name.
- id() - Method in interface org.apache.maven.api.Lifecycle
-
Name or identifier of this lifecycle.
- 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 interface org.apache.maven.api.Type
-
Returns the dependency type id.
- inactiveProfileIds(List) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- includes() - Method in interface org.apache.maven.api.SourceRoot
-
Returns the list of patterns for the files to include.
- includesAll() - Method in interface org.apache.maven.api.services.PathMatcherFactory
-
Returns the path matcher that unconditionally returns
truefor all files. - info(CharSequence) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a message to the user in the info error level.
- info(CharSequence, Throwable) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a message (and accompanying exception) to the user in the info error level.
- 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
-
Sends an exception to the user in the info error level.
- info(Supplier) - Method in interface org.apache.maven.api.plugin.Log
- info(Supplier, Throwable) - Method in interface org.apache.maven.api.plugin.Log
- INITIALIZE - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- inputLocationFormatter(Function) - Method in class org.apache.maven.api.services.xml.XmlWriterRequest.XmlWriterRequestBuilder
- 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) - Method in interface org.apache.maven.api.services.ArtifactInstaller
- install(Session, ProducedArtifact) - Method in interface org.apache.maven.api.services.ArtifactInstaller
- INSTALL - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- installArtifacts(Collection) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactInstaller.class).install(...). - installArtifacts(ProducedArtifact...) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactInstaller.class).install(...). - installationSettingsSource(Source) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder
- installationToolchainsSource(Source) - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder
- instant() - Method in class org.apache.maven.api.MonotonicClock
-
Returns a monotonically increasing instant.
- INTEGRATION_TEST - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- interpolate(String, UnaryOperator) - Method in interface org.apache.maven.api.services.Interpolator
-
Interpolates a single string value using the provided callback function.
- interpolate(String, UnaryOperator, boolean) - Method in interface org.apache.maven.api.services.Interpolator
-
Interpolates a single string value using the provided callback function.
- interpolate(String, UnaryOperator, BinaryOperator, boolean) - Method in interface org.apache.maven.api.services.Interpolator
-
Interpolates a single string value using the provided callback function.
- interpolate(Map, UnaryOperator) - Method in interface org.apache.maven.api.services.Interpolator
-
Interpolates the values in the given map using the provided callback function.
- interpolate(Map, UnaryOperator, boolean) - Method in interface org.apache.maven.api.services.Interpolator
-
Interpolates the values in the given map using the provided callback function.
- interpolate(Map, UnaryOperator, BinaryOperator, boolean) - Method in interface org.apache.maven.api.services.Interpolator
-
Interpolates the values in the given map using the provided callback function.
- interpolationSource(UnaryOperator) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder
- Interpolator - Interface in org.apache.maven.api.services
-
The Interpolator service provides methods for variable substitution in strings and maps.
- InterpolatorException - Exception Class in org.apache.maven.api.services
-
Exception thrown by
Interpolatorimplementations when an error occurs during interpolation. - InterpolatorException() - Constructor for exception class org.apache.maven.api.services.InterpolatorException
-
Constructs a new InterpolatorException with
nullas its detail message. - InterpolatorException(String) - Constructor for exception class org.apache.maven.api.services.InterpolatorException
-
Constructs a new InterpolatorException with the specified detail message.
- InterpolatorException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.InterpolatorException
-
Constructs a new InterpolatorException with the specified detail message and cause.
- is(String) - Method in enum class org.apache.maven.api.DependencyScope
- isAddDefaultEntities() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest
- isAddLocationInformation() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest
-
Indicates whether location information (line/column tracking) should be recorded during parsing.
- isAllowStubModel() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest
-
Determines whether a stub model should be allowed when the POM is missing or unreadable.
- 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
-
Returns true if the debug error level is enabled.
- isErrorEnabled() - Method in interface org.apache.maven.api.plugin.Log
-
Returns true if the error error level is enabled.
- isIncludesAll(PathMatcher) - Method in interface org.apache.maven.api.services.PathMatcherFactory
-
Returns whether the given matcher includes all files.
- 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
trueif version is included of the range. - isInfoEnabled() - Method in interface org.apache.maven.api.plugin.Log
-
Returns true if the info error level is enabled.
- isLocationTracking() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
- isMissing() - Method in interface org.apache.maven.api.services.ArtifactResolverResult.ResultItem
-
Indicates whether the requested artifact is not present in any of the specified repositories.
- isOptional() - Method in interface org.apache.maven.api.Dependency
-
Returns whether the dependency is optional or mandatory.
- isOptional() - Method in interface org.apache.maven.api.services.DependencyCoordinatesFactoryRequest
- isProcessPlugins() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest
-
Determines whether plugins should be processed during project building.
- isRecursive() - Method in interface org.apache.maven.api.services.ModelBuilderRequest
- isRecursive() - Method in interface org.apache.maven.api.services.ProjectBuilderRequest
-
Determines whether the project builder should recursively build parent/child projects.
- isResolved() - Method in interface org.apache.maven.api.services.ArtifactResolverResult.ResultItem
-
Indicates whether the requested artifact was resolved.
- 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()andProject.getBasedir()points to the same directory, and that eitherModel.isRoot()istrueor thatbasedircontains a.mvnchild 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
SNAPSHOTor not. - isStrict() - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest
- isSuccess() - Method in record class org.apache.maven.api.cache.RequestResult
-
Determines if the request was processed successfully.
- 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.
- isTraceEnabled() - Method in interface org.apache.maven.api.plugin.Log
-
Returns true if the trace error level is enabled.
- 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
SNAPSHOTor not. - isWarnEnabled() - Method in interface org.apache.maven.api.plugin.Log
-
Returns true if the warn error level is enabled.
- isWindows() - Method in interface org.apache.maven.api.services.OsService
-
Checks if the current operating system belongs to the Windows family.
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
-
Represents a Java toolchain in the Maven build system.
K
- key() - Method in interface org.apache.maven.api.Artifact
-
Returns a unique identifier for this artifact.
- key(Class) - 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, Object) - Static method in interface org.apache.maven.api.SessionData
-
Create a key using the given class and id.
- kind() - Method in interface org.apache.maven.api.Lifecycle.Link
-
Returns the kind of link (BEFORE or AFTER).
- KNOWN_MODEL_VERSIONS - Static variable in interface org.apache.maven.api.services.ModelBuilder
L
- language() - Method in interface org.apache.maven.api.Packaging
-
The language of this packaging.
- language() - Method in interface org.apache.maven.api.SourceRoot
-
Returns the language of the source files.
- 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(). - Lifecycle - Interface in org.apache.maven.api
-
A Maven lifecycle is a sequence of predefined phases that govern the build process of a Maven project.
- Lifecycle.Alias - Interface in org.apache.maven.api
-
A phase alias, mostly used to support the Maven 3 phases which are mapped to dynamic phases in Maven 4.
- Lifecycle.ChildrenPointer - Interface in org.apache.maven.api
- Lifecycle.DependenciesPointer - Interface in org.apache.maven.api
- Lifecycle.Link - Interface in org.apache.maven.api
-
A link from a phase to another phase, consisting of a type which can be
Lifecycle.Link.Kind.BEFOREorLifecycle.Link.Kind.AFTER, and aLifecycle.Pointerto another phase. - Lifecycle.Link.Kind - Enum Class in org.apache.maven.api
- Lifecycle.Phase - Interface in org.apache.maven.api
-
A phase in the lifecycle.
- Lifecycle.PhasePointer - Interface in org.apache.maven.api
- Lifecycle.Pointer - Interface in org.apache.maven.api
- Lifecycle.Pointer.Type - Enum Class in org.apache.maven.api
- lifecycleBindingsInjector(ModelTransformer) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- LifecycleProvider - Interface in org.apache.maven.api.plugin
-
Interface that can be provided by the plugin to wire in custom lifecycles leveraged using the
Executeannotation. - LifecycleRegistry - Interface in org.apache.maven.api.services
- links() - Method in interface org.apache.maven.api.Lifecycle.Phase
-
Returns the collection of links from this phase to other phases.
- Listener - Interface in org.apache.maven.api
-
A listener for session events.
- LocalRepository - Interface in org.apache.maven.api
-
The local repository is a directory on the developer's machine where Maven stores all the downloaded artifacts (such as dependencies, plugins, and project artifacts).
- LocalRepositoryManager - Interface in org.apache.maven.api.services
-
Manages the organization and access of artifacts within the local Maven repository.
- locateExistingPom(Path) - Method in interface org.apache.maven.api.services.ModelSource.ModelLocator
-
Attempts to locate an existing POM file at or within the specified project path.
- location() - Method in enum class org.apache.maven.api.JavaPathType
-
Returns the identification of this path in the
javax.toolAPI. - location(String) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder
- Location - Interface in org.apache.maven.api.services.xml
- locationTracking(boolean) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- 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. - longMessage - Variable in exception class org.apache.maven.api.plugin.MojoException
- lookup(Class) - Method in interface org.apache.maven.api.services.Lookup
-
Performs a lookup for given typed component.
- lookup(Class, 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
Lookupservice. - LookupException(Exception) - Constructor for exception class org.apache.maven.api.services.LookupException
- LookupException(String) - 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) - Method in interface org.apache.maven.api.services.Lookup
-
Performs a collection lookup for given typed components.
- lookupMap(Class) - Method in interface org.apache.maven.api.services.Lookup
-
Performs a collection lookup for given typed components.
- lookupOptional(Class) - Method in interface org.apache.maven.api.services.Lookup
-
Performs a lookup for optional typed component.
- lookupOptional(Class, 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) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
-
Sets the dependency management to apply to transitive dependencies.
- managedDependency(DependencyCoordinates) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
-
Adds the specified managed dependency.
- matcher(Collection, boolean) - Method in interface org.apache.maven.api.SourceRoot
-
Returns a matcher combining the include and exclude patterns.
- matchesRequirements(Map) - Method in interface org.apache.maven.api.Toolchain
-
Let the toolchain decide if it matches requirements defined in the toolchain plugin configuration.
- MAVEN_BUILD_TIMESTAMP_FORMAT - Static variable in class org.apache.maven.api.Constants
-
Build timestamp format.
- MAVEN_BUILD_VERSION - Static variable in class org.apache.maven.api.Constants
-
Maven build version: a human-readable string containing this Maven version, buildnumber, and time of its build.
- MAVEN_BUILDER_MAX_PROBLEMS - Static variable in class org.apache.maven.api.Constants
-
Max number of problems for each severity level retained by the model builder.
- MAVEN_CONSUMER_POM - Static variable in class org.apache.maven.api.Constants
-
User property for enabling/disabling the consumer POM feature.
- MAVEN_CONSUMER_POM_FLATTEN - Static variable in class org.apache.maven.api.Constants
-
User property for controlling consumer POM flattening behavior.
- MAVEN_CONSUMER_POM_REMOVE_UNUSED_MANAGED_DEPENDENCIES - Static variable in class org.apache.maven.api.Constants
-
User property for controlling removal of unused managed dependencies during consumer POM flattening.
- MAVEN_CONSUMER_POM_SANITIZE_REPOSITORIES - Static variable in class org.apache.maven.api.Constants
-
User property for controlling whether the repositories published in a consumer POM are restricted to the repositories declared in the project's own POM file.
- MAVEN_DEPLOY_SNAPSHOT_BUILD_NUMBER - Static variable in class org.apache.maven.api.Constants
-
User property for overriding calculated "build number" for snapshot deploys.
- MAVEN_EXT_CLASS_PATH - Static variable in class org.apache.maven.api.Constants
-
Extensions class path.
- MAVEN_HOME - Static variable in class org.apache.maven.api.Constants
-
Maven home.
- MAVEN_INSTALLATION_CONF - Static variable in class org.apache.maven.api.Constants
-
Maven installation configuration directory.
- MAVEN_INSTALLATION_EXTENSIONS - Static variable in class org.apache.maven.api.Constants
-
Maven installation extensions.
- MAVEN_INSTALLATION_SETTINGS - Static variable in class org.apache.maven.api.Constants
-
Maven installation settings.
- MAVEN_INSTALLATION_TOOLCHAINS - Static variable in class org.apache.maven.api.Constants
-
Maven installation toolchains.
- MAVEN_LOGGER_CACHE_OUTPUT_STREAM - Static variable in class org.apache.maven.api.Constants
-
If the output target is set to "System.out" or "System.err" (see preceding entry), by default, logs will be output to the latest value referenced by System.out/err variables.
- MAVEN_LOGGER_DATE_TIME_FORMAT - Static variable in class org.apache.maven.api.Constants
-
The date and time format to be used in the output messages.
- MAVEN_LOGGER_DEFAULT_LOG_LEVEL - Static variable in class org.apache.maven.api.Constants
-
Default log level for all instances of SimpleLogger.
- MAVEN_LOGGER_LEVEL_IN_BRACKETS - Static variable in class org.apache.maven.api.Constants
-
Should the level string be output in brackets? Defaults to false.
- MAVEN_LOGGER_LOG_FILE - Static variable in class org.apache.maven.api.Constants
-
The output target which can be the path to a file, or the special values "System.out" and "System.err".
- MAVEN_LOGGER_LOG_PREFIX - Static variable in class org.apache.maven.api.Constants
-
maven.logger.log.a.b.c - Logging detail level for a SimpleLogger instance named "a.b.c".
- MAVEN_LOGGER_PREFIX - Static variable in class org.apache.maven.api.Constants
-
All system properties used by Maven Logger start with this prefix.
- MAVEN_LOGGER_SHOW_DATE_TIME - Static variable in class org.apache.maven.api.Constants
-
Set to true if you want the current date and time to be included in output messages.
- MAVEN_LOGGER_SHOW_LOG_NAME - Static variable in class org.apache.maven.api.Constants
-
Set to true if you want the Logger instance name to be included in output messages.
- MAVEN_LOGGER_SHOW_SHORT_LOG_NAME - Static variable in class org.apache.maven.api.Constants
-
Set to true if you want the last component of the name to be included in output messages.
- MAVEN_LOGGER_SHOW_THREAD_ID - Static variable in class org.apache.maven.api.Constants
-
If you would like to output the current thread id, then set to true.
- MAVEN_LOGGER_SHOW_THREAD_NAME - Static variable in class org.apache.maven.api.Constants
-
Set to true if you want to output the current thread name.
- MAVEN_LOGGER_WARN_LEVEL - Static variable in class org.apache.maven.api.Constants
-
The string value output for the warn level.
- MAVEN_MAVEN3_PERSONALITY - Static variable in class org.apache.maven.api.Constants
-
User property for controlling "maven personality".
- MAVEN_MODEL_BUILDER_INTERNS - Static variable in class org.apache.maven.api.Constants
-
Comma-separated list of XML contexts/fields to intern during POM parsing for memory optimization.
- MAVEN_MODEL_BUILDER_PARALLELISM - Static variable in class org.apache.maven.api.Constants
-
ProjectBuilder parallelism.
- MAVEN_MODEL_DEPENDENCY_INTERPOLATION_FULL - Static variable in class org.apache.maven.api.Constants
-
User property for opting back into the previous behavior of interpolating repository-resolved models (dependencies and parents) against the full set of session properties (system, environment and CLI).
- MAVEN_PLUGIN - Static variable in interface org.apache.maven.api.Type
-
Artifact type name for a Maven plugin.
- MAVEN_PLUGIN_VALIDATION - Static variable in class org.apache.maven.api.Constants
-
Plugin validation level.
- MAVEN_PLUGIN_VALIDATION_EXCLUDES - Static variable in class org.apache.maven.api.Constants
-
Plugin validation exclusions.
- MAVEN_PROJECT_CONF - Static variable in class org.apache.maven.api.Constants
-
Maven project configuration directory.
- MAVEN_PROJECT_DISCOVER_SUBPROJECTS - Static variable in class org.apache.maven.api.Constants
-
User property for enabling/disabling automatic subproject discovery for POM-packaged projects.
- MAVEN_PROJECT_EXTENSIONS - Static variable in class org.apache.maven.api.Constants
-
Maven project extensions.
- MAVEN_PROJECT_SETTINGS - Static variable in class org.apache.maven.api.Constants
-
Maven project settings.
- MAVEN_REACTOR_OUTPUT_REPOSITORY - Static variable in class org.apache.maven.api.Constants
-
User property for overriding the reactor output repository path used by the reactor reader to share artifacts between modules during a build.
- MAVEN_RELOCATIONS_ENTRIES - Static variable in class org.apache.maven.api.Constants
-
User controlled relocations.
- MAVEN_REPO_CENTRAL - Static variable in class org.apache.maven.api.Constants
-
Maven central repository URL.
- MAVEN_REPO_LOCAL - Static variable in class org.apache.maven.api.Constants
-
Maven local repository.
- MAVEN_REPO_LOCAL_HEAD - Static variable in class org.apache.maven.api.Constants
-
User property for chained LRM: the new "head" local repository to use, and "push" the existing into tail.
- MAVEN_REPO_LOCAL_RECORD_REVERSE_TREE - Static variable in class org.apache.maven.api.Constants
-
User property for reverse dependency tree.
- MAVEN_REPO_LOCAL_TAIL - Static variable in class org.apache.maven.api.Constants
-
User property for chained LRM: list of "tail" local repository paths (separated by comma), to be used with
org.eclipse.aether.util.repository.ChainedLocalRepositoryManager. - MAVEN_REPO_LOCAL_TAIL_IGNORE_AVAILABILITY - Static variable in class org.apache.maven.api.Constants
-
User property for chained LRM: whether to ignore "availability check" in tail or not.
- MAVEN_REPOSITORY_DEPENDENCY_MANAGEMENT_ALLOW_SYSTEM_SCOPE - Static variable in class org.apache.maven.api.Constants
-
User property for allowing
systemscope andsystemPathin dependency management imported from repository-resolved POMs (BOMs). - MAVEN_RESOLVER_DEPENDENCY_MANAGER_TRANSITIVITY - Static variable in class org.apache.maven.api.Constants
-
User property for selecting dependency manager behaviour regarding transitive dependencies and dependency management entries in their POMs.
- MAVEN_RESOLVER_TRANSPORT - Static variable in class org.apache.maven.api.Constants
-
Resolver transport to use.
- MAVEN_RESOLVER_VALIDATION - Static variable in class org.apache.maven.api.Constants
-
Resolver validation control.
- MAVEN_SETTINGS_SECURITY - Static variable in class org.apache.maven.api.Constants
- MAVEN_SETTINGS_SECURITY_FILE_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_START_INSTANT - Static variable in class org.apache.maven.api.Constants
-
User property used to store the build timestamp.
- MAVEN_STYLE_COLOR_PROPERTY - Static variable in class org.apache.maven.api.Constants
-
Maven output color mode.
- MAVEN_STYLE_DEBUG - Static variable in class org.apache.maven.api.Constants
-
Color style for debug messages.
- MAVEN_STYLE_DEBUG_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_DEBUG_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_ERROR - Static variable in class org.apache.maven.api.Constants
-
Color style for error messages.
- MAVEN_STYLE_ERROR_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_ERROR_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_FAILURE - Static variable in class org.apache.maven.api.Constants
-
Color style for failure messages.
- MAVEN_STYLE_FAILURE_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_FAILURE_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_INFO - Static variable in class org.apache.maven.api.Constants
-
Color style for info messages.
- MAVEN_STYLE_INFO_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_INFO_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_MOJO - Static variable in class org.apache.maven.api.Constants
-
Color style for mojo messages.
- MAVEN_STYLE_MOJO_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_MOJO_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_PREFIX - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_PROJECT - Static variable in class org.apache.maven.api.Constants
-
Color style for project messages.
- MAVEN_STYLE_PROJECT_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_PROJECT_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_STRONG - Static variable in class org.apache.maven.api.Constants
-
Color style for strong messages.
- MAVEN_STYLE_STRONG_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_STRONG_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_SUCCESS - Static variable in class org.apache.maven.api.Constants
-
Color style for success messages.
- MAVEN_STYLE_SUCCESS_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_SUCCESS_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_TRACE - Static variable in class org.apache.maven.api.Constants
-
Color style for trace messages.
- MAVEN_STYLE_TRACE_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_TRACE_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_TRANSFER - Static variable in class org.apache.maven.api.Constants
-
Color style for transfer messages.
- MAVEN_STYLE_TRANSFER_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_TRANSFER_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_WARNING - Static variable in class org.apache.maven.api.Constants
-
Color style for warning messages.
- MAVEN_STYLE_WARNING_DEFAULT - Static variable in class org.apache.maven.api.Constants
- MAVEN_STYLE_WARNING_NAME - Static variable in class org.apache.maven.api.Constants
- MAVEN_USER_CONF - Static variable in class org.apache.maven.api.Constants
-
Maven user configuration directory.
- MAVEN_USER_EXTENSIONS - Static variable in class org.apache.maven.api.Constants
-
Maven user extensions.
- MAVEN_USER_SETTINGS - Static variable in class org.apache.maven.api.Constants
-
Maven user settings.
- MAVEN_USER_TOOLCHAINS - Static variable in class org.apache.maven.api.Constants
-
Maven user toolchains.
- MAVEN_VERSION - Static variable in class org.apache.maven.api.Constants
-
Maven version.
- MAVEN_VERSION_FILTER - Static variable in class org.apache.maven.api.Constants
-
Builds
org.eclipse.aether.collection.VersionFilterinstances out of input expression string. - MAVEN_VERSION_MAJOR - Static variable in class org.apache.maven.api.Constants
-
Maven major version: contains the major segment of this Maven version.
- MAVEN_VERSION_MINOR - Static variable in class org.apache.maven.api.Constants
-
Maven minor version: contains the minor segment of this Maven version.
- MAVEN_VERSION_PATCH - Static variable in class org.apache.maven.api.Constants
-
Maven patch version: contains the patch segment of this Maven version.
- MAVEN_VERSION_RANGE_RESOLVER_NATURE_OVERRIDE - Static variable in class org.apache.maven.api.Constants
-
Configuration property for version range resolution used metadata "nature".
- MAVEN_VERSION_RESOLVER_NO_CACHE - Static variable in class org.apache.maven.api.Constants
-
User property for disabling version resolver cache.
- MAVEN_VERSION_SNAPSHOT - Static variable in class org.apache.maven.api.Constants
-
Maven snapshot: contains "true" if this Maven is a snapshot version.
- MavenBuilderException - Exception Class in org.apache.maven.api.services
-
Base class for all maven exceptions carrying
BuilderProblems. - MavenBuilderException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.MavenBuilderException
-
Constructs a new exception with the specified message and cause.
- MavenBuilderException(String, ProblemCollector) - Constructor for exception class org.apache.maven.api.services.MavenBuilderException
-
Constructs a new exception with the specified message and problems.
- Maven Core API - Section in package org.apache.maven.api
- 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
- MavenExecutionException - Exception Class in org.apache.maven.api.cache
-
Exception thrown when an error occurs during Maven execution.
- MavenExecutionException(Throwable) - Constructor for exception class org.apache.maven.api.cache.MavenExecutionException
-
Constructs a new MavenExecutionException with the specified cause.
- mavenMaven3Personality(Map) - Static method in class org.apache.maven.api.feature.Features
-
Check if the personality is "maven3".
- memoize(UnaryOperator) - Static method in interface org.apache.maven.api.services.Interpolator
-
Memoizes a given function that takes a String input and produces a String output.
- 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. - MODEL_VERSION_4_0_0 - Static variable in interface org.apache.maven.api.services.ModelBuilder
- MODEL_VERSION_4_1_0 - Static variable in interface org.apache.maven.api.services.ModelBuilder
- ModelBuilder - Interface in org.apache.maven.api.services
- ModelBuilder.ModelBuilderSession - Interface in org.apache.maven.api.services
- ModelBuilderException - Exception Class in org.apache.maven.api.services
-
The Exception class throw by the
ProjectBuilderservice. - ModelBuilderException(ModelBuilderResult) - Constructor for exception class org.apache.maven.api.services.ModelBuilderException
-
Creates a new exception from the specified interim result and its associated problems.
- ModelBuilderRequest - Interface in org.apache.maven.api.services
-
Request used to build a
Projectusing theProjectBuilderservice. - ModelBuilderRequest.ModelBuilderRequestBuilder - Class in org.apache.maven.api.services
- ModelBuilderRequest.RepositoryMerging - Enum Class in org.apache.maven.api.services
-
The possible merge modes for combining remote repositories.
- ModelBuilderRequest.RequestType - Enum Class in org.apache.maven.api.services
-
The possible request types for building a model.
- ModelBuilderResult - Interface in org.apache.maven.api.services
-
Result of a project build call.
- modelId(String) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder
- ModelProblem - Interface in org.apache.maven.api.services
-
Describes a problem that was encountered during model building.
- ModelProblem.Version - Enum Class in org.apache.maven.api.services
-
Enumeration of model versions that can be validated.
- ModelProblemCollector - Interface in org.apache.maven.api.services
-
Collects problems that are encountered during model building.
- ModelSource - Interface in org.apache.maven.api.services
-
Represents a source for loading Maven Project Object Model (POM) files.
- ModelSource.ModelLocator - Interface in org.apache.maven.api.services
-
Interface for locating POM files within a project structure.
- ModelTransformer - Interface in org.apache.maven.api.services
-
A model transformer.
- ModelXmlFactory - Interface in org.apache.maven.api.services.xml
-
Reads or writes a
Modelusing 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.
- MODULAR_PROCESSOR - Static variable in interface org.apache.maven.api.Type
-
Artifact type name for a JAR file to unconditionally place on the annotation processor module path.
- module() - Method in interface org.apache.maven.api.SourceRoot
-
Returns the name of the Java module (or other language-specific module) which is built by the sources.
- 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-pathoption. - 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
-
Represents the contract for Mojos to interact with the Maven infrastructure.
- Mojo - Annotation Interface in org.apache.maven.api.plugin.annotations
-
This annotation will mark your class as a Mojo, which is the implementation of a goal in a Maven plugin.
- 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
-
Constructs a new
MojoExceptionproviding the source and a short and long message. - MojoException(String) - Constructor for exception class org.apache.maven.api.plugin.MojoException
-
Constructs a new
MojoExceptionproviding amessage. - MojoException(String, Throwable) - Constructor for exception class org.apache.maven.api.plugin.MojoException
-
Constructs a new
MojoExceptionwrapping an underlyingThrowableand providing amessage. - MojoException(Throwable) - Constructor for exception class org.apache.maven.api.plugin.MojoException
-
Constructs a new
MojoExecutionExceptionwrapping an underlyingThrowable. - MojoExecution - Interface in org.apache.maven.api
-
A
MojoExecutionrepresents a single execution of a Maven Plugin during a given build. - MonotonicClock - Class in org.apache.maven.api
-
A Clock implementation that combines monotonic timing with wall-clock time.
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.Lifecycle.Phase
-
Returns the name of this phase.
- 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.
- name() - Method in interface org.apache.maven.api.services.OsService
-
Returns the OS full name as reported by the system property "os.name".
- nature(VersionRangeResolverRequest.Nature) - Method in class org.apache.maven.api.services.VersionRangeResolverRequest.VersionResolverRequestBuilder
-
Sets the nature of repositories to query when resolving the version range.
- newBuilder() - Static method in interface org.apache.maven.api.ProtoSession
-
Returns new builder from scratch.
- newline() - Method in interface org.apache.maven.api.services.MessageBuilder
-
Append newline to the message buffer.
- newModelBuilderException() - Method in interface org.apache.maven.api.services.ModelProblemCollector
- newSession() - Method in interface org.apache.maven.api.services.ModelBuilder
- 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 - Static variable in interface org.apache.maven.api.Language
-
The "none" language.
- now() - Static method in class org.apache.maven.api.MonotonicClock
-
Returns the current instant from the monotonic clock.
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 input stream to read 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) - Method in class org.apache.maven.api.JavaPathType.Modular
-
Returns the option followed by a string representation of the given path elements.
- option(Iterable) - Method in enum class org.apache.maven.api.JavaPathType
-
Returns the option followed by a string representation of the given path elements.
- option(Iterable) - 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.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- org.apache.maven.api - package org.apache.maven.api
-
Maven Core API
- org.apache.maven.api.cache - package org.apache.maven.api.cache
-
Provides a caching infrastructure for Maven requests and their results.
- org.apache.maven.api.feature - package org.apache.maven.api.feature
-
Provides feature flag management and configuration capabilities for Maven core functionality.
- org.apache.maven.api.plugin - package org.apache.maven.api.plugin
-
Maven Plugin API.
- org.apache.maven.api.plugin.annotations - package org.apache.maven.api.plugin.annotations
-
Provides annotations for Maven plugin development, including mojo configuration, parameter definitions, and lifecycle bindings.
- org.apache.maven.api.services - package org.apache.maven.api.services
-
Defines core service interfaces that provide essential Maven functionality such as artifact resolution, dependency management, and build execution.
- org.apache.maven.api.services.xml - package org.apache.maven.api.services.xml
-
Provides XML-specific services for reading and writing Maven's configuration files and descriptors.
- OsService - Interface in org.apache.maven.api.services
-
Service for detecting and providing information about the operating system (OS) on which the application is running.
- outputStream(OutputStream) - Method in class org.apache.maven.api.services.xml.XmlWriterRequest.XmlWriterRequestBuilder
P
- PACKAGE - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- Packaging - Interface in org.apache.maven.api
-
Represents the packaging of a Maven project.
- 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(...). - parent() - Method in record class org.apache.maven.api.services.RequestTrace
-
Returns the value of the
parentrecord component. - 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-moduleoption. - patchModule(String) - Static method in enum class org.apache.maven.api.JavaPathType
-
Creates a path identified by the Java
--patch-moduleoption. - path(Path) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder
-
Sets the path to the project to build.
- 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
- PathMatcherFactory - Interface in org.apache.maven.api.services
-
Service for creating
PathMatcherobjects that can be used to filter files based on include/exclude patterns. - pathScope() - Element in annotation interface org.apache.maven.api.plugin.annotations.Resolution
-
The id of a
PathScopeenum value. - 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) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
-
Specifies the type of paths to include in the result.
- pathTypeFilter(Predicate) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
-
Filters the types of paths to include in the result.
- PERSISTENT - Enum constant in enum class org.apache.maven.api.cache.CacheRetention
-
Data should be persisted across Maven invocations.
- phase() - Method in interface org.apache.maven.api.Lifecycle.Pointer
-
Returns the name of the target phase.
- phase() - Element in annotation interface org.apache.maven.api.plugin.annotations.After
-
The phase name.
- phase() - Element in annotation interface org.apache.maven.api.plugin.annotations.Execute
-
Lifecycle phase to fork.
- phases() - Method in interface org.apache.maven.api.Lifecycle.Phase
-
Returns the list of sub-phases.
- phases() - Method in interface org.apache.maven.api.Lifecycle
-
Collection of main phases for this lifecycle.
- Plugin - Interface in org.apache.maven.api
-
Represents a maven plugin runtime
- plugins() - Method in interface org.apache.maven.api.Lifecycle.Phase
-
Returns the list of plugins bound to this phase.
- plugins() - Method in interface org.apache.maven.api.Packaging
-
Returns the binding to use specifically for this packaging keyed by lifecycle id.
- PluginXmlFactory - Interface in org.apache.maven.api.services.xml
-
Reads and writes a
PluginDescriptorobject to/from XML. - pointer() - Method in interface org.apache.maven.api.Lifecycle.Link
-
Returns the pointer to the target phase.
- POM - Static variable in interface org.apache.maven.api.Type
-
Artifact type name for a POM file.
- POM_DOMINANT - Enum constant in enum class org.apache.maven.api.services.ModelBuilderRequest.RepositoryMerging
-
The repositories declared in the POM have precedence over the repositories specified in the request.
- ProblemCollector<P> - Interface in org.apache.maven.api.services
-
Collects problems that were encountered during project building.
- ProblemCollector.Impl<P> - Class in org.apache.maven.api.services
-
Default implementation of the ProblemCollector interface.
- problems() - Method in interface org.apache.maven.api.services.ProblemCollector
-
Returns all reported and preserved problems ordered by severity in decreasing order.
- problems(BuilderProblem.Severity) - Method in class org.apache.maven.api.services.ProblemCollector.Impl
- problems(BuilderProblem.Severity) - Method in interface org.apache.maven.api.services.ProblemCollector
-
Returns all reported and preserved problems for given severity.
- problemsOverflow() - Method in class org.apache.maven.api.services.ProblemCollector.Impl
- problemsOverflow() - Method in interface org.apache.maven.api.services.ProblemCollector
-
Returns
trueif reported problem count exceeded allowed count, and issues were lost. - problemsReportedFor(BuilderProblem.Severity...) - Method in class org.apache.maven.api.services.ProblemCollector.Impl
- problemsReportedFor(BuilderProblem.Severity...) - Method in interface org.apache.maven.api.services.ProblemCollector
-
Returns count of problems reported for given severities.
- PROCESSOR - Static variable in interface org.apache.maven.api.Type
-
Artifact type name for a JAR file that can be placed either on the annotation processor class path or module path.
- PROCESSOR_CLASSES - Enum constant in enum class org.apache.maven.api.JavaPathType
-
The path identified by the Java
--processor-pathoption. - PROCESSOR_MODULES - Enum constant in enum class org.apache.maven.api.JavaPathType
-
The path identified by the Java
--processor-module-pathoption. - processPlugins(boolean) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder
-
Sets whether plugins should be processed during project building.
- ProducedArtifact - Interface in org.apache.maven.api
- profiles(List) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- 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.DependencyResolverRequest.DependencyResolverRequestBuilder
- Project - Interface in org.apache.maven.api
-
Interface representing a Maven project which can be created using the
ProjectBuilderservice. - PROJECT - Enum constant in enum class org.apache.maven.api.Lifecycle.Pointer.Type
- PROJECT - Enum constant in enum class org.apache.maven.api.plugin.annotations.After.Type
- 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
ProjectBuilderservice. - 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
Projectusing theProjectBuilderservice. - ProjectBuilderRequest.ProjectBuilderRequestBuilder - Class in org.apache.maven.api.services
-
Builder for creating ProjectBuilderRequest instances.
- 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 state and artifacts during the Maven build lifecycle.
- projectRequired() - Element in annotation interface org.apache.maven.api.plugin.annotations.Mojo
-
does your mojo requires a project to be executed?
- Projects - Section in package org.apache.maven.api
- 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. - 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) - 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) - 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
Prompterservice. - PrompterException(String) - Constructor for exception class org.apache.maven.api.services.PrompterException
- 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.
- ProtoSession - Interface in org.apache.maven.api
-
The proto session, material used to create
Session. - ProtoSession.Builder - Class in org.apache.maven.api
- 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).
- READY - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- recursive(boolean) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- registerListener(Listener) - Method in interface org.apache.maven.api.Session
-
Register the given listener which will receive all events.
- Relationship with Java compiler standard location - Section in enum class org.apache.maven.api.JavaPathType
- RELEASE - Enum constant in enum class org.apache.maven.api.services.VersionRangeResolverRequest.Nature
-
Query only release repositories to discover versions.
- RELEASE_OR_SNAPSHOT - Enum constant in enum class org.apache.maven.api.services.VersionRangeResolverRequest.Nature
-
Query both release and snapshot repositories to discover versions.
- RemoteRepository - Interface in org.apache.maven.api
-
A remote repository is a central or distributed location from which Maven can download project dependencies, plugins, and other build artifacts.
- replace(SessionData.Key, 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.
- reportProblem(P) - Method in class org.apache.maven.api.services.ProblemCollector.Impl
- reportProblem(P) - Method in interface org.apache.maven.api.services.ProblemCollector
-
Reports a problem: always maintains the counters, but whether problem is preserved in memory, depends on implementation and its configuration.
- repositories(List) - Method in class org.apache.maven.api.services.ArtifactResolverRequest.ArtifactResolverRequestBuilder
- repositories(List) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
- repositories(List) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- repositories(List) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder
-
Sets the list of remote repositories to use for resolving dependencies during project building.
- repositories(List) - Method in class org.apache.maven.api.services.VersionRangeResolverRequest.VersionResolverRequestBuilder
-
Sets the repositories to use for resolving the version range.
- repositories(List) - Method in class org.apache.maven.api.services.VersionResolverRequest.VersionResolverRequestBuilder
- Repositories - Section in package org.apache.maven.api
- repository(RemoteRepository) - Method in class org.apache.maven.api.services.ArtifactDeployerRequest.ArtifactDeployerRequestBuilder
- Repository - Interface in org.apache.maven.api
-
In Maven, repositories are locations where project artifacts (such as JAR files, POM files, and other resources) are stored and retrieved.
- RepositoryAwareRequest - Interface in org.apache.maven.api.services
-
Base interface for service requests that involve remote repository operations.
- Repository Configuration - Section in interface org.apache.maven.api.RemoteRepository
- Repository Configuration - Section in interface org.apache.maven.api.Repository
- RepositoryFactory - Interface in org.apache.maven.api.services
-
Factory service to create
LocalRepositoryorRemoteRepositoryobjects. - repositoryMerging(ModelBuilderRequest.RepositoryMerging) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- Repository Resolution Process - Section in interface org.apache.maven.api.Repository
- request() - Method in record class org.apache.maven.api.cache.RequestResult
-
Returns the value of the
requestrecord component. - request(REQ, Function) - Method in interface org.apache.maven.api.cache.RequestCache
-
Executes and optionally caches a request using the provided supplier function.
- Request<S> - Interface in org.apache.maven.api.services
-
Base interface for service requests in Maven.
- REQUEST_DOMINANT - Enum constant in enum class org.apache.maven.api.services.ModelBuilderRequest.RepositoryMerging
-
The repositories specified in the request have precedence over the repositories declared in the POM.
- REQUEST_SCOPED - Enum constant in enum class org.apache.maven.api.cache.CacheRetention
-
Data should only be retained for the current build request.
- RequestCache - Interface in org.apache.maven.api.cache
-
Interface for caching request results in Maven.
- RequestCacheFactory - Interface in org.apache.maven.api.cache
-
Factory interface for creating new RequestCache instances.
- RequestResult<REQ,
REP> - Record Class in org.apache.maven.api.cache -
A record representing the result of a single request operation, containing the original request, the result (if successful), and any error that occurred during processing.
- RequestResult(REQ, REP, Throwable) - Constructor for record class org.apache.maven.api.cache.RequestResult
-
Creates an instance of a
RequestResultrecord class. - requests(List, Function) - Method in interface org.apache.maven.api.cache.RequestCache
-
Executes and optionally caches a batch of requests using the provided supplier function.
- RequestTrace - Record Class in org.apache.maven.api.services
-
Represents a hierarchical trace of nested requests within a session, enabling correlation between session events and their originating operations in the application code.
- RequestTrace(String, RequestTrace, Object) - Constructor for record class org.apache.maven.api.services.RequestTrace
-
Creates an instance of a
RequestTracerecord class. - RequestTrace(RequestTrace, Object) - Constructor for record class org.apache.maven.api.services.RequestTrace
- requestType() - Element in annotation interface org.apache.maven.api.plugin.annotations.Resolution
-
The request type, in case the default one is not correct.
- requestType(DependencyResolverRequest.RequestType) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
- requestType(ModelBuilderRequest.RequestType) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- require(String) - Method in interface org.apache.maven.api.services.ExtensibleEnumRegistry
- require(String) - Method in interface org.apache.maven.api.services.TypeRegistry
-
Obtain the
Typefrom the specifiedid. - 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
DependencyScopefrom the specifiedid. - requireLanguage(String) - Method in interface org.apache.maven.api.Session
-
Obtain the
Languagefrom the specifiedid. - requirePackaging(String) - Method in interface org.apache.maven.api.Session
-
Obtain the
Packagingfrom the specifiedid. - requirePathScope(String) - Method in interface org.apache.maven.api.Session
-
Obtain the
PathScopefrom the specifiedid. - requireProjectScope(String) - Method in interface org.apache.maven.api.Session
-
Obtain the
ProjectScopefrom the specifiedid. - requireType(String) - Method in interface org.apache.maven.api.Session
-
Obtain the
Typefrom the specifiedid. - resetStyle() - Method in interface org.apache.maven.api.services.MessageBuilder
- Resolution - Section in package org.apache.maven.api
- Resolution - Annotation Interface in org.apache.maven.api.plugin.annotations
-
Indicates that a given field will be injected with the result of a dependency collection or resolution request.
- resolve(String) - Method in interface org.apache.maven.api.services.Source
-
Resolves a new source relative to this one.
- 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(ModelSource.ModelLocator, String) - Method in interface org.apache.maven.api.services.ModelSource
-
Resolves a relative path to another POM file using the provided model locator.
- 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) - Method in interface org.apache.maven.api.services.ArtifactResolver
-
Resolves several artifacts from their coordinates.
- resolve(Session, Collection, List) - Method in interface org.apache.maven.api.services.ArtifactResolver
-
Resolves several artifacts from their coordinates.
- resolve(Session, List) - Method in interface org.apache.maven.api.services.DependencyResolver
- resolve(Session, List, PathScope) - Method in interface org.apache.maven.api.services.DependencyResolver
- resolve(Session, ArtifactCoordinates) - Method in interface org.apache.maven.api.services.VersionRangeResolver
-
Expands a version range to a list of matching versions, in ascending order.
- resolve(Session, ArtifactCoordinates) - Method in interface org.apache.maven.api.services.VersionResolver
-
Resolves an artifact's meta version (if any) to a concrete version.
- resolve(Session, ArtifactCoordinates, List) - Method in interface org.apache.maven.api.services.VersionRangeResolver
-
Expands a version range to a list of matching versions, in ascending order.
- resolve(Session, DependencyCoordinates) - Method in interface org.apache.maven.api.services.DependencyResolver
- resolve(Session, DependencyCoordinates, 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
- RESOLVE - Enum constant in enum class org.apache.maven.api.services.DependencyResolverRequest.RequestType
- resolveArtifact(Artifact) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactResolver.class).resolve(...). - resolveArtifact(ArtifactCoordinates) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactResolver.class).resolve(...). - resolveArtifact(ArtifactCoordinates, List) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactResolver.class).resolve(...). - resolveArtifact(Artifact, List) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactResolver.class).resolve(...). - resolveArtifacts(Collection) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactResolver.class).resolve(...). - resolveArtifacts(Collection, List) - 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(ArtifactCoordinates...) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(ArtifactResolver.class).resolve(...). - resolveDependencies(List) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(DependencyResolver.class).resolve(...).getPaths(). - resolveDependencies(DependencyCoordinates) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(DependencyResolver.class).resolve(...).getPaths(). - resolveDependencies(DependencyCoordinates, PathScope, Collection) - 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) - Method in interface org.apache.maven.api.Session
-
Shortcut for
getService(DependencyResolver.class).resolve(...).getDispatchedPaths(). - resolvedSource(Path, String) - Static method in class org.apache.maven.api.services.Sources
-
Creates a new resolved source for the specified path and location.
- resolveHighestVersion(ArtifactCoordinates, List) - Method in interface org.apache.maven.api.Session
-
Resolves the highest available version of a version range.
- resolveVersion(ArtifactCoordinates) - Method in interface org.apache.maven.api.Session
-
Resolves an artifact's meta version (if any) to a concrete version.
- resolveVersionRange(ArtifactCoordinates) - Method in interface org.apache.maven.api.Session
-
Expands a version range to a list of matching versions, in ascending order.
- resolveVersionRange(ArtifactCoordinates, List) - Method in interface org.apache.maven.api.Session
-
Expands a version range to a list of matching versions, in ascending order.
- RESOURCES - Static variable in interface org.apache.maven.api.Language
-
The "resources" language.
- RESOURCES - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- result() - Method in record class org.apache.maven.api.cache.RequestResult
-
Returns the value of the
resultrecord component. - Result<REQ> - Interface in org.apache.maven.api.services
-
Base interface for service operation results in Maven.
- retryFailedDeploymentCount(int) - Method in class org.apache.maven.api.services.ArtifactDeployerRequest.ArtifactDeployerRequestBuilder
- root(DependencyCoordinates) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
- rootArtifact(Artifact) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
-
Sets the root artifact for the dependency graph.
- rootDirectory(Path) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder
- RUNTIME - Enum constant in enum class org.apache.maven.api.DependencyScope
-
Runtime and test.
S
- scope() - Method in interface org.apache.maven.api.Lifecycle.DependenciesPointer
-
Returns the dependency scope this pointer applies to.
- scope() - Element in annotation interface org.apache.maven.api.plugin.annotations.After
-
The scope for dependencies, only if
type() == Type.Dependencies. - scope() - Method in interface org.apache.maven.api.SourceRoot
-
Returns in which context the source files will be used.
- scope(String) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- SCRIPT - Static variable in interface org.apache.maven.api.Language
-
Deprecated.
- select(String) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService
-
Returns
ChecksumAlgorithmService.ChecksumAlgorithmfor given algorithm name, or throws if algorithm not supported. - select(Collection) - Method in interface org.apache.maven.api.services.ChecksumAlgorithmService
-
Returns a collection of
ChecksumAlgorithmService.ChecksumAlgorithmin 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(ProtoSession) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder
- session(ProtoSession) - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder
- session(Session) - Method in class org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest.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.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- session(Session) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
- session(Session) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- session(Session) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder
-
Sets the Maven session for this request.
- session(Session) - Method in class org.apache.maven.api.services.VersionRangeResolverRequest.VersionResolverRequestBuilder
-
Sets the session to use for the request.
- session(Session) - Method in class org.apache.maven.api.services.VersionResolverRequest.VersionResolverRequestBuilder
- Session - Section in package org.apache.maven.api
- 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_SCOPED - Enum constant in enum class org.apache.maven.api.cache.CacheRetention
-
Data should be retained for the duration of the current Maven session.
- 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
- set(SessionData.Key, T) - Method in interface org.apache.maven.api.SessionData
-
Associates the specified session data with the given key.
- setArtifactPath(ProducedArtifact, 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(ProducedArtifact, 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.
- setRootModel(Model) - Method in interface org.apache.maven.api.services.ModelProblemCollector
- setSource(String) - Method in interface org.apache.maven.api.services.ModelProblemCollector
- setSource(Model) - Method in interface org.apache.maven.api.services.ModelProblemCollector
- SettingsBuilder - Interface in org.apache.maven.api.services
-
Builds the effective settings from a user settings file and/or an installation 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
- SettingsBuilderException(String, ProblemCollector) - 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
Settingsobject to/from XML. - showMessage(String) - Method in interface org.apache.maven.api.services.Prompter
-
Displays a message to the user.
- SITE - Static variable in interface org.apache.maven.api.Lifecycle
- SNAPSHOT - Enum constant in enum class org.apache.maven.api.services.VersionRangeResolverRequest.Nature
-
Query only snapshot repositories to discover versions.
- source - Variable in exception class org.apache.maven.api.plugin.MojoException
- source(ModelSource) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- source(Source) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder
-
Sets the source of the project to build.
- Source - Interface in org.apache.maven.api.services
-
Provides access to the contents of a source independently of the backing store (e.g.
- SourceRoot - Interface in org.apache.maven.api
-
A root directory of source files.
- Sources - Class in org.apache.maven.api.services
-
Factory methods for creating different types of sources.
- SOURCES - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- Standard Packaging Types - Section in interface org.apache.maven.api.Packaging
- start() - Static method in class org.apache.maven.api.MonotonicClock
-
Returns the initialization time of this monotonic clock.
- startInstant() - Method in class org.apache.maven.api.MonotonicClock
-
Returns the wall clock time captured when this monotonic clock was initialized.
- storeToolchainToBuildContext(Session, Toolchain) - Method in interface org.apache.maven.api.services.ToolchainManager
-
Stores a toolchain in the build context for later retrieval.
- stream() - Method in interface org.apache.maven.api.Node
-
Obtain a Stream containing this node and all its descendants.
- stream() - Method in interface org.apache.maven.api.services.LifecycleRegistry
- strict(boolean) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder
- stringFiltering() - Method in interface org.apache.maven.api.SourceRoot
-
Returns whether resources are filtered to replace tokens with parameterized values.
- 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
SuperPomProviderservice. - 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.
- systemProperties(Map) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
T
- TAGLETS - Enum constant in enum class org.apache.maven.api.JavaPathType
-
The path identified by the Javadoc
-tagletpathoption. - targetPath() - Method in interface org.apache.maven.api.SourceRoot
-
Returns an explicit target path, overriding the default value.
- targetPath(Project) - Method in interface org.apache.maven.api.SourceRoot
-
Returns the fully resolved absolute target path where files should be copied.
- targetVersion() - Method in interface org.apache.maven.api.SourceRoot
-
Returns the version of the platform where the code will be executed.
- targetVersion(Version) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
-
Sets the version of the platform where the code will be executed.
- TEST - Enum constant in enum class org.apache.maven.api.DependencyScope
-
Test compile and test runtime.
- TEST - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- TEST - Static variable in interface org.apache.maven.api.ProjectScope
-
Test scope.
- TEST_COMPILE - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- 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_JAVA_SOURCE - Static variable in interface org.apache.maven.api.Type
-
Artifact type name for a JAR file containing test sources.
- TEST_ONLY - Enum constant in enum class org.apache.maven.api.DependencyScope
-
Test compile only.
- TEST_RESOURCES - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- 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
- TEST_SOURCES - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- toBuilder() - Method in interface org.apache.maven.api.ProtoSession
-
Returns a proto session builder of this instance.
- toCoordinates() - Method in interface org.apache.maven.api.Artifact
-
Returns coordinates with the same identifiers as this artifact.
- toCoordinates() - Method in interface org.apache.maven.api.Dependency
-
Returns coordinates with the same identifiers as this dependency.
- Toolchain - Interface in org.apache.maven.api
-
Represents a toolchain in the Maven build system.
- ToolchainFactory - Interface in org.apache.maven.api.services
-
Factory interface for creating toolchain instances from configuration models.
- ToolchainFactoryException - Exception Class in org.apache.maven.api.services
-
Exception thrown when toolchain factory operations fail.
- ToolchainFactoryException(String) - Constructor for exception class org.apache.maven.api.services.ToolchainFactoryException
- ToolchainFactoryException(String, Throwable) - Constructor for exception class org.apache.maven.api.services.ToolchainFactoryException
- ToolchainFactoryException(Throwable) - Constructor for exception class org.apache.maven.api.services.ToolchainFactoryException
- ToolchainManager - Interface in org.apache.maven.api.services
-
Service interface for managing Maven toolchains, which provide abstraction for different build tools and environments.
- 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 an installation 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
- ToolchainsBuilderException(String, ProblemCollector) - 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
PersistedToolchainsobject to/from XML. - toString() - Method in record class org.apache.maven.api.cache.RequestResult
-
Returns a string representation of this record class.
- 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
-
Returns a string representation of this path type for debugging purposes.
- toString() - Method in interface org.apache.maven.api.PathType
-
Returns a string representation for this extensible enum describing a path type.
- toString() - Method in interface org.apache.maven.api.services.ModelBuilderResult
-
Creates a human-readable representation of these errors.
- toString() - Method in interface org.apache.maven.api.services.Request
-
Returns a string representation of this request, used for debugging and logging purposes.
- toString() - Method in record class org.apache.maven.api.services.RequestTrace
-
Returns a string representation of this record class.
- toString() - Method in interface org.apache.maven.api.Version
-
Returns the string representation of this version.
- toString() - Method in interface org.apache.maven.api.VersionConstraint
-
Returns the string representation of this version.
- toString() - Method in interface org.apache.maven.api.VersionRange
-
Returns the string representation of this version.
- totalProblemsReported() - Method in interface org.apache.maven.api.services.ProblemCollector
-
Returns total count of problems reported.
- toXmlString(T) - Method in interface org.apache.maven.api.services.xml.XmlFactory
-
Converts the given content to an XML string.
- trace(CharSequence) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a message to the user in the trace error level.
- trace(CharSequence, Throwable) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a message (and accompanying exception) to the user at the trace error level.
- trace(Object) - Method in interface org.apache.maven.api.services.MessageBuilder
-
Append message content in trace style.
- trace(Throwable) - Method in interface org.apache.maven.api.plugin.Log
-
Sends an exception to the user in the trace error level.
- trace(Supplier) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a lazily-computed message in the trace error level.
- trace(Supplier, Throwable) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a lazily-computed message (and accompanying exception) in the trace error level.
- trace(RequestTrace) - Method in class org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest.ArtifactFactoryRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.ArtifactDeployerRequest.ArtifactDeployerRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.ArtifactInstallerRequest.ArtifactInstallerRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.ArtifactResolverRequest.ArtifactResolverRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.DependencyResolverRequest.DependencyResolverRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.ProjectBuilderRequest.ProjectBuilderRequestBuilder
-
Sets the request trace for this request.
- trace(RequestTrace) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder
- trace(RequestTrace) - Method in class org.apache.maven.api.services.VersionRangeResolverRequest.VersionResolverRequestBuilder
-
Sets the request trace for debugging and diagnostics.
- trace(RequestTrace) - Method in class org.apache.maven.api.services.VersionResolverRequest.VersionResolverRequestBuilder
- transform(String, String) - Method in interface org.apache.maven.api.services.xml.XmlReaderRequest.Transformer
-
Interpolate the value read from the xml document
- transform(Model, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.ModelTransformer
-
Apply a transformation on the file model.
- 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
Transportinstance for givenRemoteRepository, 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 interface org.apache.maven.api.Lifecycle.ChildrenPointer
-
Returns the type of pointer, which is always CHILDREN for a ChildrenPointer.
- type() - Method in interface org.apache.maven.api.Lifecycle.DependenciesPointer
-
Returns the type of pointer, which is always DEPENDENCIES for a DependenciesPointer.
- type() - Method in interface org.apache.maven.api.Lifecycle.PhasePointer
-
Returns the type of pointer, which is always PROJECT for a PhasePointer.
- type() - Method in interface org.apache.maven.api.Lifecycle.Pointer
-
Returns the type of pointer (PROJECT, DEPENDENCIES, or CHILDREN).
- type() - Method in interface org.apache.maven.api.Packaging
-
The type of main artifact produced by this packaging.
- type() - Element in annotation interface org.apache.maven.api.plugin.annotations.After
-
The type of this pointer.
- type() - Method in class org.apache.maven.api.SessionData.Key
- type(String) - Method in class org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest.ArtifactFactoryRequestBuilder
- type(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder
- type(String) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- Type - Interface in org.apache.maven.api
-
A dependency's
Typeis uniquely identified by aString, and semantically represents a known kind of dependency. - TypeRegistry - Interface in org.apache.maven.api.services
-
Access to
Typeregistry.
U
- UNDEFINED - Enum constant in enum class org.apache.maven.api.DependencyScope
-
Undefined.
- UNIT_TEST - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- 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-pathoption. - url(URL) - Method in class org.apache.maven.api.services.xml.XmlReaderRequest.XmlReaderRequestBuilder
- Usage Example - Section in interface org.apache.maven.api.Packaging
- userProperties(Map) - Method in class org.apache.maven.api.services.ModelBuilderRequest.ModelBuilderRequestBuilder
- userSettingsSource(Source) - Method in class org.apache.maven.api.services.SettingsBuilderRequest.SettingsBuilderRequestBuilder
- userToolchainsSource(Source) - Method in class org.apache.maven.api.services.ToolchainsBuilderRequest.ToolchainsBuilderRequestBuilder
V
- V20 - Enum constant in enum class org.apache.maven.api.services.ModelProblem.Version
-
Validation for Maven 2.0 POM format.
- V30 - Enum constant in enum class org.apache.maven.api.services.ModelProblem.Version
-
Validation for Maven 3.0 POM format.
- V31 - Enum constant in enum class org.apache.maven.api.services.ModelProblem.Version
-
Validation for Maven 3.1 POM format.
- v3Phase() - Method in interface org.apache.maven.api.Lifecycle.Alias
-
Returns the Maven 3 phase name.
- v3phases() - Method in interface org.apache.maven.api.Lifecycle
-
Collection of main phases for this lifecycle used with the Maven 3 builders.
- V40 - Enum constant in enum class org.apache.maven.api.services.ModelProblem.Version
-
Validation for Maven 4.0 POM format.
- V41 - Enum constant in enum class org.apache.maven.api.services.ModelProblem.Version
-
Validation for Maven 4.1 POM format.
- v4Phase() - Method in interface org.apache.maven.api.Lifecycle.Alias
-
Returns the Maven 4 phase name.
- validate(List) - Method in interface org.apache.maven.api.services.RepositoryAwareRequest
-
Validates a list of remote repositories to ensure data integrity.
- validate(Settings) - Method in interface org.apache.maven.api.services.SettingsBuilder
-
Validate the specified settings.
- validate(Settings, boolean) - Method in interface org.apache.maven.api.services.SettingsBuilder
-
Validate the specified settings.
- VALIDATE - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- value() - Element in annotation interface org.apache.maven.api.plugin.annotations.Afters
-
The contained
Afterannotations. - valueOf(String) - Static method in enum class org.apache.maven.api.cache.CacheRetention
-
Returns the enum constant of this class with the specified name.
- 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.Lifecycle.Link.Kind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.maven.api.Lifecycle.Pointer.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.maven.api.plugin.annotations.After.Type
-
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.
- valueOf(String) - Static method in enum class org.apache.maven.api.services.DependencyResolverRequest.RequestType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.maven.api.services.ModelBuilderRequest.RepositoryMerging
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.maven.api.services.ModelBuilderRequest.RequestType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.maven.api.services.ModelProblem.Version
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.apache.maven.api.services.VersionRangeResolverRequest.Nature
-
Returns the enum constant of this class with the specified name.
- valueOf(JavaFileManager.Location) - Static method in enum class org.apache.maven.api.JavaPathType
-
Returns the path type associated to the given
javax.toollocation. - values() - Static method in enum class org.apache.maven.api.cache.CacheRetention
-
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.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.Lifecycle.Link.Kind
-
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.Lifecycle.Pointer.Type
-
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.After.Type
-
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.
- values() - Static method in enum class org.apache.maven.api.services.DependencyResolverRequest.RequestType
-
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.ModelBuilderRequest.RepositoryMerging
-
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.ModelBuilderRequest.RequestType
-
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.ModelProblem.Version
-
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.VersionRangeResolverRequest.Nature
-
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.DependencyResolverRequest.DependencyResolverRequestBuilder
-
Specifies that the collection should be verbose.
- VERIFY - Static variable in interface org.apache.maven.api.Lifecycle.Phase
- version() - Method in interface org.apache.maven.api.services.OsService
-
Returns the OS version as reported by the system property "os.version".
- version(String) - Method in class org.apache.maven.api.services.ArtifactCoordinatesFactoryRequest.ArtifactFactoryRequestBuilder
- version(String) - Method in class org.apache.maven.api.services.ArtifactFactoryRequest.ArtifactFactoryRequestBuilder
- version(String) - Method in class org.apache.maven.api.services.DependencyCoordinatesFactoryRequest.DependencyCoordinatesFactoryRequestBuilder
- Version - Interface in org.apache.maven.api
-
A version or meta-version of an artifact or a dependency.
- VersionConstraint - Interface in org.apache.maven.api
-
Version constraint for dependency.
- VersionParser - Interface in org.apache.maven.api.services
-
Service interface to parse
VersionandVersionRange. - 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
-
A request to resolve a version range to a list of matching versions.
- VersionRangeResolverRequest.Nature - Enum Class in org.apache.maven.api.services
-
Specifies which type of repositories to query when resolving version ranges.
- VersionRangeResolverRequest.VersionResolverRequestBuilder - Class in org.apache.maven.api.services
-
Builder for
VersionRangeResolverRequest. - VersionRangeResolverResult - Interface in org.apache.maven.api.services
-
Represents the result of a version range resolution request.
- 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
-
Sends a message to the user in the warn error level.
- warn(CharSequence, Throwable) - Method in interface org.apache.maven.api.plugin.Log
-
Sends a message (and accompanying exception) to the user in the warn error level.
- warn(Throwable) - Method in interface org.apache.maven.api.plugin.Log
-
Sends an exception to the user in the warn error level.
- warn(Supplier) - Method in interface org.apache.maven.api.plugin.Log
- warn(Supplier, 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
- warningForFilenameBasedAutomodules() - Method in interface org.apache.maven.api.services.DependencyResolverResult
-
If the module path contains at least one filename-based auto-module, prepares a warning message.
- withLocalRepository(LocalRepository) - Method in interface org.apache.maven.api.Session
-
Creates a derived session using the given local repository.
- withRemoteRepositories(List) - Method in interface org.apache.maven.api.Session
-
Creates a derived session using the given remote repositories.
- withRootDirectory(Path) - Method in class org.apache.maven.api.ProtoSession.Builder
- withStartTime(Instant) - Method in class org.apache.maven.api.ProtoSession.Builder
- withSystemProperties(Map) - Method in class org.apache.maven.api.ProtoSession.Builder
- withTopDirectory(Path) - Method in class org.apache.maven.api.ProtoSession.Builder
- withUserProperties(Map) - Method in class org.apache.maven.api.ProtoSession.Builder
- withZone(ZoneId) - Method in class org.apache.maven.api.MonotonicClock
-
Returns a copy of this clock with the specified timezone.
- WorkspaceRepository - Interface in org.apache.maven.api
-
Represents a repository backed by an IDE workspace, the output of a build session, or similar ad-hoc collections of artifacts.
- write(XmlWriterRequest) - 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 while reading an XML file.
- XmlReaderException(String, Location, 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 while writing an XML file.
- XmlWriterException(String, Location, 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
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Language.RESOURCESinstead.