DoapOptions (Apache Maven DOAP Plugin 1.2 API)

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:
http://usefulinc.com/ns/doap#, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DoapOptions()

Constructors
Constructor and Description
`DoapOptions()`

Method Summary

Methods
Modifier and Type	Method and 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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DoapOptions
```
public DoapOptions()
```
- Method Detail
  - addExtra
```
public void addExtra(Object key,
            String value)
```
    Method addExtra.
    
    Parameters:
    key -
    value -
  - equals
```
public boolean equals(Object other)
```
    Method equals.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other -
    
    Returns:
    boolean
  - getAudience
```
public String getAudience()
```
    Get description of target user base.
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#audience
  - getBlog
```
public String getBlog()
```
    Get uRI of a blog related to a project.
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#blog
  - getBugDatabase
```
public String getBugDatabase()
```
    Get bug tracker for a project.
    Default value: ${project.issueManagement.url}
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#bug-database
  - 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:
    http://usefulinc.com/ns/doap#category
  - 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:
    http://usefulinc.com/ns/doap#created
  - getDescription
```
public String getDescription()
```
    Get the project description.
    Default value: ${project.description}
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#description
  - 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:
    http://usefulinc.com/ns/doap#download-mirror
  - getDownloadPage
```
public String getDownloadPage()
```
    Get web page from which the project software can be downloaded.
    Default value: ${project.distributionManagement.downloadUrl}
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#download-page
  - 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:
    http://usefulinc.com/ns/doap#homepage
  - 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:
    http://usefulinc.com/ns/doap#implements
  - 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:
    http://usefulinc.com/ns/doap#language
  - 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:
    http://usefulinc.com/ns/doap#license
  - 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:
    http://usefulinc.com/ns/doap#mailing-list
  - getName
```
public String getName()
```
    Get the project name.
    Default value: ${project.name}
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#name
  - getOldHomepage
```
public String getOldHomepage()
```
    Get uRL of a project's past homepage, associated with exactly one project.
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#old-homepage
  - 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:
    http://usefulinc.com/ns/doap#os
  - 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:
    http://usefulinc.com/ns/doap#platform
  - 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:
    http://usefulinc.com/ns/doap#programming-language
  - getScmAnonymous
```
public String getScmAnonymous()
```
    Get anonymous Source Repository as URL or Maven format.
    Default value: ${project.scm.connection}
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#Repository, http://usefulinc.com/ns/doap#CVSRepository, http://usefulinc.com/ns/doap#SVNRepository
  - getScmDeveloper
```
public String getScmDeveloper()
```
    Get developer Source Repository as URL or Maven format.
    Default value: ${project.scm.developerConnection}
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#Repository, http://usefulinc.com/ns/doap#CVSRepository, http://usefulinc.com/ns/doap#SVNRepository
  - getScreenshots
```
public String getScreenshots()
```
    Get web page with screenshots of project.
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#screenshots
  - getServiceEndpoint
```
public String getServiceEndpoint()
```
    Get uRI of a web service endpoint where software as a service may be accessed.
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#service-endpoint
  - getShortdesc
```
public String getShortdesc()
```
    Get short (8 or 9 words) plain text description of a project.
    Default value: ${project.description}
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#shortdesc
  - getVendor
```
public String getVendor()
```
    Get vendor organization: commercial, free or otherwise.
    Default value: ${project.organization.name}
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#vendor
  - getWiki
```
public String getWiki()
```
    Get uRL of Wiki for collaborative discussion of project.
    
    Returns:
    String
    See Also:
    http://usefulinc.com/ns/doap#wiki
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#audience
  - setBlog
```
public void setBlog(String blog)
```
    Set uRI of a blog related to a project.
    
    Parameters:
    blog -
    See Also:
    http://usefulinc.com/ns/doap#blog
  - setBugDatabase
```
public void setBugDatabase(String bugDatabase)
```
    Set bug tracker for a project.
    Default value: ${project.issueManagement.url}
    
    Parameters:
    bugDatabase -
    See Also:
    http://usefulinc.com/ns/doap#bug-database
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#category
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#created
  - setDescription
```
public void setDescription(String description)
```
    Set the project description.
    Default value: ${project.description}
    
    Parameters:
    description -
    See Also:
    http://usefulinc.com/ns/doap#description
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#download-mirror
  - setDownloadPage
```
public void setDownloadPage(String downloadPage)
```
    Set web page from which the project software can be downloaded.
    Default value: ${project.distributionManagement.downloadUrl}
    
    Parameters:
    downloadPage -
    See Also:
    http://usefulinc.com/ns/doap#download-page
  - setExtra
```
public void setExtra(Map extra)
```
    Set extra DOAP vocabulary as key/value, not actually defined as plugin options.
    
    Parameters:
    extra -
  - setHomepage
```
public void setHomepage(String homepage)
```
    Set uRL of a project's homepage, associated with exactly one project.
    Default value: ${project.url}
    
    Parameters:
    homepage -
    See Also:
    http://usefulinc.com/ns/doap#homepage
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#implements
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#language
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#license
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#mailing-list
  - setName
```
public void setName(String name)
```
    Set the project name.
    Default value: ${project.name}
    
    Parameters:
    name -
    See Also:
    http://usefulinc.com/ns/doap#name
  - setOldHomepage
```
public void setOldHomepage(String oldHomepage)
```
    Set uRL of a project's past homepage, associated with exactly one project.
    
    Parameters:
    oldHomepage -
    See Also:
    http://usefulinc.com/ns/doap#old-homepage
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#os
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#platform
  - 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 -
    See Also:
    http://usefulinc.com/ns/doap#programming-language
  - setScmAnonymous
```
public void setScmAnonymous(String scmAnonymous)
```
    Set anonymous Source Repository as URL or Maven format.
    Default value: ${project.scm.connection}
    
    Parameters:
    scmAnonymous -
    See Also:
    http://usefulinc.com/ns/doap#Repository, http://usefulinc.com/ns/doap#CVSRepository, http://usefulinc.com/ns/doap#SVNRepository
  - setScmDeveloper
```
public void setScmDeveloper(String scmDeveloper)
```
    Set developer Source Repository as URL or Maven format.
    Default value: ${project.scm.developerConnection}
    
    Parameters:
    scmDeveloper -
    See Also:
    http://usefulinc.com/ns/doap#Repository, http://usefulinc.com/ns/doap#CVSRepository, http://usefulinc.com/ns/doap#SVNRepository
  - setScreenshots
```
public void setScreenshots(String screenshots)
```
    Set web page with screenshots of project.
    
    Parameters:
    screenshots -
    See Also:
    http://usefulinc.com/ns/doap#screenshots
  - setServiceEndpoint
```
public void setServiceEndpoint(String serviceEndpoint)
```
    Set uRI of a web service endpoint where software as a service may be accessed.
    
    Parameters:
    serviceEndpoint -
    See Also:
    http://usefulinc.com/ns/doap#service-endpoint
  - setShortdesc
```
public void setShortdesc(String shortdesc)
```
    Set short (8 or 9 words) plain text description of a project.
    Default value: ${project.description}
    
    Parameters:
    shortdesc -
    See Also:
    http://usefulinc.com/ns/doap#shortdesc
  - setVendor
```
public void setVendor(String vendor)
```
    Set vendor organization: commercial, free or otherwise.
    Default value: ${project.organization.name}
    
    Parameters:
    vendor -
    See Also:
    http://usefulinc.com/ns/doap#vendor
  - setWiki
```
public void setWiki(String wiki)
```
    Set uRL of Wiki for collaborative discussion of project.
    
    Parameters:
    wiki -
    See Also:
    http://usefulinc.com/ns/doap#wiki
  - setXmlnsNamespaceURI
```
public void setXmlnsNamespaceURI(String xmlnsNamespaceURI)
```
    Set the URI of the DOAP xmlns namespace.
    Default value: http://usefulinc.com/ns/doap#.
    
    Parameters:
    xmlnsNamespaceURI -
  - setXmlnsPrefix
```
public void setXmlnsPrefix(String xmlnsPrefix)
```
    Set the DOAP xmlns prefix.
    
    Parameters:
    xmlnsPrefix -
  - toString
```
public String toString()
```
    Method toString.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String

Class DoapOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DoapOptions

Method Detail

addExtra

equals

getAudience

getBlog

getBugDatabase

getCategory

getCreated

getDescription

getDownloadMirror

getDownloadPage

getExtra

getHomepage

getImplementations

getLanguage

getLicense

getMailingList

getName

getOldHomepage

getOs

getPlatform

getProgrammingLanguage

getScmAnonymous

getScmDeveloper

getScreenshots

getServiceEndpoint

getShortdesc

getVendor

getWiki

getXmlnsNamespaceURI

getXmlnsPrefix

hashCode

setAudience

setBlog

setBugDatabase

setCategory

setCreated

setDescription

setDownloadMirror

setDownloadPage

setExtra

setHomepage

setImplementations

setLanguage

setLicense

setMailingList

setName

setOldHomepage

setOs

setPlatform

setProgrammingLanguage

setScmAnonymous

setScmDeveloper

setScreenshots

setServiceEndpoint

setShortdesc

setVendor

setWiki

setXmlnsNamespaceURI

setXmlnsPrefix

toString