Class Model

  • All Implemented Interfaces:
    java.io.Serializable

    public class Model
    extends ModelBase
    implements java.io.Serializable
    The <project> element is the root of the descriptor. The following table lists all of the possible child elements.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      Model()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addBranch​(Branch branch)
      Method addBranch.
      void addContributor​(Contributor contributor)
      Method addContributor.
      void addDeveloper​(Developer developer)
      Method addDeveloper.
      void addLicense​(License license)
      Method addLicense.
      void addMailingList​(MailingList mailingList)
      Method addMailingList.
      void addPackageGroup​(PackageGroup packageGroup)
      Method addPackageGroup.
      void addProperty​(java.lang.String key, java.lang.String value)
      Method addProperty.
      void addReport​(java.lang.String string)
      Method addReport.
      void addVersion​(Version version)
      Method addVersion.
      java.lang.String getArtifactId()
      Get the identifier for this artifact that is unique within the group given by the group ID.
      java.util.List<Branch> getBranches()
      Method getBranches.
      Build getBuild()
      Get information required to build the project.
      java.util.List<Contributor> getContributors()
      Method getContributors.
      java.lang.String getCurrentVersion()
      Get the current version of the artifact produced by this project.
      java.lang.String getDescription()
      Get a detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site.
      java.util.List<Developer> getDevelopers()
      Method getDevelopers.
      java.lang.String getDistributionDirectory()
      Get the directory on the web server where the final distributions will be published.
      java.lang.String getDistributionSite()
      Get the server where the final distributions will be published.
      java.lang.String getExtend()
      Get the location of the parent project, if one exists.
      java.lang.String getGroupId()
      Get a universally unique identifier for a project.
      java.lang.String getGumpRepositoryId()
      Get this is the repository identifier in Gump that this project is part of.
      java.lang.String getId()
      Get Deprecated.
      java.lang.String getInceptionYear()
      Get the year of the project's inception, specified with 4 digits.
      java.lang.String getIssueTrackingUrl()
      Get the URL of the project's issue tracking system.
      java.util.List<License> getLicenses()
      Method getLicenses.
      java.lang.String getLogo()
      Get the URL of the project's logo image.
      java.util.List<MailingList> getMailingLists()
      Method getMailingLists.
      java.lang.String getModelEncoding()
      Get the modelEncoding field.
      java.lang.String getName()
      Get the full name of the project.
      Organization getOrganization()
      Get this element describes various attributes of the organization to which the project belongs.
      java.lang.String getPackage()  
      java.util.List<PackageGroup> getPackageGroups()
      Method getPackageGroups.
      java.lang.String getPackageName()
      Get the Java package name of the project.
      java.lang.String getPomVersion()
      Get declares to which version of project descriptor this POM conforms.
      java.util.Properties getProperties()
      Method getProperties.
      java.util.List<java.lang.String> getReports()
      Method getReports.
      Repository getRepository()
      Get specification for the SCM used by the project, such as CVS, Subversion, etc.
      java.lang.String getShortDescription()
      Get a short description of the project.
      java.lang.String getSiteAddress()
      Get the hostname of the web server that hosts the project's web site.
      java.lang.String getSiteDirectory()
      Get the directory on the web server where the public web site for this project resides.
      java.lang.String getUrl()
      Get the URL to the project's homepage.
      java.lang.String getVersion()  
      java.util.List<Version> getVersions()
      Method getVersions.
      void removeBranch​(Branch branch)
      Method removeBranch.
      void removeContributor​(Contributor contributor)
      Method removeContributor.
      void removeDeveloper​(Developer developer)
      Method removeDeveloper.
      void removeLicense​(License license)
      Method removeLicense.
      void removeMailingList​(MailingList mailingList)
      Method removeMailingList.
      void removePackageGroup​(PackageGroup packageGroup)
      Method removePackageGroup.
      void removeReport​(java.lang.String string)
      Method removeReport.
      void removeVersion​(Version version)
      Method removeVersion.
      void setArtifactId​(java.lang.String artifactId)
      Set the identifier for this artifact that is unique within the group given by the group ID.
      void setBranches​(java.util.List<Branch> branches)
      Set contains information on SCM branches of the project.
      void setBuild​(Build build)
      Set information required to build the project.
      void setContributors​(java.util.List<Contributor> contributors)
      Set describes the contributors to a project that are not yet committers.
      void setCurrentVersion​(java.lang.String currentVersion)
      Set the current version of the artifact produced by this project.
      void setDescription​(java.lang.String description)
      Set a detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site.
      void setDevelopers​(java.util.List<Developer> developers)
      Set describes the committers of a project.
      void setDistributionDirectory​(java.lang.String distributionDirectory)
      Set the directory on the web server where the final distributions will be published.
      void setDistributionSite​(java.lang.String distributionSite)
      Set the server where the final distributions will be published.
      void setExtend​(java.lang.String extend)
      Set the location of the parent project, if one exists.
      void setGroupId​(java.lang.String groupId)
      Set a universally unique identifier for a project.
      void setGumpRepositoryId​(java.lang.String gumpRepositoryId)
      Set this is the repository identifier in Gump that this project is part of.
      void setId​(java.lang.String id)
      Set Deprecated.
      void setInceptionYear​(java.lang.String inceptionYear)
      Set the year of the project's inception, specified with 4 digits.
      void setIssueTrackingUrl​(java.lang.String issueTrackingUrl)
      Set the URL of the project's issue tracking system.
      void setLicenses​(java.util.List<License> licenses)
      Set this element describes all of the licenses for this project.
      void setLogo​(java.lang.String logo)
      Set the URL of the project's logo image.
      void setMailingLists​(java.util.List<MailingList> mailingLists)
      Set contains information about a project's mailing lists.
      void setModelEncoding​(java.lang.String modelEncoding)
      Set the modelEncoding field.
      void setName​(java.lang.String name)
      Set the full name of the project.
      void setOrganization​(Organization organization)
      Set this element describes various attributes of the organization to which the project belongs.
      void setPackage​(java.lang.String packageName)  
      void setPackageGroups​(java.util.List<PackageGroup> packageGroups)
      Set package groups required for complete javadocs.
      void setPackageName​(java.lang.String packageName)
      Set the Java package name of the project.
      void setPomVersion​(java.lang.String pomVersion)
      Set declares to which version of project descriptor this POM conforms.
      void setProperties​(java.util.Properties properties)
      Set project properties that will be used by various plugins.
      void setReports​(java.util.List<java.lang.String> reports)
      Set this element includes the specification of reports to be included in a Maven-generated site.
      void setRepository​(Repository repository)
      Set specification for the SCM used by the project, such as CVS, Subversion, etc.
      void setShortDescription​(java.lang.String shortDescription)
      Set a short description of the project.
      void setSiteAddress​(java.lang.String siteAddress)
      Set the hostname of the web server that hosts the project's web site.
      void setSiteDirectory​(java.lang.String siteDirectory)
      Set the directory on the web server where the public web site for this project resides.
      void setUrl​(java.lang.String url)
      Set the URL to the project's homepage.
      void setVersion​(java.lang.String version)  
      void setVersions​(java.util.List<Version> versions)
      Set contains information on previous versions of the project.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Model

        public Model()
    • Method Detail

      • addBranch

        public void addBranch​(Branch branch)
        Method addBranch.
        Parameters:
        branch - a branch object.
      • addContributor

        public void addContributor​(Contributor contributor)
        Method addContributor.
        Parameters:
        contributor - a contributor object.
      • addDeveloper

        public void addDeveloper​(Developer developer)
        Method addDeveloper.
        Parameters:
        developer - a developer object.
      • addLicense

        public void addLicense​(License license)
        Method addLicense.
        Parameters:
        license - a license object.
      • addMailingList

        public void addMailingList​(MailingList mailingList)
        Method addMailingList.
        Parameters:
        mailingList - a mailingList object.
      • addPackageGroup

        public void addPackageGroup​(PackageGroup packageGroup)
        Method addPackageGroup.
        Parameters:
        packageGroup - a packageGroup object.
      • addProperty

        public void addProperty​(java.lang.String key,
                                java.lang.String value)
        Method addProperty.
        Parameters:
        key - a key object.
        value - a value object.
      • addReport

        public void addReport​(java.lang.String string)
        Method addReport.
        Parameters:
        string - a string object.
      • addVersion

        public void addVersion​(Version version)
        Method addVersion.
        Parameters:
        version - a version object.
      • getArtifactId

        public java.lang.String getArtifactId()
        Get 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.
        Returns:
        String
      • getBranches

        public java.util.List<Branch> getBranches()
        Method getBranches.
        Returns:
        List
      • getBuild

        public Build getBuild()
        Get information required to build the project.
        Returns:
        Build
      • getContributors

        public java.util.List<Contributor> getContributors()
        Method getContributors.
        Returns:
        List
      • getCurrentVersion

        public java.lang.String getCurrentVersion()
        Get the current version of the artifact produced by this project.
        Returns:
        String
      • getDescription

        public java.lang.String getDescription()
        Get a detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site. 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 web site, you are able to specify your own instead of adjusting this text.
        Returns:
        String
      • getDevelopers

        public java.util.List<Developer> getDevelopers()
        Method getDevelopers.
        Returns:
        List
      • getDistributionDirectory

        public java.lang.String getDistributionDirectory()
        Get the directory on the web server where the final distributions will be published. This is used when the distributions are deployed.
        Returns:
        String
      • getDistributionSite

        public java.lang.String getDistributionSite()
        Get the server where the final distributions will be published. This is used when the distributions are deployed. If this isn't defined, the central repository is used instead as determined by maven.repo.central and maven.repo.central.directory.
        Returns:
        String
      • getExtend

        public java.lang.String getExtend()
        Get 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 path may be absolute, or relative to the current project.xml file. For example, <extend>${basedir}/../project.xml</extend>.
        Returns:
        String
      • getGroupId

        public java.lang.String getGroupId()
        Get 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).
        Returns:
        String
      • getGumpRepositoryId

        public java.lang.String getGumpRepositoryId()
        Get this is the repository identifier in Gump that this project is part of.
        Returns:
        String
      • getId

        public java.lang.String getId()
        Get Deprecated. When used, this sets both the groupId and artifactId elements if they were previously empty.
        Returns:
        String
      • getInceptionYear

        public java.lang.String getInceptionYear()
        Get the year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational.
        Returns:
        String
      • getIssueTrackingUrl

        public java.lang.String getIssueTrackingUrl()
        Get the URL of the project's issue tracking system.
        Returns:
        String
      • getLicenses

        public java.util.List<License> getLicenses()
        Method getLicenses.
        Returns:
        List
      • getLogo

        public java.lang.String getLogo()
        Get the URL of the project's logo image. This can be an URL relative to the base directory of the generated web site, (e.g., /images/project-logo.png) or an absolute URL (e.g., http://my.corp/project-logo.png). This is used when generating the project documentation.
        Returns:
        String
      • getMailingLists

        public java.util.List<MailingList> getMailingLists()
        Method getMailingLists.
        Returns:
        List
      • getModelEncoding

        public java.lang.String getModelEncoding()
        Get the modelEncoding field.
        Returns:
        String
      • getName

        public java.lang.String getName()
        Get the full name of the project.
        Returns:
        String
      • getOrganization

        public Organization getOrganization()
        Get 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).
        Returns:
        Organization
      • getPackageGroups

        public java.util.List<PackageGroup> getPackageGroups()
        Method getPackageGroups.
        Returns:
        List
      • getPackageName

        public java.lang.String getPackageName()
        Get the Java package name of the project. This value is used when generating JavaDoc.
        Returns:
        String
      • getPomVersion

        public java.lang.String getPomVersion()
        Get declares to which version of project descriptor this POM conforms. The only valid value is 3.
        Returns:
        String
      • getProperties

        public java.util.Properties getProperties()
        Method getProperties.
        Returns:
        Properties
      • getReports

        public java.util.List<java.lang.String> getReports()
        Method getReports.
        Returns:
        List
      • getRepository

        public Repository getRepository()
        Get specification for the SCM used by the project, such as CVS, Subversion, etc.
        Returns:
        Repository
      • getShortDescription

        public java.lang.String getShortDescription()
        Get a short description of the project. The short description should be limited to a single line.
        Returns:
        String
      • getSiteAddress

        public java.lang.String getSiteAddress()
        Get the hostname of the web server that hosts the project's web site. This is used when the web site is deployed.
        Returns:
        String
      • getSiteDirectory

        public java.lang.String getSiteDirectory()
        Get the directory on the web server where the public web site for this project resides. This is used when the web site is deployed.
        Returns:
        String
      • getUrl

        public java.lang.String getUrl()
        Get the URL to the project's homepage.
        Returns:
        String
      • getVersions

        public java.util.List<Version> getVersions()
        Method getVersions.
        Returns:
        List
      • removeBranch

        public void removeBranch​(Branch branch)
        Method removeBranch.
        Parameters:
        branch - a branch object.
      • removeContributor

        public void removeContributor​(Contributor contributor)
        Method removeContributor.
        Parameters:
        contributor - a contributor object.
      • removeDeveloper

        public void removeDeveloper​(Developer developer)
        Method removeDeveloper.
        Parameters:
        developer - a developer object.
      • removeLicense

        public void removeLicense​(License license)
        Method removeLicense.
        Parameters:
        license - a license object.
      • removeMailingList

        public void removeMailingList​(MailingList mailingList)
        Method removeMailingList.
        Parameters:
        mailingList - a mailingList object.
      • removePackageGroup

        public void removePackageGroup​(PackageGroup packageGroup)
        Method removePackageGroup.
        Parameters:
        packageGroup - a packageGroup object.
      • removeReport

        public void removeReport​(java.lang.String string)
        Method removeReport.
        Parameters:
        string - a string object.
      • removeVersion

        public void removeVersion​(Version version)
        Method removeVersion.
        Parameters:
        version - a version object.
      • setArtifactId

        public void setArtifactId​(java.lang.String artifactId)
        Set 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.
        Parameters:
        artifactId - a artifactId object.
      • setBranches

        public void setBranches​(java.util.List<Branch> branches)
        Set contains information on SCM branches of the project.
        Parameters:
        branches - a branches object.
      • setBuild

        public void setBuild​(Build build)
        Set information required to build the project.
        Parameters:
        build - a build object.
      • setContributors

        public void setContributors​(java.util.List<Contributor> contributors)
        Set describes the contributors to a project that are not yet committers.
        Parameters:
        contributors - a contributors object.
      • setCurrentVersion

        public void setCurrentVersion​(java.lang.String currentVersion)
        Set the current version of the artifact produced by this project.
        Parameters:
        currentVersion - a currentVersion object.
      • setDescription

        public void setDescription​(java.lang.String description)
        Set a detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site. 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 web site, you are able to specify your own instead of adjusting this text.
        Parameters:
        description - a description object.
      • setDevelopers

        public void setDevelopers​(java.util.List<Developer> developers)
        Set describes the committers of a project.
        Parameters:
        developers - a developers object.
      • setDistributionDirectory

        public void setDistributionDirectory​(java.lang.String distributionDirectory)
        Set the directory on the web server where the final distributions will be published. This is used when the distributions are deployed.
        Parameters:
        distributionDirectory - a distributionDirectory object.
      • setDistributionSite

        public void setDistributionSite​(java.lang.String distributionSite)
        Set the server where the final distributions will be published. This is used when the distributions are deployed. If this isn't defined, the central repository is used instead as determined by maven.repo.central and maven.repo.central.directory.
        Parameters:
        distributionSite - a distributionSite object.
      • setExtend

        public void setExtend​(java.lang.String extend)
        Set 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 path may be absolute, or relative to the current project.xml file. For example, <extend>${basedir}/../project.xml</extend>.
        Parameters:
        extend - a extend object.
      • setGroupId

        public void setGroupId​(java.lang.String groupId)
        Set 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).
        Parameters:
        groupId - a groupId object.
      • setGumpRepositoryId

        public void setGumpRepositoryId​(java.lang.String gumpRepositoryId)
        Set this is the repository identifier in Gump that this project is part of.
        Parameters:
        gumpRepositoryId - a gumpRepositoryId object.
      • setId

        public void setId​(java.lang.String id)
        Set Deprecated. When used, this sets both the groupId and artifactId elements if they were previously empty.
        Parameters:
        id - a id object.
      • setInceptionYear

        public void setInceptionYear​(java.lang.String inceptionYear)
        Set the year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational.
        Parameters:
        inceptionYear - a inceptionYear object.
      • setIssueTrackingUrl

        public void setIssueTrackingUrl​(java.lang.String issueTrackingUrl)
        Set the URL of the project's issue tracking system.
        Parameters:
        issueTrackingUrl - a issueTrackingUrl object.
      • setLicenses

        public void setLicenses​(java.util.List<License> licenses)
        Set this element describes all of the licenses for this project. Each license is described by a license 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.
        Parameters:
        licenses - a licenses object.
      • setLogo

        public void setLogo​(java.lang.String logo)
        Set the URL of the project's logo image. This can be an URL relative to the base directory of the generated web site, (e.g., /images/project-logo.png) or an absolute URL (e.g., http://my.corp/project-logo.png). This is used when generating the project documentation.
        Parameters:
        logo - a logo object.
      • setMailingLists

        public void setMailingLists​(java.util.List<MailingList> mailingLists)
        Set contains information about a project's mailing lists.
        Parameters:
        mailingLists - a mailingLists object.
      • setModelEncoding

        public void setModelEncoding​(java.lang.String modelEncoding)
        Set the modelEncoding field.
        Parameters:
        modelEncoding - a modelEncoding object.
      • setName

        public void setName​(java.lang.String name)
        Set the full name of the project.
        Parameters:
        name - a name object.
      • setOrganization

        public void setOrganization​(Organization organization)
        Set 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).
        Parameters:
        organization - a organization object.
      • setPackageGroups

        public void setPackageGroups​(java.util.List<PackageGroup> packageGroups)
        Set package groups required for complete javadocs.
        Parameters:
        packageGroups - a packageGroups object.
      • setPackageName

        public void setPackageName​(java.lang.String packageName)
        Set the Java package name of the project. This value is used when generating JavaDoc.
        Parameters:
        packageName - a packageName object.
      • setPomVersion

        public void setPomVersion​(java.lang.String pomVersion)
        Set declares to which version of project descriptor this POM conforms. The only valid value is 3.
        Parameters:
        pomVersion - a pomVersion object.
      • setProperties

        public void setProperties​(java.util.Properties properties)
        Set project properties that will be used by various plugins. The format is <name>value</name>.
        Parameters:
        properties - a properties object.
      • setReports

        public void setReports​(java.util.List<java.lang.String> reports)
        Set this element includes the specification of reports to be included in a Maven-generated site. These reports will be run when a user executes maven site. All of the reports will be included in the navigation bar for browsing in the order they are specified.
        Parameters:
        reports - a reports object.
      • setRepository

        public void setRepository​(Repository repository)
        Set specification for the SCM used by the project, such as CVS, Subversion, etc.
        Parameters:
        repository - a repository object.
      • setShortDescription

        public void setShortDescription​(java.lang.String shortDescription)
        Set a short description of the project. The short description should be limited to a single line.
        Parameters:
        shortDescription - a shortDescription object.
      • setSiteAddress

        public void setSiteAddress​(java.lang.String siteAddress)
        Set the hostname of the web server that hosts the project's web site. This is used when the web site is deployed.
        Parameters:
        siteAddress - a siteAddress object.
      • setSiteDirectory

        public void setSiteDirectory​(java.lang.String siteDirectory)
        Set the directory on the web server where the public web site for this project resides. This is used when the web site is deployed.
        Parameters:
        siteDirectory - a siteDirectory object.
      • setUrl

        public void setUrl​(java.lang.String url)
        Set the URL to the project's homepage.
        Parameters:
        url - a url object.
      • setVersions

        public void setVersions​(java.util.List<Version> versions)
        Set contains information on previous versions of the project.
        Parameters:
        versions - a versions object.
      • setVersion

        public void setVersion​(java.lang.String version)
      • getVersion

        public java.lang.String getVersion()
      • setPackage

        public void setPackage​(java.lang.String packageName)
      • getPackage

        public java.lang.String getPackage()