Class Model

All Implemented Interfaces:
Serializable

public class Model extends ModelBase implements 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:
  • Field Details

    • modelVersion

      private String modelVersion
      Declares to which version of project descriptor this POM conforms.
    • parent

      private 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.
    • groupId

      private 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).
    • artifactId

      private 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.
    • version

      private String version
      The current version of the artifact produced by this project.
    • packaging

      private String packaging
      The type of artifact this project produces, for example jar war ear pom. Plugins can create their own packaging, and therefore their own packaging types, so this list does not contain all possible types.
    • name

      private String name
      The full name of the project.
    • description

      private String description
      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.
    • url

      private String url
      The URL to the project's homepage.
    • inceptionYear

      private 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.
    • organization

      private 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).
    • licenses

      private List<License> licenses
      Field licenses.
    • mailingLists

      private List<MailingList> mailingLists
      Field mailingLists.
    • developers

      private List<Developer> developers
      Field developers.
    • contributors

      private List<Contributor> contributors
      Field contributors.
    • issueManagement

      private IssueManagement issueManagement
      The project's issue management system information.
    • scm

      private Scm scm
      Specification for the SCM used by the project, such as CVS, Subversion, etc.
    • ciManagement

      private CiManagement ciManagement
      The project's continuous integration information.
    • prerequisites

      private Prerequisites prerequisites
      Describes the prerequisites in the build environment for this project.
    • build

      private Build build
      Information required to build the project.
    • profiles

      private List<Profile> profiles
      Field profiles.
    • modelEncoding

      private String modelEncoding
      Field modelEncoding.
  • Constructor Details

    • Model

      public Model()
  • Method Details

    • addContributor

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

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

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

      public void addMailingList(MailingList mailingList)
      Method addMailingList.
      Parameters:
      mailingList -
    • addProfile

      public void addProfile(Profile profile)
      Method addProfile.
      Parameters:
      profile -
    • getArtifactId

      public 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
    • getBuild

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

      public CiManagement getCiManagement()
      Get the project's continuous integration information.
      Returns:
      CiManagement
    • getContributors

      public List<Contributor> getContributors()
      Method getContributors.
      Returns:
      List
    • getDescription

      public 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 List<Developer> getDevelopers()
      Method getDevelopers.
      Returns:
      List
    • getGroupId

      public 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
    • getInceptionYear

      public 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
    • getIssueManagement

      public IssueManagement getIssueManagement()
      Get the project's issue management system information.
      Returns:
      IssueManagement
    • getLicenses

      public List<License> getLicenses()
      Method getLicenses.
      Returns:
      List
    • getMailingLists

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

      public String getModelEncoding()
      Get the modelEncoding field.
      Returns:
      String
    • getModelVersion

      public String getModelVersion()
      Get declares to which version of project descriptor this POM conforms.
      Returns:
      String
    • getName

      public 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
    • getPackaging

      public String getPackaging()
      Get the type of artifact this project produces, for example jar war ear pom. Plugins can create their own packaging, and therefore their own packaging types, so this list does not contain all possible types.
      Returns:
      String
    • getParent

      public Parent getParent()
      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 location is given as a group ID, artifact ID and version.
      Returns:
      Parent
    • getPrerequisites

      public Prerequisites getPrerequisites()
      Get describes the prerequisites in the build environment for this project.
      Returns:
      Prerequisites
    • getProfiles

      public List<Profile> getProfiles()
      Method getProfiles.
      Returns:
      List
    • getScm

      public Scm getScm()
      Get specification for the SCM used by the project, such as CVS, Subversion, etc.
      Returns:
      Scm
    • getUrl

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

      public String getVersion()
      Get the current version of the artifact produced by this project.
      Returns:
      String
    • removeContributor

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

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

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

      public void removeMailingList(MailingList mailingList)
      Method removeMailingList.
      Parameters:
      mailingList -
    • removeProfile

      public void removeProfile(Profile profile)
      Method removeProfile.
      Parameters:
      profile -
    • setArtifactId

      public void setArtifactId(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 -
    • setBuild

      public void setBuild(Build build)
      Set information required to build the project.
      Parameters:
      build -
    • setCiManagement

      public void setCiManagement(CiManagement ciManagement)
      Set the project's continuous integration information.
      Parameters:
      ciManagement -
    • setContributors

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

      public void setDescription(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 -
    • setDevelopers

      public void setDevelopers(List<Developer> developers)
      Set describes the committers of a project.
      Parameters:
      developers -
    • setGroupId

      public void setGroupId(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 -
    • setInceptionYear

      public void setInceptionYear(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 -
    • setIssueManagement

      public void setIssueManagement(IssueManagement issueManagement)
      Set the project's issue management system information.
      Parameters:
      issueManagement -
    • setLicenses

      public void setLicenses(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 -
    • setMailingLists

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

      public void setModelEncoding(String modelEncoding)
      Set the modelEncoding field.
      Parameters:
      modelEncoding -
    • setModelVersion

      public void setModelVersion(String modelVersion)
      Set declares to which version of project descriptor this POM conforms.
      Parameters:
      modelVersion -
    • setName

      public void setName(String name)
      Set the full name of the project.
      Parameters:
      name -
    • 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 -
    • setPackaging

      public void setPackaging(String packaging)
      Set the type of artifact this project produces, for example jar war ear pom. Plugins can create their own packaging, and therefore their own packaging types, so this list does not contain all possible types.
      Parameters:
      packaging -
    • setParent

      public void setParent(Parent parent)
      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 location is given as a group ID, artifact ID and version.
      Parameters:
      parent -
    • setPrerequisites

      public void setPrerequisites(Prerequisites prerequisites)
      Set describes the prerequisites in the build environment for this project.
      Parameters:
      prerequisites -
    • setProfiles

      public void setProfiles(List<Profile> profiles)
      Set a listing of project-local build profiles which will modify the build process when activated.
      Parameters:
      profiles -
    • setScm

      public void setScm(Scm scm)
      Set specification for the SCM used by the project, such as CVS, Subversion, etc.
      Parameters:
      scm -
    • setUrl

      public void setUrl(String url)
      Set the URL to the project's homepage.
      Parameters:
      url -
    • setVersion

      public void setVersion(String version)
      Set the current version of the artifact produced by this project.
      Parameters:
      version -
    • getId

      public String getId()
      Returns:
      the model id as groupId:artifactId:packaging:version