Package | Description |
---|---|
org.apache.maven.api | |
org.apache.maven.api.annotations |
This package contains non-functional annotations which are
used to tag various elements and help users understanding
how those types should be used.
|
org.apache.maven.api.model |
Maven POM (Project Object Model) classes, generated from
maven.mdo model. |
org.apache.maven.api.plugin | |
org.apache.maven.api.plugin.annotations | |
org.apache.maven.api.services | |
org.apache.maven.api.services.xml | |
org.apache.maven.api.settings | |
org.apache.maven.api.toolchain | |
org.apache.maven.api.xml | |
org.apache.maven.internal.impl |
Package | Description |
---|---|
org.apache.maven.api.annotations |
This package contains non-functional annotations which are
used to tag various elements and help users understanding
how those types should be used.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Artifact
An artifact points to a resource such as a jar file or war application.
|
interface |
ArtifactCoordinate
The
Coordinate object is used to point to an Artifact
but the version may be specified as a range instead of an exact version. |
interface |
DependencyCoordinate |
interface |
Event
Event sent by maven during various phases of the build process.
|
class |
EventType
The possible types of execution events.
|
interface |
Exclusion
A dependency exlusion.
|
interface |
JavaToolchain
A specific
Toolchain dedicated for Java. |
interface |
Listener
A listener for session events.
|
interface |
LocalRepository
The local repository is used to cache artifacts downloaded from
RemoteRepository
and to hold artifacts that have been build locally. |
class |
MetadataStorage
Storage location for metadata
|
interface |
MojoExecution
A
MojoExecution |
interface |
Node
Represents a dependency node within a Maven project's dependency collector.
|
interface |
NodeVisitor
Defines a hierarchical visitor for collecting dependency node trees.
|
interface |
Project
Interface representing a Maven project.
|
interface |
RemoteRepository
A remote repository that can be used to download or upload artifacts.
|
interface |
Repository
A repository holds artifacts.
|
class |
ResolutionScope
Dependencies resolution scopes available before
mojo execution.
|
class |
Scope
Scope for a dependency
|
interface |
Service
Marker interface for all services provided by the
Session . |
interface |
Session
The session to install / deploy / resolve artifacts and dependencies.
|
interface |
SessionData
A container for data that is specific to a session.
|
interface |
Toolchain
Toolchain interface.
|
interface |
Type
An artifact's
Type represents a known kind of artifacts. |
interface |
Version
A version usually parsed using the
VersionParser service. |
interface |
VersionRange
A range of versions.
|
Modifier and Type | Class and Description |
---|---|
interface |
Consumer
A type implemented by, or extended by maven plugins or extensions.
|
interface |
Experimental
This annotation tags types that are part of an experimental API.
|
interface |
Generated
This annotation indicates that a type is automatically generated.
|
interface |
Immutable
The
Immutable annotation indicates that the object is immutable, i.e. |
interface |
Nonnull
The annotated element must not be null.
|
interface |
NotThreadSafe
This annotation indicates that the annotated type is not threadsafe
and should only be used by a single thread.
|
interface |
Nullable
The annotated element can be
null . |
interface |
Provider
A type implemented by, or extended by maven itself.
|
interface |
ThreadSafe
The
ThreadSafe annotation can be used to indicate a given type
is thread safe. |
Modifier and Type | Class and Description |
---|---|
class |
Activation
The conditions within the build runtime environment which will trigger the
automatic inclusion of the build profile.
|
class |
ActivationFile
This is the file specification used to activate the profile.
|
class |
ActivationOS
This is an activator which will detect an operating system's attributes in order
to activate its profile.
|
class |
ActivationProperty
This is the property specification used to activate a profile.
|
class |
Build
The
<build> element contains informations required to build the project. |
class |
BuildBase
Build configuration in a profile.
|
class |
CiManagement
The
<ciManagement> element contains informations required to the
continuous integration system of the project. |
class |
ConfigurationContainer
Contains the configuration information of the container like Plugin.
|
class |
Contributor
Description of a person who has contributed to the project, but who does not have
commit privileges.
|
class |
Dependency
The
<dependency> element contains information about a dependency
of the project. |
class |
DependencyManagement
Section for management of default dependency information for use in a group of
POMs.
|
class |
DeploymentRepository
Deployment repository contains the information needed for deploying to the remote
repository, which adds uniqueVersion property to usual repositories for download.
|
class |
Developer
Information about one of the committers on this project.
|
class |
DistributionManagement
This elements describes all that pertains to distribution for a project.
|
class |
Exclusion
The
<exclusion> element contains informations required to exclude
an artifact to the project. |
class |
Extension
Describes a build extension to utilise.
|
class |
FileSet
A PatternSet for files.
|
class |
IssueManagement
Information about the issue tracking (or bug tracking) system used to manage this
project.
|
class |
License
Describes the licenses for this project.
|
class |
MailingList
This element describes all of the mailing lists associated with a project.
|
class |
Model
The
<project> element is the root of the descriptor. |
class |
ModelBase
Base class for the
Model and the Profile objects. |
class |
Notifier
Configures one method for notifying users/developers when a build breaks.
|
class |
Organization
Specifies the organization that produces this project.
|
class |
Parent
The
<parent> element contains information required to locate the parent project from which
this project will inherit from. |
class |
PatternSet
Definition of include or exclude patterns.
|
class |
Plugin
The
<plugin> element contains informations required for a plugin. |
class |
PluginConfiguration
Contains the plugins management informations for the project.
|
class |
PluginContainer
Contains the plugins informations for the project.
|
class |
PluginExecution
The
<execution> element contains informations required for the
execution of a plugin. |
class |
PluginManagement
Section for management of default plugin information for use in a group of POMs.
|
class |
Prerequisites
Describes the prerequisites a project can have.
|
class |
Profile
Modifications to the build process which is activated based on environmental
parameters or command line arguments.
|
class |
Relocation
Describes where an artifact has moved to.
|
class |
Reporting
Section for management of reports and their configuration.
|
class |
ReportPlugin
The
<plugin> element in <reporting><plugins> contains informations required for a report plugin. |
class |
ReportSet
Represents a set of reports and configuration to be used to generate them.
|
class |
Repository
A repository contains the information needed for establishing connections with
remote repository.
|
class |
RepositoryBase
A repository contains the information needed for establishing connections with
remote repository.
|
class |
RepositoryPolicy
Download policy.
|
class |
Resource
This element describes all of the classpath resources associated with a project
or unit tests.
|
class |
Scm
The
<scm> element contains informations required to the SCM
(Source Control Management) of the project. |
class |
Site
Contains the information needed for deploying websites.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Mojo
This interface forms the contract required for
Mojos to interact with the Maven
infrastructure.It features an execute() method, which triggers the Mojo's build-process behavior, and can throw
a MojoException if error conditions occur. |
class |
MojoException
An exception occurring during the execution of a plugin.
|
Modifier and Type | Class and Description |
---|---|
interface |
Component
Used to configure injection of Plexus components by
MavenPluginManager.getConfiguredMojo(...) . |
interface |
Execute
Used if your Mojo needs to fork a lifecycle.
|
class |
InstantiationStrategy
Component instantiation strategy.
|
class |
LifecyclePhase
|
interface |
Mojo
This annotation will mark your class as a Mojo (ie.
|
interface |
Parameter
Used to configure your Mojo parameters to be injected by
MavenPluginManager.getConfiguredMojo(...) . |
Modifier and Type | Interface and Description |
---|---|
interface |
ArtifactCoordinateFactory
Service used to create
ArtifactCoordinate objects. |
interface |
ArtifactCoordinateFactoryRequest
A request for creating a
ArtifactCoordinate object. |
interface |
ArtifactDeployer
Deploys
Artifact s to a RemoteRepository . |
class |
ArtifactDeployerException
An artifact could not correctly being deployed.
|
interface |
ArtifactDeployerRequest
A request for deploying one or more artifacts to a remote repository.
|
interface |
ArtifactFactory
Service used to create
Artifact objects. |
interface |
ArtifactFactoryRequest |
interface |
ArtifactInstaller
Installs
Artifact s to the local repository. |
class |
ArtifactInstallerException |
interface |
ArtifactInstallerRequest
A request for installing one or more artifacts in the local repository.
|
interface |
ArtifactManager |
interface |
ArtifactResolver
Resolves the artifact, i.e download the file when required and attach it to the artifact
|
class |
ArtifactResolverException |
interface |
ArtifactResolverRequest
A request for resolving an artifact.
|
interface |
ArtifactResolverResult
The Artifact Result
|
interface |
DependencyCollector
The DependencyCollector service can be used to collect dependencies
for a given artifact and builds a graph of them.
|
class |
DependencyCollectorException
Thrown in case of bad artifact descriptors, version ranges or other
issues encountered during calculation of the dependency graph.
|
interface |
DependencyCollectorRequest
A request to collect the transitive dependencies and to build a dependency graph from them.
|
interface |
DependencyCollectorResult
The result of a dependency collection request.
|
interface |
DependencyCoordinateFactory |
interface |
DependencyCoordinateFactoryRequest |
interface |
LocalRepositoryManager |
class |
LookupException
The Exception class throw by the
Lookup service. |
class |
MavenException
Base class for all maven exceptions.
|
interface |
MessageBuilderFactory
A factory for
MessageBuilder . |
interface |
ProjectBuilder |
class |
ProjectBuilderException
The Exception class throw by the
ProjectBuilder service. |
interface |
ProjectBuilderProblem
Describes a problem that was encountered during project building.
|
class |
ProjectBuilderProblemSeverity
The different severity levels for a problem, in decreasing order.
|
interface |
ProjectBuilderRequest
Request used to build a
Project using
the ProjectBuilder service. |
interface |
ProjectBuilderResult
Result of a project build call.
|
interface |
ProjectBuilderSource
The source for a project's XML model.
|
interface |
ProjectManager
Interface to manage the project during its lifecycle.
|
interface |
Prompter
Service used to interact with the end user.
|
class |
PrompterException
The Exception class throw by the
Prompter service. |
interface |
RepositoryFactory
Factory service to create
LocalRepository or RemoteRepository objects. |
interface |
ToolchainFactory |
interface |
ToolchainManager
Service to manage
Toolchain s. |
class |
ToolchainManagerException
The Exception class throw by the
ToolchainManager . |
interface |
TypeRegistry
Access to
Type registry. |
interface |
VersionParser
Service interface to parse
Version and VersionRange . |
class |
VersionParserException
The Exception class thrown by
VersionParser . |
Modifier and Type | Interface and Description |
---|---|
interface |
ModelXmlFactory
Reads or writes a
Model using XML. |
interface |
SettingsXmlFactory
Reads and writes a
Settings object to/from XML. |
interface |
ToolchainsXmlFactory
Reads and writes a
PersistedToolchains object to/from XML. |
interface |
XmlFactory<T>
Generic interface to read/write objects to/from XML.
|
class |
XmlReaderException
An exception thrown during the reading of an xml file.
|
interface |
XmlReaderRequest
An XML reader request.
|
class |
XmlWriterException
An exception thrown during the writing of an xml file.
|
interface |
XmlWriterRequest<T>
An XML writer request.
|
Modifier and Type | Class and Description |
---|---|
class |
Activation
The conditions within the build runtime environment which will trigger
the automatic inclusion of the parent build profile.
|
class |
ActivationFile
This is the file specification used to activate a profile.
|
class |
ActivationOS
This is an activator which will detect an operating system's attributes in order to activate
its profile.
|
class |
ActivationProperty
This is the property specification used to activate a profile.
|
class |
IdentifiableBase
Base class for
Mirror , Profile , Proxy and Server . |
class |
Mirror
A download mirror for a given repository.
|
class |
Profile
Modifications to the build process which is keyed on some
sort of environmental parameter.
|
class |
Proxy
The
<proxy> element contains informations required to a proxy settings. |
class |
Repository
Repository contains the information needed for establishing
connections with remote repository
|
class |
RepositoryBase
Repository contains the information needed
for establishing connections with remote repository
|
class |
RepositoryPolicy
Download policy
|
class |
Server
The
<server> element contains informations required to a server settings. |
class |
Settings
Root element of the user configuration file.
|
class |
TrackableBase
common base class that contains code to track the source for
this instance (USER|GLOBAL)
|
Modifier and Type | Class and Description |
---|---|
class |
PersistedToolchains
The
<toolchains> element is the root of the descriptor. |
class |
ToolchainModel
Definition of a toolchain instance.
|
class |
TrackableBase
common base class that contains code to track the source for
this instance (USER|GLOBAL)
|
Modifier and Type | Interface and Description |
---|---|
interface |
Dom
An immutable xml node.
|
Modifier and Type | Class and Description |
---|---|
class |
DefaultMessageBuilder |
class |
DefaultMessageBuilderFactory |
Copyright © 2001–2022 The Apache Software Foundation. All rights reserved.