Serialized Form
-
Package org.apache.maven.api.model
-
Class org.apache.maven.api.model.Activation
class Activation extends Object implements Serializable-
Serialized Fields
-
activeByDefault
boolean activeByDefault
If set to true, this profile will be active unless another profile in this pom is activated using the command line -P option or by one of that profile's activators. -
file
ActivationFile file
Specifies that this profile will be activated based on existence of a file. -
importedFrom
InputLocation importedFrom
Location tracking -
jdk
String jdk
Specifies that this profile will be activated when a matching JDK is detected. For example,1.4
only activates on JDKs versioned 1.4, while!1.4
matches any JDK that is not version 1.4. Ranges are supported too:[1.5,)
activates when the JDK is 1.5 minimum. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
os
ActivationOS os
Specifies that this profile will be activated when matching operating system attributes are detected. -
packaging
String packaging
Specifies that this profile will be activated based on the project's packaging. -
property
ActivationProperty property
Specifies that this profile will be activated when this property is specified.
-
-
-
Class org.apache.maven.api.model.ActivationFile
class ActivationFile extends Object implements Serializable-
Serialized Fields
-
exists
String exists
The name of the file that must exist to activate the profile. Please note, that missing and exists fields cannot be used together. Only one of them should be used at any one time. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
missing
String missing
The name of the file that must be missing to activate the profile. Please note, that missing and exists fields cannot be used together. Only one of them should be used at any one time.
-
-
-
Class org.apache.maven.api.model.ActivationOS
class ActivationOS extends Object implements Serializable-
Serialized Fields
-
arch
String arch
The architecture of the operating system to be used to activate the profile. -
family
String family
The general family of the OS to be used to activate the profile, such aswindows
orunix
. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
name
String name
The name of the operating system to be used to activate the profile. This must be an exact match of the${os.name}
Java property, such asWindows XP
. -
version
String version
The version of the operating system to be used to activate the profile.
-
-
-
Class org.apache.maven.api.model.ActivationProperty
class ActivationProperty extends Object implements Serializable-
Serialized Fields
-
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
name
String name
The name of the property to be used to activate a profile. -
value
String value
The value of the property required to activate a profile.
-
-
-
Class org.apache.maven.api.model.Build
class Build extends BuildBase implements Serializable-
Serialized Fields
-
extensions
List<Extension> extensions
A set of build extensions to use from this project. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
outputDirectory
String outputDirectory
The directory where compiled application classes are placed. The default value istarget/classes
. -
scriptSourceDirectory
String scriptSourceDirectory
This element specifies a directory containing the script sources of the project. This directory is meant to be different from the sourceDirectory, in that its contents will be copied to the output directory in most cases (since scripts are interpreted rather than compiled). The default value issrc/main/scripts
. -
sourceDirectory
String sourceDirectory
This element specifies a directory containing the source of the project. The generated build system will compile the sources from this directory when the project is built. The path given is relative to the project descriptor. The default value issrc/main/java
. -
testOutputDirectory
String testOutputDirectory
The directory where compiled test classes are placed. The default value istarget/test-classes
. -
testSourceDirectory
String testSourceDirectory
This element specifies a directory containing the unit test source of the project. The generated build system will compile these directories when the project is being tested. The path given is relative to the project descriptor. The default value issrc/test/java
.
-
-
-
Class org.apache.maven.api.model.BuildBase
class BuildBase extends PluginConfiguration implements Serializable-
Serialized Fields
-
defaultGoal
String defaultGoal
The default goal (or phase in Maven 2) to execute when none is specified for the project. Note that in case of a build with subprojects, only the default goal of the top-level project is relevant, i.e. the default goals of subprojects are ignored. Since Maven 3, multiple goals/phases can be separated by whitespace. -
directory
String directory
The directory where all files generated by the build are placed. The default value istarget
. -
filters
List<String> filters
The list of filter properties files that are used when filtering is enabled. -
finalName
String finalName
The filename (excluding the extension, and with no path information) that the produced artifact will be called. The default value is${artifactId}-${version}
. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
resources
List<Resource> resources
This element describes all the classpath resources such as properties files associated with a project. These resources are often included in the final package. The default value issrc/main/resources
. -
testResources
List<Resource> testResources
This element describes all the classpath resources such as properties files associated with a project's unit tests. The default value issrc/test/resources
.
-
-
-
Class org.apache.maven.api.model.CiManagement
class CiManagement extends Object implements Serializable-
Serialized Fields
-
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
notifiers
List<Notifier> notifiers
Configuration for notifying developers/users when a build is unsuccessful, including user information and notification mode. -
system
String system
The name of the continuous integration system, e.g.continuum
. -
url
String url
URL for the continuous integration system used by the project if it has a web interface.
-
-
-
Class org.apache.maven.api.model.ConfigurationContainer
class ConfigurationContainer extends Object implements Serializable-
Serialized Fields
-
configuration
XmlNode configuration
The configuration as DOM object.
By default, every element content is trimmed, but starting with Maven 3.1.0, you can add
xml:space="preserve"
to elements you want to preserve whitespace.You can control how child POMs inherit configuration from parent POMs by adding
combine.children
orcombine.self
attributes to the children of the configuration element:combine.children
: available values aremerge
(default) andappend
,combine.self
: available values aremerge
(default) andoverride
.
- See Also:
-
importedFrom
InputLocation importedFrom
Location tracking -
inherited
String inherited
Whether any configuration should be propagated to child POMs. Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
. Default value istrue
. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class)
-
-
-
Class org.apache.maven.api.model.Contributor
class Contributor extends Object implements Serializable-
Serialized Fields
-
email
String email
The email address of the contributor. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
name
String name
The full name of the contributor. -
organization
String organization
The organization to which the contributor belongs. -
organizationUrl
String organizationUrl
The URL of the organization. -
properties
Map<String,
String> properties Properties about the contributor, such as an instant messenger handle. -
roles
List<String> roles
The roles the contributor plays in the project. Each role is described by arole
element, the body of which is a role name. This can also be used to describe the contribution. -
timezone
String timezone
-
url
String url
The URL for the homepage of the contributor.
-
-
-
Class org.apache.maven.api.model.Dependency
class Dependency extends Object implements Serializable-
Serialized Fields
-
artifactId
String artifactId
The unique id for an artifact produced by the project group, e.g.maven-artifact
. -
classifier
String classifier
The classifier of the dependency. It is appended to the filename after the version. This allows:- referring to attached artifact, for example
sources
andjavadoc
: see default artifact handlers for a list, - distinguishing two artifacts
that belong to the same POM but were built differently.
For example,
jdk14
andjdk15
.
- referring to attached artifact, for example
-
exclusions
List<Exclusion> exclusions
Lists a set of artifacts that should be excluded from this dependency's artifact list when it comes to calculating transitive dependencies. -
groupId
String groupId
The project group that produced the dependency, e.g.org.apache.maven
. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
managementKey
String managementKey
-
optional
String optional
Indicates the dependency is optional for use of this library. While the version of the dependency will be taken into account for dependency calculation if the library is used elsewhere, it will not be passed on transitively. Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
. Default value isfalse
. -
scope
String scope
The scope of the dependency -compile
,runtime
,test
,system
, andprovided
. Used to calculate the various classpaths used for compilation, testing, and so on. It also assists in determining which artifacts to include in a distribution of this project. For more information, see the dependency mechanism. The default scope iscompile
. -
systemPath
String systemPath
FOR SYSTEM SCOPE ONLY. Note that use of this property is discouraged and may be replaced in later versions. This specifies the path on the filesystem for this dependency. Requires an absolute path for the value, not relative. Use a property that gives the machine specific absolute path, e.g.${java.home}
. -
type
String type
The type of dependency, that will be mapped to a file extension, an optional classifier, and a few other attributes. Some examples arejar
,war
,ejb-client
andtest-jar
: see default artifact handlers for a list. New types can be defined by extensions, so this is not a complete list. -
version
String version
The version of the dependency, e.g.3.2.1
. Since Maven 2, this can also be specified as a range of versions.
-
-
-
Class org.apache.maven.api.model.DependencyManagement
class DependencyManagement extends Object implements Serializable-
Serialized Fields
-
dependencies
List<Dependency> dependencies
The dependencies specified here are not used until they are referenced in a POM within the group. This allows the specification of a "standard" version for a particular dependency. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class)
-
-
-
Class org.apache.maven.api.model.DeploymentRepository
class DeploymentRepository extends Repository implements Serializable-
Serialized Fields
-
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
uniqueVersion
boolean uniqueVersion
Whether to assign snapshots a unique version comprised of the timestamp and build number, or to use the same version each time
-
-
-
Class org.apache.maven.api.model.Developer
class Developer extends Contributor implements Serializable-
Serialized Fields
-
id
String id
The unique ID of the developer in the SCM. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class)
-
-
-
Class org.apache.maven.api.model.DistributionManagement
class DistributionManagement extends Object implements Serializable-
Serialized Fields
-
downloadUrl
String downloadUrl
The URL of the project's download page. If not given users will be referred to the homepage given byurl
. This is given to assist in locating artifacts that are not in the repository due to licensing restrictions. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
relocation
Relocation relocation
Relocation information of the artifact if it has been moved to a new group ID and/or artifact ID. -
repository
DeploymentRepository repository
Information needed to deploy the artifacts generated by the project to a remote repository. -
site
Site site
Information needed for deploying the web site of the project. -
snapshotRepository
DeploymentRepository snapshotRepository
Where to deploy snapshots of artifacts to. If not given, it defaults to therepository
element. -
status
String status
Gives the status of this artifact in the remote repository. This must not be set in your local project, as it is updated by tools placing it in the repository. Valid values are:none
(default),converted
(repository manager converted this from an Maven 1 POM),partner
(directly synced from a partner Maven 2 repository),deployed
(was deployed from a Maven 2 instance),verified
(has been hand verified as correct and final).
-
-
-
Class org.apache.maven.api.model.Exclusion
class Exclusion extends Object implements Serializable-
Serialized Fields
-
artifactId
String artifactId
The artifact ID of the project to exclude. -
groupId
String groupId
The group ID of the project to exclude. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class)
-
-
-
Class org.apache.maven.api.model.Extension
class Extension extends Object implements Serializable-
Serialized Fields
-
artifactId
String artifactId
The artifact ID of the extension. -
configuration
XmlNode configuration
The configuration of the extension.- Since:
- Maven 4.0.0
-
groupId
String groupId
The group ID of the extension's artifact. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
version
String version
The version of the extension.
-
-
-
Class org.apache.maven.api.model.FileSet
class FileSet extends PatternSet implements Serializable-
Serialized Fields
-
directory
String directory
Describe the directory where the resources are stored. The path is relative to the POM. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class)
-
-
-
Class org.apache.maven.api.model.InputLocation
class InputLocation extends Object implements Serializable-
Serialized Fields
-
columnNumber
int columnNumber
-
importedFrom
InputLocation importedFrom
-
lineNumber
int lineNumber
-
locations
Map<Object,
InputLocation> locations -
source
InputSource source
-
-
-
Class org.apache.maven.api.model.InputSource
class InputSource extends Object implements Serializable-
Serialized Fields
-
importedFrom
InputLocation importedFrom
-
inputs
List<InputSource> inputs
-
location
String location
-
modelId
String modelId
-
-
-
Class org.apache.maven.api.model.IssueManagement
class IssueManagement extends Object implements Serializable-
Serialized Fields
-
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
system
String system
The name of the issue management system, e.g. Bugzilla -
url
String url
URL for the issue management system used by the project.
-
-
-
Class org.apache.maven.api.model.License
class License extends Object implements Serializable-
Serialized Fields
-
comments
String comments
Addendum information pertaining to this license. -
distribution
String distribution
The primary method by which this project may be distributed.- repo
- may be downloaded from the Maven repository
- manual
- user must manually download and install the dependency.
-
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
name
String name
The full legal name of the license. -
url
String url
The official url for the license text.
-
-
-
Class org.apache.maven.api.model.MailingList
class MailingList extends Object implements Serializable-
Serialized Fields
-
archive
String archive
The link to a URL where you can browse the mailing list archive. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
name
String name
The name of the mailing list. -
otherArchives
List<String> otherArchives
The link to alternate URLs where you can browse the list archive. -
post
String post
The email address or link that can be used to post to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created. -
subscribe
String subscribe
The email address or link that can be used to subscribe to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created. -
unsubscribe
String unsubscribe
The email address or link that can be used to unsubscribe to the mailing list. If this is an email address, amailto:
link will automatically be created when the documentation is created.
-
-
-
Class org.apache.maven.api.model.Model
class Model extends ModelBase implements Serializable-
Serialized Fields
-
artifactId
String artifactId
The identifier for this artifact that is unique within the group given by the group ID. An artifact is something that is either produced or used by a project. Examples of artifacts produced by Maven for a project include: JARs, source and binary distributions, and WARs. -
build
Build build
Information required to build the project. -
childProjectUrlInheritAppendPath
String childProjectUrlInheritAppendPath
When children inherit from project's url, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:
true
- Since:
- Maven 3.6.1
-
ciManagement
CiManagement ciManagement
The project's continuous integration information. -
contributors
List<Contributor> contributors
Describes the contributors to a project that are not yet committers. -
description
String description
A detailed description of the project, used by Maven whenever it needs to describe the project, such as on the website. While this element can be specified as CDATA to enable the use of HTML tags within the description, it is discouraged to allow plain text representation. If you need to modify the index page of the generated website, you are able to specify your own instead of adjusting this text. -
developers
List<Developer> developers
Describes the committers of a project. -
groupId
String groupId
A universally unique identifier for a project. It is normal to use a fully-qualified package name to distinguish it from other projects with a similar name (eg.org.apache.maven
). -
inceptionYear
String inceptionYear
The year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational. -
issueManagement
IssueManagement issueManagement
The project's issue management system information. -
licenses
List<License> licenses
This element describes all the licenses for this project. Each license is described by alicense
element, which is then described by additional elements. Projects should only list the license(s) that applies to the project and not the licenses that apply to dependencies. If multiple licenses are listed, it is assumed that the user can select any of them, not that they must accept all. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
mailingLists
List<MailingList> mailingLists
Contains information about a project's mailing lists. -
modelEncoding
String modelEncoding
-
modelVersion
String modelVersion
Declares to which version of project descriptor this POM conforms. -
name
String name
The full name of the project. -
namespaceUri
String namespaceUri
-
organization
Organization organization
This element describes various attributes of the organization to which the project belongs. These attributes are utilized when documentation is created (for copyright notices and links). -
packaging
String packaging
The type of artifact this project produces, for examplejar
,war
,ear
,pom
. Plugins can create their own packaging, and therefore their own packaging types, so this list does not contain all possible types. -
parent
Parent parent
The location of the parent project, if one exists. Values from the parent project will be the default for this project if they are left unspecified. The location is given as a group ID, artifact ID and version. -
pomFile
Path pomFile
Originating POM file -
prerequisites
Prerequisites prerequisites
Describes the prerequisites in the build environment for this project. -
preserveModelVersion
boolean preserveModelVersion
Indicates if the build POM for this project should be preserved or downgraded to the lowest compatible version.- Since:
- Maven 4.0.0
-
profiles
List<Profile> profiles
A listing of project-local build profiles which will modify the build process when activated. -
root
boolean root
Indicates that this project is the root project, located in the upper directory of the source tree. This is the directory which may contain the .mvn directory.- Since:
- Maven 4.0.0
-
scm
Scm scm
Specification for the SCM used by the project, such as CVS, Subversion, etc. -
url
String url
The URL to the project's homepage.Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if project's
child.project.url.inherit.append.path="false"
-
version
String version
The current version of the artifact produced by this project.
-
-
-
Class org.apache.maven.api.model.ModelBase
class ModelBase extends Object implements Serializable-
Serialized Fields
-
dependencies
List<Dependency> dependencies
This element describes all the dependencies associated with a project. These dependencies are used to construct a classpath for your project during the build process. They are automatically downloaded from the repositories defined in this project.- See Also:
-
dependencyManagement
DependencyManagement dependencyManagement
Default dependency information for projects that inherit from this one. The dependencies in this section are not immediately resolved. Instead, when a POM derived from this one declares a dependency described by a matching groupId and artifactId, the version and other values from this section are used for that dependency if they were not already specified. -
distributionManagement
DistributionManagement distributionManagement
Distribution information for a project that enables deployment of the site and artifacts to remote web servers and repositories respectively. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
modules
List<String> modules
Deprecated. -
pluginRepositories
List<Repository> pluginRepositories
The lists of the remote repositories for discovering plugins for builds and reports. -
properties
Map<String,
String> properties Properties that can be used throughout the POM as a substitution, and are used as filters in resources if enabled. The format is<name>value</name>
. -
reporting
Reporting reporting
This element includes the specification of report plugins to use to generate the reports on the Maven-generated site. These reports will be run when a user executesmvn site
. All the reports will be included in the navigation bar for browsing. -
repositories
List<Repository> repositories
The lists of the remote repositories for discovering dependencies and extensions. -
subprojects
List<String> subprojects
The subprojects (formerly called modules) to build as a part of this project. Each subproject listed is a relative path to the directory containing the subproject. To be consistent with the way default URLs are calculated from parent, it is recommended to have subproject names match artifact ids.
-
-
-
Class org.apache.maven.api.model.Notifier
class Notifier extends Object implements Serializable-
Serialized Fields
-
address
String address
Deprecated.Where to send the notification to - eg email address. -
configuration
Map<String,
String> configuration Extended configuration specific to this notifier goes here. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
sendOnError
boolean sendOnError
Whether to send notifications on error. -
sendOnFailure
boolean sendOnFailure
Whether to send notifications on failure. -
sendOnSuccess
boolean sendOnSuccess
Whether to send notifications on success. -
sendOnWarning
boolean sendOnWarning
Whether to send notifications on warning. -
type
String type
The mechanism used to deliver notifications.
-
-
-
Class org.apache.maven.api.model.Organization
class Organization extends Object implements Serializable-
Serialized Fields
-
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
name
String name
The full name of the organization. -
url
String url
The URL to the organization's home page.
-
-
-
Class org.apache.maven.api.model.Parent
class Parent extends Object implements Serializable-
Serialized Fields
-
artifactId
String artifactId
The artifact id of the parent project to inherit from. -
groupId
String groupId
The group id of the parent project to inherit from. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
relativePath
String relativePath
The relative path of the parent subproject POM file or directory within the checkout. If not specified, it defaults to..
, i.e. the parent directory. Maven looks for the parent POM first in this location on the filesystem if explicitly provided, then in the reactor if groupId and artifactId are provided, then in the default parent directory, then the local repository, and lastly in the remote repo. However, if the both relative path and the group ID / artifact ID are provided, they must match the file in the location given. Specify either therelativePath
or thegroupId
/artifactId
, not both. -
version
String version
The version of the parent project to inherit.
-
-
-
Class org.apache.maven.api.model.PatternSet
class PatternSet extends Object implements Serializable-
Serialized Fields
-
excludes
List<String> excludes
A list of patterns to exclude, e.g.**/*.xml
-
importedFrom
InputLocation importedFrom
Location tracking -
includes
List<String> includes
A list of patterns to include, e.g.**/*.xml
. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class)
-
-
-
Class org.apache.maven.api.model.Plugin
class Plugin extends ConfigurationContainer implements Serializable-
Serialized Fields
-
artifactId
String artifactId
The artifact ID of the plugin in the repository. -
dependencies
List<Dependency> dependencies
Additional dependencies that this project needs to introduce to the plugin's classloader. -
executions
List<PluginExecution> executions
Multiple specifications of a set of goals to execute during the build lifecycle, each having (possibly) a different configuration. -
extensions
String extensions
Whether to load Maven extensions (such as packaging and type handlers) from this plugin. For performance reasons, this should only be enabled when necessary. Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
. Default value isfalse
. -
groupId
String groupId
The group ID of the plugin in the repository. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
version
String version
The version (or valid range of versions) of the plugin to be used.
-
-
-
Class org.apache.maven.api.model.PluginConfiguration
class PluginConfiguration extends PluginContainer implements Serializable-
Serialized Fields
-
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
pluginManagement
PluginManagement pluginManagement
Default plugin information to be made available for reference by projects derived from this one. This plugin configuration will not be resolved or bound to the lifecycle unless referenced. Any local configuration for a given plugin will override the plugin's entire definition here.
-
-
-
Class org.apache.maven.api.model.PluginContainer
class PluginContainer extends Object implements Serializable-
Serialized Fields
-
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
pluginMap
Map<String,
Plugin> pluginMap -
plugins
List<Plugin> plugins
The list of plugins to use.
-
-
-
Class org.apache.maven.api.model.PluginExecution
class PluginExecution extends ConfigurationContainer implements Serializable-
Serialized Fields
-
goals
List<String> goals
The goals to execute with the given configuration. -
id
String id
The identifier of this execution for labelling the goals during the build, and for matching executions to merge during inheritance and profile injection. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
phase
String phase
The build lifecycle phase to bind the goals in this execution to. If omitted, the goals will be bound to the default phase specified by the plugin. -
priority
int priority
The priority of this execution compared to other executions which are bound to the same phase.Warning: This is an internal utility property that is only public for technical reasons, it is not part of the public API. In particular, this property can be changed or deleted without prior notice.
-
-
-
Class org.apache.maven.api.model.PluginManagement
class PluginManagement extends PluginContainer implements Serializable-
Serialized Fields
-
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class)
-
-
-
Class org.apache.maven.api.model.Prerequisites
class Prerequisites extends Object implements Serializable-
Serialized Fields
-
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
maven
String maven
For a plugin project (packaging ismaven-plugin
), the minimum version of Maven required to use the resulting plugin.
In Maven 2, this was also specifying the minimum version of Maven required to build a project, but this usage is deprecated in Maven 3 and not checked any more: use the Maven Enforcer Plugin'srequireMavenVersion
rule instead.
-
-
-
Class org.apache.maven.api.model.Profile
class Profile extends ModelBase implements Serializable-
Serialized Fields
-
activation
Activation activation
The conditional logic which will automatically trigger the inclusion of this profile. -
build
BuildBase build
Information required to build the project. -
id
String id
The identifier of this build profile. This is used for command line activation, and identifies profiles to be merged. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
source
String source
-
-
-
Class org.apache.maven.api.model.Relocation
class Relocation extends Object implements Serializable-
Serialized Fields
-
artifactId
String artifactId
The new artifact ID of the artifact. -
groupId
String groupId
The group ID the artifact has moved to. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
message
String message
An additional message to show the user about the move, such as the reason. -
version
String version
The new version of the artifact.
-
-
-
Class org.apache.maven.api.model.Reporting
class Reporting extends Object implements Serializable-
Serialized Fields
-
excludeDefaults
String excludeDefaults
If true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu. Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
. Default value isfalse
. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
outputDirectory
String outputDirectory
Where to store all the generated reports. The default is${project.build.directory}/site
. -
plugins
List<ReportPlugin> plugins
The reporting plugins to use and their configuration.
-
-
-
Class org.apache.maven.api.model.ReportPlugin
class ReportPlugin extends ConfigurationContainer implements Serializable-
Serialized Fields
-
artifactId
String artifactId
The artifact ID of the reporting plugin in the repository. -
groupId
String groupId
The group ID of the reporting plugin in the repository. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
reportSetMap
Map<String,
ReportSet> reportSetMap -
reportSets
List<ReportSet> reportSets
Multiple specifications of a set of reports, each having (possibly) different configuration. This is the reporting parallel to anexecution
in the build. -
version
String version
The version of the reporting plugin to be used. Starting with Maven 3, if no version is defined explicitly, version is searched inbuild/plugins
then inbuild/pluginManagement
.
-
-
-
Class org.apache.maven.api.model.ReportSet
class ReportSet extends ConfigurationContainer implements Serializable-
Serialized Fields
-
id
String id
The unique id for this report set, to be used during POM inheritance and profile injection for merging of report sets. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
reports
List<String> reports
The list of reports from this plugin which should be generated from this set.
-
-
-
Class org.apache.maven.api.model.Repository
class Repository extends RepositoryBase implements Serializable-
Serialized Fields
-
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
releases
RepositoryPolicy releases
How to handle downloading of releases from this repository. -
snapshots
RepositoryPolicy snapshots
How to handle downloading of snapshots from this repository.
-
-
-
Class org.apache.maven.api.model.RepositoryBase
class RepositoryBase extends Object implements Serializable-
Serialized Fields
-
id
String id
A unique identifier for a repository. This is used to match the repository to configuration in thesettings.xml
file, for example. Furthermore, the identifier is used during POM inheritance and profile injection to detect repositories that should be merged. -
importedFrom
InputLocation importedFrom
Location tracking -
layout
String layout
The type of layout this repository uses for locating and storing artifacts - can belegacy
ordefault
. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
name
String name
Human readable name of the repository. -
url
String url
The url of the repository, in the formprotocol://hostname/path
.
-
-
-
Class org.apache.maven.api.model.RepositoryPolicy
class RepositoryPolicy extends Object implements Serializable-
Serialized Fields
-
checksumPolicy
String checksumPolicy
What to do when verification of an artifact checksum fails. Valid values areignore
,fail
(default for Maven 4 and above) orwarn
(default for Maven 2 and 3). -
enabled
String enabled
Whether to use this repository for downloading this type of artifact. Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
. Default value istrue
. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
updatePolicy
String updatePolicy
The frequency for downloading updates - can bealways
,daily
(default),interval:XXX
(in minutes) ornever
(only if it doesn't exist locally).
-
-
-
Class org.apache.maven.api.model.Resource
class Resource extends FileSet implements Serializable-
Serialized Fields
-
filtering
String filtering
Whether resources are filtered to replace tokens with parameterised values or not. The values are taken from theproperties
element and from the properties in the files listed in thefilters
element. Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
. Default value isfalse
. -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
mergeId
String mergeId
FOR INTERNAL USE ONLY. This is a unique identifier assigned to each resource to allow Maven to merge changes to this resource that take place during the execution of a plugin. This field must be managed by the generated parser and formatter classes in order to allow it to survive model interpolation. -
targetPath
String targetPath
Describe the resource target path. The path is relative to the target/classes directory (i.e.${project.build.outputDirectory}
). For example, if you want that resource to appear in a specific package (org.apache.maven.messages
), you must specify this element with this value:org/apache/maven/messages
. This is not required if you simply put the resources in that directory structure at the source, however.
-
-
-
Class org.apache.maven.api.model.Scm
class Scm extends Object implements Serializable-
Serialized Fields
-
childScmConnectionInheritAppendPath
String childScmConnectionInheritAppendPath
When children inherit from scm connection, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:
true
- Since:
- Maven 3.6.1
-
childScmDeveloperConnectionInheritAppendPath
String childScmDeveloperConnectionInheritAppendPath
When children inherit from scm developer connection, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:
true
- Since:
- Maven 3.6.1
-
childScmUrlInheritAppendPath
String childScmUrlInheritAppendPath
When children inherit from scm url, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:true
- Since:
- Maven 3.6.1
-
connection
String connection
The source control management system URL that describes the repository and how to connect to the repository. This connection is read-only.
Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if scm'schild.scm.connection.inherit.append.path="false"
- See Also:
-
developerConnection
String developerConnection
Just likeconnection
, but for developers, i.e. this scm connection will not be read only.Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if scm's
child.scm.developerConnection.inherit.append.path="false"
. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
tag
String tag
The tag of current code. By default, it's set to HEAD during development. -
url
String url
The URL to the project's browsable SCM repository, such as ViewVC or Fisheye.Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if scm's
child.scm.url.inherit.append.path="false"
-
-
-
Class org.apache.maven.api.model.Site
class Site extends Object implements Serializable-
Serialized Fields
-
childSiteUrlInheritAppendPath
String childSiteUrlInheritAppendPath
When children inherit from distribution management site url, append path or not? Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
Default value is:
true
- Since:
- Maven 3.6.1
-
id
String id
A unique identifier for a deployment location. This is used to match the site to configuration in thesettings.xml
file, for example. -
importedFrom
InputLocation importedFrom
Location tracking -
locations
Map<Object,
InputLocation> locations Locations (this potentially hides the same name field from the super class) -
name
String name
Human readable name of the deployment location. -
url
String url
The url of the location where website is deployed, in the formprotocol://hostname/path
.Default value is: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if site's
child.site.url.inherit.append.path="false"
.
-
-
-
ModelBase.subprojects
instead.