org.apache.maven.model.Parent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-realer Show documentation
With inspiration from other libraries
There is a newer version: 5.17.0
/*
 =================== DO NOT EDIT THIS FILE ====================
 Generated by Modello 1.0.1 on 2009-08-06 15:13:09,
 any modifications will be overwritten.
 ==============================================================
 */

package org.apache.maven.model;

/**
 * 
 *         
 *         The <parent> element contains
 * informations required to the parent project.
 *         
 *       
 * 
 * @version $Revision$ $Date$
 */
public class Parent
    implements java.io.Serializable
{

      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * The artifact id of the parent project to inherit from.
     */
    private String artifactId;

    /**
     * The group id of the parent project to inherit from.
     */
    private String groupId;

    /**
     * The version of the parent project to inherit.
     */
    private String version;

    /**
     * 
     *             
     *             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.
     *             
     *           
     */
    private String relativePath = "../pom.xml";


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * Get the artifact id of the parent project to inherit from.
     * 
     * @return String
     */
    public String getArtifactId()
    {
        return this.artifactId;
    } //-- String getArtifactId()

    /**
     * Get the group id of the parent project to inherit from.
     * 
     * @return String
     */
    public String getGroupId()
    {
        return this.groupId;
    } //-- String getGroupId()

    /**
     * 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.
     * 
     * @return String
     */
    public String getRelativePath()
    {
        return this.relativePath;
    } //-- String getRelativePath()

    /**
     * Get the version of the parent project to inherit.
     * 
     * @return String
     */
    public String getVersion()
    {
        return this.version;
    } //-- String getVersion()

    /**
     * Set the artifact id of the parent project to inherit from.
     * 
     * @param artifactId
     */
    public void setArtifactId( String artifactId )
    {
        this.artifactId = artifactId;
    } //-- void setArtifactId( String )

    /**
     * Set the group id of the parent project to inherit from.
     * 
     * @param groupId
     */
    public void setGroupId( String groupId )
    {
        this.groupId = groupId;
    } //-- void setGroupId( String )

    /**
     * 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.
     * 
     * @param relativePath
     */
    public void setRelativePath( String relativePath )
    {
        this.relativePath = relativePath;
    } //-- void setRelativePath( String )

    /**
     * Set the version of the parent project to inherit.
     * 
     * @param version
     */
    public void setVersion( String version )
    {
        this.version = version;
    } //-- void setVersion( String )


            
    /**
     * @return the id as groupId:artifactId:version
     */
    public String getId()
    {
        StringBuffer id = new StringBuffer();

        id.append( getGroupId() );
        id.append( ":" );
        id.append( getArtifactId() );
        id.append( ":" );
        id.append( "pom" );
      //  id.append( getPackaging() );
        id.append( ":" );
        id.append( getVersion() );

        return id.toString();
    }
            
          
}