Class DoapOptions

java.lang.Object
org.apache.maven.plugin.doap.options.DoapOptions
All Implemented Interfaces:
Serializable
public class DoapOptions extends Object implements Serializable
Specific DOAP parameters, i.e. options that POM doesn't have any notions or to override some POM options.
Version:
$Revision$ $Date$
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    DoapOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addExtra(Object key, String value)
    Method addExtra.
    boolean
    equals(Object other)
    Method equals.
    String
    getAudience()
    Get description of target user base.
    String
    getBlog()
    Get uRI of a blog related to a project.
    String
    getBugDatabase()
    Get bug tracker for a project.
    Default value: ${project.issueManagement.url}
    String
    getCategory()
    Get a category of project.
    Default value: library
    Note: This string is comma separated to allow several categories.
    String
    getCreated()
    Get date when something was created, in YYYY-MM-DD form.
    String
    getDescription()
    Get the project description.
    Default value: ${project.description}
    String
    getDownloadMirror()
    Get mirror of software download web page.
    Note: This string is comma separated to allow several mirror pages.
    String
    getDownloadPage()
    Get web page from which the project software can be downloaded.
    Default value: ${project.distributionManagement.downloadUrl}
    Map<Object,String>
    getExtra()
    Method getExtra.
    String
    getHomepage()
    Get uRL of a project's homepage, associated with exactly one project.
    Default value: ${project.url}
    String
    getImplementations()
    Get a specification that a project implements.
    String
    getLanguage()
    Get iSO language code a project has been translated into.
    String
    getLicense()
    Get the URI of an RDF description of the license the software is distributed under.
    Default value: ${project.licenses[0].url}
    String
    getMailingList()
    Get single web page that allows people to find out more information about the mailing lists provided by the project.
    Default value: ${project.url}/mail-lists.html
    Note: by default, the mailing list page is the one generated by the Maven Project Info Reports Plugin.
    String
    getName()
    Get the project name.
    Default value: ${project.name}
    String
    getOldHomepage()
    Get uRL of a project's past homepage, associated with exactly one project.
    String
    getOs()
    Get operating system that a project is limited to.
    String
    getPlatform()
    Get indicator of software platform (non-OS specific), e.g.
    String
    getProgrammingLanguage()
    Get programming language a project is implemented in or intended for use with.
    Default value: Java
    Note: This string is comma separated to allow several programming-language.
    String
    getScmAnonymous()
    Get anonymous Source Repository as URL or Maven format.
    Default value: ${project.scm.connection}
    String
    getScmDeveloper()
    Get developer Source Repository as URL or Maven format.
    Default value: ${project.scm.developerConnection}
    String
    getScreenshots()
    Get web page with screenshots of project.
    String
    getServiceEndpoint()
    Get uRI of a web service endpoint where software as a service may be accessed.
    String
    getShortdesc()
    Get short (8 or 9 words) plain text description of a project.
    Default value: ${project.description}
    String
    getVendor()
    Get vendor organization: commercial, free or otherwise.
    Default value: ${project.organization.name}
    String
    getWiki()
    Get uRL of Wiki for collaborative discussion of project.
    String
    getXmlnsNamespaceURI()
    Get the URI of the DOAP xmlns namespace.
    Default value: http://usefulinc.com/ns/doap#.
    String
    getXmlnsPrefix()
    Get the DOAP xmlns prefix.
    int
    hashCode()
    Method hashCode.
    void
    setAudience(String audience)
    Set description of target user base.
    void
    setBlog(String blog)
    Set uRI of a blog related to a project.
    void
    setBugDatabase(String bugDatabase)
    Set bug tracker for a project.
    Default value: ${project.issueManagement.url}
    void
    setCategory(String category)
    Set a category of project.
    Default value: library
    Note: This string is comma separated to allow several categories.
    void
    setCreated(String created)
    Set date when something was created, in YYYY-MM-DD form.
    void
    setDescription(String description)
    Set the project description.
    Default value: ${project.description}
    void
    setDownloadMirror(String downloadMirror)
    Set mirror of software download web page.
    Note: This string is comma separated to allow several mirror pages.
    void
    setDownloadPage(String downloadPage)
    Set web page from which the project software can be downloaded.
    Default value: ${project.distributionManagement.downloadUrl}
    void
    setExtra(Map extra)
    Set extra DOAP vocabulary as key/value, not actually defined as plugin options.
    void
    setHomepage(String homepage)
    Set uRL of a project's homepage, associated with exactly one project.
    Default value: ${project.url}
    void
    setImplementations(String implementations)
    Set a specification that a project implements.
    void
    setLanguage(String language)
    Set iSO language code a project has been translated into.
    void
    setLicense(String license)
    Set the URI of an RDF description of the license the software is distributed under.
    Default value: ${project.licenses[0].url}
    void
    setMailingList(String mailingList)
    Set single web page that allows people to find out more information about the mailing lists provided by the project.
    Default value: ${project.url}/mail-lists.html
    Note: by default, the mailing list page is the one generated by the Maven Project Info Reports Plugin.
    void
    setName(String name)
    Set the project name.
    Default value: ${project.name}
    void
    setOldHomepage(String oldHomepage)
    Set uRL of a project's past homepage, associated with exactly one project.
    void
    setOs(String os)
    Set operating system that a project is limited to.
    void
    setPlatform(String platform)
    Set indicator of software platform (non-OS specific), e.g.
    void
    setProgrammingLanguage(String programmingLanguage)
    Set programming language a project is implemented in or intended for use with.
    Default value: Java
    Note: This string is comma separated to allow several programming-language.
    void
    setScmAnonymous(String scmAnonymous)
    Set anonymous Source Repository as URL or Maven format.
    Default value: ${project.scm.connection}
    void
    setScmDeveloper(String scmDeveloper)
    Set developer Source Repository as URL or Maven format.
    Default value: ${project.scm.developerConnection}
    void
    setScreenshots(String screenshots)
    Set web page with screenshots of project.
    void
    setServiceEndpoint(String serviceEndpoint)
    Set uRI of a web service endpoint where software as a service may be accessed.
    void
    setShortdesc(String shortdesc)
    Set short (8 or 9 words) plain text description of a project.
    Default value: ${project.description}
    void
    setVendor(String vendor)
    Set vendor organization: commercial, free or otherwise.
    Default value: ${project.organization.name}
    void
    setWiki(String wiki)
    Set uRL of Wiki for collaborative discussion of project.
    void
    setXmlnsNamespaceURI(String xmlnsNamespaceURI)
    Set the URI of the DOAP xmlns namespace.
    Default value: http://usefulinc.com/ns/doap#.
    void
    setXmlnsPrefix(String xmlnsPrefix)
    Set the DOAP xmlns prefix.
    String
    toString()
    Method toString.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DoapOptions

      public DoapOptions()

  • Method Details

    • addExtra

      public void addExtra(Object key, String value)
      Method addExtra.
      Parameters:
      key - a key object.
      value - a value object.

    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      Returns:
      boolean

    • getAudience

      public String getAudience()
      Get description of target user base.
      Returns:
      String
      See Also:

    • getBlog

      public String getBlog()
      Get uRI of a blog related to a project.
      Returns:
      String
      See Also:

    • getBugDatabase

      public String getBugDatabase()
      Get bug tracker for a project.
      Default value: ${project.issueManagement.url}
      Returns:
      String
      See Also:

    • getCategory

      public String getCategory()
      Get a category of project.
      Default value: library
      Note: This string is comma separated to allow several categories.
      Returns:
      String
      See Also:

    • getCreated

      public String getCreated()
      Get date when something was created, in YYYY-MM-DD form. e.g. 2004-04-05.
      Default value: ${project.inceptionYear}-01-01
      Returns:
      String
      See Also:

    • getDescription

      public String getDescription()
      Get the project description.
      Default value: ${project.description}
      Returns:
      String
      See Also:

    • getDownloadMirror

      public String getDownloadMirror()
      Get mirror of software download web page.
      Note: This string is comma separated to allow several mirror pages.
      Returns:
      String
      See Also:

    • getDownloadPage

      public String getDownloadPage()
      Get web page from which the project software can be downloaded.
      Default value: ${project.distributionManagement.downloadUrl}
      Returns:
      String
      See Also:

    • getExtra

      public Map<Object,String> getExtra()
      Method getExtra.
      Returns:
      Map

    • getHomepage

      public String getHomepage()
      Get uRL of a project's homepage, associated with exactly one project.
      Default value: ${project.url}
      Returns:
      String
      See Also:

    • getImplementations

      public String getImplementations()
      Get a specification that a project implements. Could be a standard, API or legally defined level of conformance.
      Note: This string is comma separated to allow several implementations.
      Returns:
      String
      See Also:

    • getLanguage

      public String getLanguage()
      Get iSO language code a project has been translated into. Note: This string is comma separated to allow several languages.
      Returns:
      String
      See Also:

    • getLicense

      public String getLicense()
      Get the URI of an RDF description of the license the software is distributed under.
      Default value: ${project.licenses[0].url}
      Returns:
      String
      See Also:

    • getMailingList

      public String getMailingList()
      Get single web page that allows people to find out more information about the mailing lists provided by the project.
      Default value: ${project.url}/mail-lists.html
      Note: by default, the mailing list page is the one generated by the Maven Project Info Reports Plugin.
      Returns:
      String
      See Also:

    • getName

      public String getName()
      Get the project name.
      Default value: ${project.name}
      Returns:
      String
      See Also:

    • getOldHomepage

      public String getOldHomepage()
      Get uRL of a project's past homepage, associated with exactly one project.
      Returns:
      String
      See Also:

    • getOs

      public String getOs()
      Get operating system that a project is limited to. Omit this property if the project is not OS-specific.
      Note: This string is comma separated to allow several OS.
      Returns:
      String
      See Also:

    • getPlatform

      public String getPlatform()
      Get indicator of software platform (non-OS specific), e.g. Java, Firefox, ECMA CLR.
      Note: This string is comma separated to allow several platforms.
      Returns:
      String
      See Also:

    • getProgrammingLanguage

      public String getProgrammingLanguage()
      Get programming language a project is implemented in or intended for use with.
      Default value: Java
      Note: This string is comma separated to allow several programming-language.
      Returns:
      String
      See Also:

    • getScmAnonymous

      public String getScmAnonymous()
      Get anonymous Source Repository as URL or Maven format.
      Default value: ${project.scm.connection}
      Returns:
      String
      See Also:

    • getScmDeveloper

      public String getScmDeveloper()
      Get developer Source Repository as URL or Maven format.
      Default value: ${project.scm.developerConnection}
      Returns:
      String
      See Also:

    • getScreenshots

      public String getScreenshots()
      Get web page with screenshots of project.
      Returns:
      String
      See Also:

    • getServiceEndpoint

      public String getServiceEndpoint()
      Get uRI of a web service endpoint where software as a service may be accessed.
      Returns:
      String
      See Also:

    • getShortdesc

      public String getShortdesc()
      Get short (8 or 9 words) plain text description of a project.
      Default value: ${project.description}
      Returns:
      String
      See Also:

    • getVendor

      public String getVendor()
      Get vendor organization: commercial, free or otherwise.
      Default value: ${project.organization.name}
      Returns:
      String
      See Also:

    • getWiki

      public String getWiki()
      Get uRL of Wiki for collaborative discussion of project.
      Returns:
      String
      See Also:

    • getXmlnsNamespaceURI

      public String getXmlnsNamespaceURI()
      Get the URI of the DOAP xmlns namespace.
      Default value: http://usefulinc.com/ns/doap#.
      Returns:
      String

    • getXmlnsPrefix

      public String getXmlnsPrefix()
      Get the DOAP xmlns prefix.
      Returns:
      String

    • hashCode

      public int hashCode()
      Method hashCode.
      Overrides:
      hashCode in class Object
      Returns:
      int

    • setAudience

      public void setAudience(String audience)
      Set description of target user base.
      Parameters:
      audience - a audience object.
      See Also:

    • setBlog

      public void setBlog(String blog)
      Set uRI of a blog related to a project.
      Parameters:
      blog - a blog object.
      See Also:

    • setBugDatabase

      public void setBugDatabase(String bugDatabase)
      Set bug tracker for a project.
      Default value: ${project.issueManagement.url}
      Parameters:
      bugDatabase - a bugDatabase object.
      See Also:

    • setCategory

      public void setCategory(String category)
      Set a category of project.
      Default value: library
      Note: This string is comma separated to allow several categories.
      Parameters:
      category - a category object.
      See Also:

    • setCreated

      public void setCreated(String created)
      Set date when something was created, in YYYY-MM-DD form. e.g. 2004-04-05.
      Default value: ${project.inceptionYear}-01-01
      Parameters:
      created - a created object.
      See Also:

    • setDescription

      public void setDescription(String description)
      Set the project description.
      Default value: ${project.description}
      Parameters:
      description - a description object.
      See Also:

    • setDownloadMirror

      public void setDownloadMirror(String downloadMirror)
      Set mirror of software download web page.
      Note: This string is comma separated to allow several mirror pages.
      Parameters:
      downloadMirror - a downloadMirror object.
      See Also:

    • setDownloadPage

      public void setDownloadPage(String downloadPage)
      Set web page from which the project software can be downloaded.
      Default value: ${project.distributionManagement.downloadUrl}
      Parameters:
      downloadPage - a downloadPage object.
      See Also:

    • setExtra

      public void setExtra(Map extra)
      Set extra DOAP vocabulary as key/value, not actually defined as plugin options.
      Parameters:
      extra - a extra object.

    • setHomepage

      public void setHomepage(String homepage)
      Set uRL of a project's homepage, associated with exactly one project.
      Default value: ${project.url}
      Parameters:
      homepage - a homepage object.
      See Also:

    • setImplementations

      public void setImplementations(String implementations)
      Set a specification that a project implements. Could be a standard, API or legally defined level of conformance.
      Note: This string is comma separated to allow several implementations.
      Parameters:
      implementations - a implementations object.
      See Also:

    • setLanguage

      public void setLanguage(String language)
      Set iSO language code a project has been translated into. Note: This string is comma separated to allow several languages.
      Parameters:
      language - a language object.
      See Also:

    • setLicense

      public void setLicense(String license)
      Set the URI of an RDF description of the license the software is distributed under.
      Default value: ${project.licenses[0].url}
      Parameters:
      license - a license object.
      See Also:

    • setMailingList

      public void setMailingList(String mailingList)
      Set single web page that allows people to find out more information about the mailing lists provided by the project.
      Default value: ${project.url}/mail-lists.html
      Note: by default, the mailing list page is the one generated by the Maven Project Info Reports Plugin.
      Parameters:
      mailingList - a mailingList object.
      See Also:

    • setName

      public void setName(String name)
      Set the project name.
      Default value: ${project.name}
      Parameters:
      name - a name object.
      See Also:

    • setOldHomepage

      public void setOldHomepage(String oldHomepage)
      Set uRL of a project's past homepage, associated with exactly one project.
      Parameters:
      oldHomepage - a oldHomepage object.
      See Also:

    • setOs

      public void setOs(String os)
      Set operating system that a project is limited to. Omit this property if the project is not OS-specific.
      Note: This string is comma separated to allow several OS.
      Parameters:
      os - a os object.
      See Also:

    • setPlatform

      public void setPlatform(String platform)
      Set indicator of software platform (non-OS specific), e.g. Java, Firefox, ECMA CLR.
      Note: This string is comma separated to allow several platforms.
      Parameters:
      platform - a platform object.
      See Also:

    • setProgrammingLanguage

      public void setProgrammingLanguage(String programmingLanguage)
      Set programming language a project is implemented in or intended for use with.
      Default value: Java
      Note: This string is comma separated to allow several programming-language.
      Parameters:
      programmingLanguage - a programmingLanguage object.
      See Also:

    • setScmAnonymous

      public void setScmAnonymous(String scmAnonymous)
      Set anonymous Source Repository as URL or Maven format.
      Default value: ${project.scm.connection}
      Parameters:
      scmAnonymous - a scmAnonymous object.
      See Also:

    • setScmDeveloper

      public void setScmDeveloper(String scmDeveloper)
      Set developer Source Repository as URL or Maven format.
      Default value: ${project.scm.developerConnection}
      Parameters:
      scmDeveloper - a scmDeveloper object.
      See Also:

    • setScreenshots

      public void setScreenshots(String screenshots)
      Set web page with screenshots of project.
      Parameters:
      screenshots - a screenshots object.
      See Also:

    • setServiceEndpoint

      public void setServiceEndpoint(String serviceEndpoint)
      Set uRI of a web service endpoint where software as a service may be accessed.
      Parameters:
      serviceEndpoint - a serviceEndpoint object.
      See Also:

    • setShortdesc

      public void setShortdesc(String shortdesc)
      Set short (8 or 9 words) plain text description of a project.
      Default value: ${project.description}
      Parameters:
      shortdesc - a shortdesc object.
      See Also:

    • setVendor

      public void setVendor(String vendor)
      Set vendor organization: commercial, free or otherwise.
      Default value: ${project.organization.name}
      Parameters:
      vendor - a vendor object.
      See Also:

    • setWiki

      public void setWiki(String wiki)
      Set uRL of Wiki for collaborative discussion of project.
      Parameters:
      wiki - a wiki object.
      See Also:

    • setXmlnsNamespaceURI

      public void setXmlnsNamespaceURI(String xmlnsNamespaceURI)
      Set the URI of the DOAP xmlns namespace.
      Default value: http://usefulinc.com/ns/doap#.
      Parameters:
      xmlnsNamespaceURI - a xmlnsNamespaceURI object.

    • setXmlnsPrefix

      public void setXmlnsPrefix(String xmlnsPrefix)
      Set the DOAP xmlns prefix.
      Parameters:
      xmlnsPrefix - a xmlnsPrefix object.

    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String