org.apache.maven.model
Class Parent

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

All Implemented Interfaces:

Serializable

public class Parent
extends Object
implements Serializable

The <parent> element contains informations required to the parent project.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Parent()

Method Summary

String	getArtifactId() Get the artifact id of the parent project to inherit from.
String	getGroupId() Get the group id of the parent project to inherit from.
String	getId()
String	getModelEncoding()
String	getRelativePath() Get The relative path of the parent pom.xml file within the check out.
String	getVersion() Get the version of the parent project to inherit.
void	setArtifactId(String artifactId) Set the artifact id of the parent project to inherit from.
void	setGroupId(String groupId) Set the group id of the parent project to inherit from.
void	setModelEncoding(String modelEncoding) Set an encoding used for reading/writing the model.
void	setRelativePath(String relativePath) Set The relative path of the parent pom.xml file within the check out.
void	setVersion(String version) Set the version of the parent project to inherit.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parent

public Parent()

Method Detail

getArtifactId

public String getArtifactId()

Get the artifact id of the parent project to inherit from.

Returns:

String

getGroupId

public String getGroupId()

Get the group id of the parent project to inherit from.

Returns:

String

getRelativePath

public String getRelativePath()

Get The relative path of the parent pom.xml file within the check out. The default value is ../pom.xml. Maven looks for the parent pom first in the reactor of currently building projects, then in this location on the filesystem, then the local repository, and lastly in the remote repo. relativePath allows you to select a different location, for example when your structure is flat, or deeper without an intermediate parent pom. However, the group ID, artifact ID and version are still required, and must match the file in the location given or it will revert to the repository for the POM. This feature is only for enhancing the development in a local checkout of that project.

Returns:

String

getVersion

public String getVersion()

Get the version of the parent project to inherit.

Returns:

String

setArtifactId

public void setArtifactId(String artifactId)

Set the artifact id of the parent project to inherit from.

Parameters:

artifactId -

setGroupId

public void setGroupId(String groupId)

Set the group id of the parent project to inherit from.

Parameters:

groupId -

setRelativePath

public void setRelativePath(String relativePath)

Set The relative path of the parent pom.xml file within the check out. The default value is ../pom.xml. Maven looks for the parent pom first in the reactor of currently building projects, then in this location on the filesystem, then the local repository, and lastly in the remote repo. relativePath allows you to select a different location, for example when your structure is flat, or deeper without an intermediate parent pom. However, the group ID, artifact ID and version are still required, and must match the file in the location given or it will revert to the repository for the POM. This feature is only for enhancing the development in a local checkout of that project.

Parameters:

relativePath -

setVersion

public void setVersion(String version)

Set the version of the parent project to inherit.

Parameters:

version -

getId

public String getId()

Returns:

the id as groupId:artifactId:version

setModelEncoding

public void setModelEncoding(String modelEncoding)

Set an encoding used for reading/writing the model.

Parameters:

modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public String getModelEncoding()

Returns:

the current encoding used when reading/writing this model.