Uses of Annotation Interface
org.apache.maven.api.annotations.Experimental
Package
Description
Maven Core API
This package contains non-functional annotations which are
used to tag various elements and help users understanding
how those types should be used.
Maven Repository Metadata model.
Maven Immutable POM (Project Object Model) classes, generated from
maven.mdo
model.Maven Plugin descriptor model.
Maven Plugin forked lifecycle model.
Maven immutable XML api.
Package
Description
This package contains non-functional annotations which are
used to tag various elements and help users understanding
how those types should be used.
-
Uses of Experimental in org.apache.maven.api
Modifier and TypeInterfaceDescriptioninterface
A Maven artifact is a file, typically a JAR, that is produced and used by Maven projects.interface
Partial identification of anArtifact
in a Maven repository.interface
A result of collecting, flattening and resolvingDependencyCoordinates
s.interface
ArtifactCoordinates
completed with information about how the artifact will be used.enum
Indicates when the dependency will be used.interface
AnArtifact
that has been resolved, i.e.interface
ADependency
that has been resolved, i.e.interface
Event sent by maven during various phases of the build process.enum
The possible types of execution events.interface
A dependency exclusion.interface
Interface that defines some kind of enums that can be extended by Maven plugins or extensions.enum
The option of a Java command-line tool where to place the paths to some dependencies.interface
Represents a Java toolchain in the Maven build system.interface
Language.interface
A Maven lifecycle is a sequence of predefined phases that govern the build process of a Maven project.interface
A listener for session events.interface
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).interface
AMojoExecution
represents a single execution of a Maven Plugin during a given build.interface
Represents a dependency node within a Maven project's dependency collector.interface
Defines a hierarchical visitor for collecting dependency node trees.interface
Represents the packaging of a Maven project.interface
Path scope.interface
The option of a command-line tool where to place the paths to some dependencies.interface
Represents a maven plugin runtimeinterface
interface
Interface representing a Maven project which can be created using theProjectBuilder
service.interface
Project scope.interface
A remote repository is a central or distributed location from which Maven can download project dependencies, plugins, and other build artifacts.interface
In Maven, repositories are locations where project artifacts (such as JAR files, POM files, and other resources) are stored and retrieved.interface
Marker interface for all services provided by theSession
.interface
The session to install / deploy / resolve artifacts and dependencies.interface
A container for data that is specific to a session.interface
Represents a toolchain in the Maven build system.interface
A dependency'sType
is uniquely identified by aString
, and semantically represents a known kind of dependency.interface
A version or meta-version of an artifact or a dependency.interface
Version constraint for dependency.interface
A range of versions. -
Uses of Experimental in org.apache.maven.api.annotations
Modifier and TypeClassDescription@interface
@interface
A type implemented by, or extended by maven plugins or extensions.@interface
This annotation tags types that are part of an experimental API.@interface
This annotation indicates that a type is automatically generated.@interface
TheImmutable
annotation indicates that the object is immutable, i.e.@interface
The annotated element must not be null.@interface
This annotation indicates that the annotated type is not threadsafe and should only be used by a single thread.@interface
The annotated element can benull
.@interface
A type implemented by, or extended by maven itself.@interface
TheThreadSafe
annotation can be used to indicate a given type is thread safe. -
Uses of Experimental in org.apache.maven.api.cli
Modifier and TypeInterfaceDescriptioninterface
Invoker<R extends InvokerRequest<? extends Options>>
Defines the contract for a component responsible for invoking a Maven application using the information provided in anInvokerRequest
.class
Represents an exception that occurs during the invocation of a Maven build or command.interface
InvokerRequest<O extends Options>
Represents a Maven execution request, encapsulating all necessary information for invoking a Maven build or command.interface
Defines a simple logging interface for Maven CLI operations.interface
Represents the base options supported by Maven tools.interface
Parser<R extends InvokerRequest<? extends Options>>
Defines the contract for parsing Maven command-line arguments and creating an InvokerRequest.class
Represents an exception that occurs during the parsing of Maven command-line arguments.interface
Represents a request to parse Maven command-line arguments. -
Uses of Experimental in org.apache.maven.api.cli.extensions
Modifier and TypeClassDescriptionclass
Describes a build extension to utilise.class
Extensions to load. -
Uses of Experimental in org.apache.maven.api.cli.mvn
Modifier and TypeInterfaceDescriptioninterface
MavenInvoker<R extends MavenInvokerRequest<? extends MavenOptions>>
Defines the contract for a component responsible for invoking Maven using information provided in an invoker request.interface
MavenInvokerRequest<O extends MavenOptions>
Represents a request to invoke Maven.interface
Defines the options specific to Maven operations.interface
MavenParser<R extends MavenInvokerRequest<? extends MavenOptions>>
Defines the contract for parsing Maven-specific command-line arguments and creating a MavenInvokerRequest. -
Uses of Experimental in org.apache.maven.api.cli.mvn.forked
Modifier and TypeInterfaceDescriptioninterface
Local Maven invoker.interface
Represents a request to invoke Maven in a forked JVM.interface
Defines the contract for parsing command-line arguments specific to forked Maven executions. -
Uses of Experimental in org.apache.maven.api.cli.mvn.local
-
Uses of Experimental in org.apache.maven.api.cli.mvn.resident
-
Uses of Experimental in org.apache.maven.api.cli.mvnenc
Modifier and TypeInterfaceDescriptioninterface
Defines the contract for a component responsible for invoking the Maven encryption tool.interface
Represents a request to invoke the Maven encryption tool.interface
Defines the options specific to the Maven encryption tool.interface
Defines the contract for parsing encryption-related command-line arguments and creating an EncryptInvokerRequest. -
Uses of Experimental in org.apache.maven.api.metadata
Modifier and TypeClassDescriptionclass
class
Mapping information for a single plugin within this group.class
Snapshot data for the last artifact corresponding to the SNAPSHOT base versionclass
Versioning information for a sub-artifact of the current snapshot artifact.class
Versioning information for "groupId/artifactId" or "groupId/artifactId/version" SNAPSHOT -
Uses of Experimental in org.apache.maven.api.model
Modifier and TypeClassDescriptionclass
The conditions within the build runtime environment which will trigger the automatic inclusion of the build profile.class
This is the file specification used to activate the profile.class
This is an activator which will detect an operating system's attributes in order to activate its profile.class
This is the property specification used to activate a profile.class
The<build>
element contains information required to build the project.class
Build configuration in a profile.class
The<ciManagement>
element contains information required to the continuous integration system of the project.class
Contains the configuration information of the container like Plugin.class
Description of a person who has contributed to the project, but who does not have commit privileges.class
The<dependency>
element contains information about a dependency of the project.class
Section for management of default dependency information for use in a group of POMs.class
Deployment repository contains the information needed for deploying to the remote repository, which adds uniqueVersion property to usual repositories for download.class
Information about one of the committers on this project.class
This elements describes all that pertains to distribution for a project.class
The<exclusion>
element contains information required to exclude an artifact to the project.class
Describes a build extension to utilise.class
A PatternSet for files.class
Information about the issue tracking (or bug tracking) system used to manage this project.class
Describes the licenses for this project.class
This element describes all of the mailing lists associated with a project.class
The<project>
element is the root of the descriptor.class
Base class for theModel
and theProfile
objects.class
Configures one method for notifying users/developers when a build breaks.class
Specifies the organization that produces this project.class
The<parent>
element contains information required to locate the parent project from which this project will inherit from.class
Definition of include or exclude patterns.class
The<plugin>
element contains information required for a plugin.class
Contains the plugins management information for the project.class
Contains the plugins information for the project.class
The@lt;execution>
element contains information required for the execution of a plugin.class
Section for management of default plugin information for use in a group of POMs.class
Describes the prerequisites a project can have.class
Modifications to the build process which is activated based on environmental parameters or command line arguments.class
Describes where an artifact has moved to.class
Section for management of reports and their configuration.class
The<plugin>
element in<reporting><plugins>
contains information required for a report plugin.class
Represents a set of reports and configuration to be used to generate them.class
A repository contains the information needed for establishing connections with remote repository.class
A repository contains the information needed for establishing connections with remote repository.class
Download policy.class
This element describes all of the classpath resources associated with a project or unit tests.class
The<scm>
element contains information required to the SCM (Source Control Management) of the project.class
Contains the information needed for deploying websites. -
Uses of Experimental in org.apache.maven.api.plugin
Modifier and TypeInterfaceDescriptioninterface
Interface that can be provided by the plugin to wire in custom lifecycles leveraged using theExecute
annotation.interface
This interface supplies the API for providing feedback to the user from theMojo
, using standard Maven channels.interface
This interface forms the contract required for Mojos to interact with the Maven infrastructure.class
An exception occurring during the execution of a plugin. -
Uses of Experimental in org.apache.maven.api.plugin.annotations
Modifier and TypeClassDescription@interface
Specifies that the mojo should be run after the specific phase.@interface
Used if your Mojo needs to fork a lifecycle.@interface
This annotation will mark your class as a Mojo, which is the implementation of a goal in a Maven plugin.@interface
Used to configure your Mojo parameters to be injected byMavenPluginManager.getConfiguredMojo(...)
.@interface
Indicates that a given field will be injected with the result of a dependency collection or resolution request. -
Uses of Experimental in org.apache.maven.api.plugin.descriptor
Modifier and TypeClassDescriptionclass
Definition of a dependency, needed by the plugin at runtime.class
A Mojo description.class
A parameter description.class
Root element of theplugin.xml
file.class
Describes a component requirement.class
Dependency collection or resolution injection. -
Uses of Experimental in org.apache.maven.api.plugin.descriptor.lifecycle
Modifier and TypeClassDescriptionclass
A set of goals to execute.class
A custom lifecycle mapping definition.class
Root element of thelifecycle.xml
file.class
A phase mapping definition. -
Uses of Experimental in org.apache.maven.api.services
Modifier and TypeInterfaceDescriptioninterface
Service used to createArtifactCoordinates
objects.interface
A request for creating aArtifactCoordinates
object.interface
DeploysArtifact
s to aRemoteRepository
.class
An artifact could not correctly being deployed.interface
A request for deploying one or more artifacts to a remote repository.interface
Service used to createArtifact
objects.interface
interface
InstallsArtifact
s to the local repository.class
interface
A request for installing one or more artifacts in the local repository.interface
interface
Resolves the artifact, i.e.class
interface
A request for resolving an artifact.interface
The Artifact Resultinterface
Describes a problem that was encountered during project building.static enum
The different severity levels for a problem, in decreasing order.interface
Checksum algorithms service.class
interface
interface
interface
Collects, flattens and resolves dependencies.class
interface
A request to collect the transitive dependencies and to build a dependency graph from them.interface
The result of a dependency resolution request.interface
The Interpolator service provides methods for variable substitution in strings and maps.class
Exception thrown byInterpolator
implementations when an error occurs during interpolation.interface
class
The Exception class throw by theLookup
service.class
Base class for all maven exceptions.interface
A factory forMessageBuilder
.class
The Exception class throw by theProjectBuilder
service.interface
Request used to build aProject
using theProjectBuilder
service.interface
Result of a project build call.interface
A model transformer.interface
class
The Exception class throw by theProjectBuilder
service.interface
Request used to build aProject
using theProjectBuilder
service.interface
Result of a project build call.interface
Interface to manage the project during its lifecycle.interface
Manager forProjectScope
.interface
Service used to interact with the end user.class
The Exception class throw by thePrompter
service.interface
Factory service to createLocalRepository
orRemoteRepository
objects.interface
Builds the effective settings from a user settings file and/or a installation settings file.class
The Exception class throw by theSettingsBuilder
.interface
Collects settings that control the building of effective settings.interface
interface
Provides access to the contents of a source independently of the backing store (e.g.interface
Provides the super POM that all models implicitly inherit from.interface
interface
Service to manageToolchain
s.class
The Exception class throw by theToolchainManager
.interface
Builds the effective toolchains from a user toolchains file and/or an installation toolchains file.class
The Exception class throw by theToolchainsBuilder
.interface
interface
interface
Transport for specified remote repository (using provided remote repository base URI as root).interface
Transporter provider is a service that provides somewhat trivial transport capabilities backed by Maven internals.class
interface
Access toType
registry.interface
Service interface to parseVersion
andVersionRange
.class
The Exception class thrown byVersionParser
.interface
Parses and evaluates version ranges encountered in dependency declarations.class
interface
interface
interface
Resolves artifact meta/pseudo versions.class
interface
interface
-
Uses of Experimental in org.apache.maven.api.services.model
Modifier and TypeInterfaceDescriptioninterface
Caches auxiliary data used during model building like already processed raw/effective models.interface
Factory for creating model caches. -
Uses of Experimental in org.apache.maven.api.services.xml
Modifier and TypeInterfaceDescriptioninterface
Reads or writes aModel
using XML.interface
Reads and writes aPluginDescriptor
object to/from XML.interface
Reads and writes aSettings
object to/from XML.interface
Reads and writes aPersistedToolchains
object to/from XML.interface
XmlFactory<T>
Generic interface to read/write objects to/from XML.class
An exception thrown during the reading of an xml file.interface
An XML reader request.class
An exception thrown during the writing of an xml file.interface
An XML writer request. -
Uses of Experimental in org.apache.maven.api.settings
Modifier and TypeClassDescriptionclass
The conditions within the build runtime environment which will trigger the automatic inclusion of the parent build profile.class
This is the file specification used to activate a profile.class
This is an activator which will detect an operating system's attributes in order to activate its profile.class
This is the property specification used to activate a profile.class
Base class forMirror
,Profile
,Proxy
andServer
.class
A download mirror for a given repository.class
Modifications to the build process which is keyed on some sort of environmental parameter.class
The<proxy>
element contains information required to a proxy settings.class
Repository contains the information needed for establishing connections with remote repositoryclass
Repository contains the information needed for establishing connections with remote repositoryclass
Download policyclass
The<server>
element contains information required to a server settings.class
Root element of the user configuration file.class
Common base class that contains code to track the source for this instance. -
Uses of Experimental in org.apache.maven.api.spi
Modifier and TypeInterfaceDescriptioninterface
ExtensibleEnumProvider<T extends ExtensibleEnum>
An SPI interface to extend Maven with a new enum value.interface
interface
interface
TheModelParser
interface is used to locate and readModel
s from the file system.class
interface
Marker interface for model transformers.class
interface
interface
interface
interface
Component able to contribute to Maven session user properties.interface
Marker interface to indicate services that can be provided by plugins and extensions.interface
-
Uses of Experimental in org.apache.maven.api.toolchain
Modifier and TypeClassDescriptionclass
The<toolchains>
element is the root of the descriptor.class
Definition of a toolchain instance.class
Common base class that contains code to track the source for this instance. -
Uses of Experimental in org.apache.maven.api.xml
-
Uses of Experimental in org.apache.maven.di
-
Uses of Experimental in org.apache.maven.internal
-
Uses of Experimental in org.apache.maven.internal.impl
-
Uses of Experimental in org.apache.maven.jline