org.apache.maven.model
Class ModelBase

java.lang.Object
  org.apache.maven.model.ModelBase

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

Direct Known Subclasses:

Model, Profile

public class ModelBase
extends Object
implements Serializable, Cloneable, InputLocationTracker

Base class for the Model and the Profile objects.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ModelBase()

Method Summary

void	addDependency(Dependency dependency) Method addDependency.
void	addModule(String string) Method addModule.
void	addPluginRepository(Repository repository) Method addPluginRepository.
void	addProperty(String key, String value) Method addProperty.
void	addRepository(Repository repository) Method addRepository.
ModelBase	clone() Method clone.
List<Dependency>	getDependencies() Method getDependencies.
DependencyManagement	getDependencyManagement() Get default dependency information for projects that inherit from this one.
DistributionManagement	getDistributionManagement() Get distribution information for a project that enables deployment of the site and artifacts to remote web servers and repositories respectively.
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
List<String>	getModules() Method getModules.
List<Repository>	getPluginRepositories() Method getPluginRepositories.
Properties	getProperties() Method getProperties.
Reporting	getReporting() Get this element includes the specification of report plugins to use to generate the reports on the Maven-generated site.
Object	getReports() Get Deprecated.
List<Repository>	getRepositories() Method getRepositories.
void	removeDependency(Dependency dependency) Method removeDependency.
void	removeModule(String string) Method removeModule.
void	removePluginRepository(Repository repository) Method removePluginRepository.
void	removeRepository(Repository repository) Method removeRepository.
void	setDependencies(List<Dependency> dependencies) Set this element describes all of the dependencies associated with a project.
void	setDependencyManagement(DependencyManagement dependencyManagement) Set default dependency information for projects that inherit from this one.
void	setDistributionManagement(DistributionManagement distributionManagement) Set distribution information for a project that enables deployment of the site and artifacts to remote web servers and repositories respectively.
void	setLocation(Object key, InputLocation location) Sets the location of the specified field.
void	setModules(List<String> modules) Set the modules (sometimes called subprojects) to build as a part of this project.
void	setPluginRepositories(List<Repository> pluginRepositories) Set the lists of the remote repositories for discovering plugins for builds and reports.
void	setProperties(Properties properties) Set properties that can be used throughout the POM as a substitution, and are used as filters in resources if enabled.
void	setReporting(Reporting reporting) Set this element includes the specification of report plugins to use to generate the reports on the Maven-generated site.
void	setReports(Object reports) Set Deprecated.
void	setRepositories(List<Repository> repositories) Set the lists of the remote repositories for discovering dependencies and extensions.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelBase

public ModelBase()

Method Detail

addDependency

public void addDependency(Dependency dependency)

Method addDependency.

Parameters:

dependency -

addModule

public void addModule(String string)

Method addModule.

Parameters:

string -

addPluginRepository

public void addPluginRepository(Repository repository)

Method addPluginRepository.

Parameters:

repository -

addProperty

public void addProperty(String key,
                        String value)

Method addProperty.

Parameters:

key -

value -

addRepository

public void addRepository(Repository repository)

Method addRepository.

Parameters:

repository -

clone

public ModelBase clone()

Method clone.

Overrides:

clone in class Object

Returns:

ModelBase

getDependencies

public List<Dependency> getDependencies()

Method getDependencies.

Returns:

List

getDependencyManagement

public DependencyManagement getDependencyManagement()

Get 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.

Returns:

DependencyManagement

getDistributionManagement

public DistributionManagement getDistributionManagement()

Get distribution information for a project that enables deployment of the site and artifacts to remote web servers and repositories respectively.

Returns:

DistributionManagement

getLocation

public InputLocation getLocation(Object key)

Description copied from interface: InputLocationTracker

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

Parameters:

key -

Returns:

InputLocation

getModules

public List<String> getModules()

Method getModules.

Returns:

List

getPluginRepositories

public List<Repository> getPluginRepositories()

Method getPluginRepositories.

Returns:

List

getProperties

public Properties getProperties()

Method getProperties.

Returns:

Properties

getReporting

public Reporting getReporting()

Get 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 executes mvn site. All of the reports will be included in the navigation bar for browsing.

Returns:

Reporting

getReports

public Object getReports()

Get Deprecated. Now ignored by Maven.

Returns:

Object

getRepositories

public List<Repository> getRepositories()

Method getRepositories.

Returns:

List

removeDependency

public void removeDependency(Dependency dependency)

Method removeDependency.

Parameters:

dependency -

removeModule

public void removeModule(String string)

Method removeModule.

Parameters:

string -

removePluginRepository

public void removePluginRepository(Repository repository)

Method removePluginRepository.

Parameters:

repository -

removeRepository

public void removeRepository(Repository repository)

Method removeRepository.

Parameters:

repository -

setDependencies

public void setDependencies(List<Dependency> dependencies)

Set this element describes all of 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 the dependency mechanism for more information.

Parameters:

dependencies -

setDependencyManagement

public void setDependencyManagement(DependencyManagement dependencyManagement)

Set 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.

Parameters:

dependencyManagement -

setDistributionManagement

public void setDistributionManagement(DistributionManagement distributionManagement)

Set distribution information for a project that enables deployment of the site and artifacts to remote web servers and repositories respectively.

Parameters:

distributionManagement -

setLocation

public void setLocation(Object key,
                        InputLocation location)

Description copied from interface: InputLocationTracker

Sets the location of the specified field.

Specified by:

setLocation in interface InputLocationTracker

Parameters:

key -

location -

setModules

public void setModules(List<String> modules)

Set the modules (sometimes called subprojects) to build as a part of this project. Each module listed is a relative path to the directory containing the module.

Parameters:

modules -

setPluginRepositories

public void setPluginRepositories(List<Repository> pluginRepositories)

Set the lists of the remote repositories for discovering plugins for builds and reports.

Parameters:

pluginRepositories -

setProperties

public void setProperties(Properties properties)

Set 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>.

Parameters:

properties -

setReporting

public void setReporting(Reporting reporting)

Set 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 executes mvn site. All of the reports will be included in the navigation bar for browsing.

Parameters:

reporting -

setReports

public void setReports(Object reports)

Set Deprecated. Now ignored by Maven.

Parameters:

reports -

setRepositories

public void setRepositories(List<Repository> repositories)

Set the lists of the remote repositories for discovering dependencies and extensions.

Parameters:

repositories -