org.apache.maven.plugin.doap.options
Class ASFExtOptions

java.lang.Object
  extended by org.apache.maven.plugin.doap.options.ASFExtOptions
All Implemented Interfaces:
java.io.Serializable

public class ASFExtOptions
extends java.lang.Object
implements java.io.Serializable

Specific ASF DOAP parameters, i.e. ASF options which make DOAP file ASF compliant.

Version:
$Revision: 815332 $ $Date: 2012-05-01 23:25:03 +0200 (Tue, 01 May 2012) $
See Also:
http://svn.apache.org/repos/asf/infrastructure/site-tools/trunk/projects/asfext, http://projects.apache.org/docs/pmc.html, http://projects.apache.org/docs/standards.html, Serialized Form

Field Summary
static java.lang.String ASFEXT_NAMESPACE
          The ASF ext namespace.
static java.lang.String BUILD_MANAGEMENT_CATEGORY
          Projects related to building/maintaining source code/websites.
static java.lang.String C_PROGRAMMING_LANGUAGE
          C or C++ Programming Language.
static java.lang.String[] CATEGORIES
          All categories supported by ASF
static java.lang.String CATEGORY_RESOURCE
          The ASF category resource.
static java.lang.String DATABASE_CATEGORY
          Projects related to databases.
static java.lang.String HTTP_CATEGORY
          Related to the HyperText Transfer Protocol.
static java.lang.String HTTP_MODULES_CATEGORY
          Modules designed for use by the Apache HTTP Server.
static java.lang.String JAVA_PROGRAMMING_LANGUAGE
          Java Programming Language and all its components.
static java.lang.String LIBRARY_CATEGORY
          A library meant to be used by other applications.
static java.lang.String MAIL_CATEGORY
          Servers or applications related to internet mail protocols.
static java.lang.String NETWORK_CLIENT_CATEGORY
          Anything that acts as a client across a network.
static java.lang.String NETWORK_SERVER_CATEGORY
          Anything that acts as a server across a network.
static java.lang.String PERL_PROGRAMMING_LANGUAGE
          Perl Programming Language.
static java.lang.String[] PROGRAMMING_LANGUAGES
          All Programming Languages supported by ASF
static java.lang.String PYTHON_PROGRAMMING_LANGUAGE
          Python Programming Language.
static java.lang.String SVG_PROGRAMMING_LANGUAGE
          Scalable Vector Graphic Programming Language.
static java.lang.String TCL_PROGRAMMING_LANGUAGE
          Tcl Programming Language.
static java.lang.String TESTING_CATEGORY
          Software designed to test or verify other software.
static java.lang.String WEB_FRAMEWORK_CATEGORY
          Unifying frameworks for website development.
static java.lang.String XML_CATEGORY
          Software based on XML technologies.
 
Constructor Summary
ASFExtOptions()
           
 
Method Summary
 void addStandard(Standard standard)
          Method addStandard.
 boolean equals(java.lang.Object other)
          Method equals.
static org.apache.maven.model.Developer findChair(java.util.List developers)
          Find the chair man of the project.
static java.util.List findPMCMembers(java.util.List developers)
          Find the list of PMC members of the project.
 java.lang.String getChair()
          Get this should contain the name of the current PMC chairperson.
 java.lang.String getCharter()
          Get every PMC is created by a board resolution with a specific charter.
 java.lang.String getModelEncoding()
           
 java.lang.String getName()
          Get the name of the PMC, including the 'Apache ', e.g.
 java.lang.String getPmc()
          Get the top level element within a file.
 java.util.List getStandards()
          Method getStandards.
 int hashCode()
          Method hashCode.
static boolean isCategorySupportedByASF(java.lang.String category)
           
 boolean isIncluded()
          Get flag to use or not the ASF extension in the generated DOAP.
static boolean isProgrammingLanguageSupportedByASF(java.lang.String programmingLanguage)
           
 void removeStandard(Standard standard)
          Method removeStandard.
 void setChair(java.lang.String chair)
          Set this should contain the name of the current PMC chairperson.
 void setCharter(java.lang.String charter)
          Set every PMC is created by a board resolution with a specific charter.
 void setIncluded(boolean included)
          Set flag to use or not the ASF extension in the generated DOAP.
 void setModelEncoding(java.lang.String modelEncoding)
          Set an encoding used for reading/writing the model.
 void setName(java.lang.String name)
          Set the name of the PMC, including the 'Apache ', e.g.
 void setPmc(java.lang.String pmc)
          Set the top level element within a file.
 void setStandards(java.util.List standards)
          Set list of Standard object.
 java.lang.String toString()
          Method toString.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ASFEXT_NAMESPACE

public static final java.lang.String ASFEXT_NAMESPACE
The ASF ext namespace.

See Also:
Constant Field Values

CATEGORY_RESOURCE

public static final java.lang.String CATEGORY_RESOURCE
The ASF category resource.

See Also:
http://projects.apache.org/guidelines.html, Constant Field Values

BUILD_MANAGEMENT_CATEGORY

public static final java.lang.String BUILD_MANAGEMENT_CATEGORY
Projects related to building/maintaining source code/websites.

See Also:
Constant Field Values

DATABASE_CATEGORY

public static final java.lang.String DATABASE_CATEGORY
Projects related to databases.

See Also:
Constant Field Values

HTTP_CATEGORY

public static final java.lang.String HTTP_CATEGORY
Related to the HyperText Transfer Protocol.

See Also:
Constant Field Values

HTTP_MODULES_CATEGORY

public static final java.lang.String HTTP_MODULES_CATEGORY
Modules designed for use by the Apache HTTP Server.

See Also:
Constant Field Values

LIBRARY_CATEGORY

public static final java.lang.String LIBRARY_CATEGORY
A library meant to be used by other applications.

See Also:
Constant Field Values

MAIL_CATEGORY

public static final java.lang.String MAIL_CATEGORY
Servers or applications related to internet mail protocols.

See Also:
Constant Field Values

NETWORK_CLIENT_CATEGORY

public static final java.lang.String NETWORK_CLIENT_CATEGORY
Anything that acts as a client across a network.

See Also:
Constant Field Values

NETWORK_SERVER_CATEGORY

public static final java.lang.String NETWORK_SERVER_CATEGORY
Anything that acts as a server across a network.

See Also:
Constant Field Values

TESTING_CATEGORY

public static final java.lang.String TESTING_CATEGORY
Software designed to test or verify other software.

See Also:
Constant Field Values

WEB_FRAMEWORK_CATEGORY

public static final java.lang.String WEB_FRAMEWORK_CATEGORY
Unifying frameworks for website development.

See Also:
Constant Field Values

XML_CATEGORY

public static final java.lang.String XML_CATEGORY
Software based on XML technologies.

See Also:
Constant Field Values

CATEGORIES

public static final java.lang.String[] CATEGORIES
All categories supported by ASF


C_PROGRAMMING_LANGUAGE

public static final java.lang.String C_PROGRAMMING_LANGUAGE
C or C++ Programming Language.

See Also:
Constant Field Values

JAVA_PROGRAMMING_LANGUAGE

public static final java.lang.String JAVA_PROGRAMMING_LANGUAGE
Java Programming Language and all its components.

See Also:
Constant Field Values

PERL_PROGRAMMING_LANGUAGE

public static final java.lang.String PERL_PROGRAMMING_LANGUAGE
Perl Programming Language.

See Also:
Constant Field Values

PYTHON_PROGRAMMING_LANGUAGE

public static final java.lang.String PYTHON_PROGRAMMING_LANGUAGE
Python Programming Language.

See Also:
Constant Field Values

SVG_PROGRAMMING_LANGUAGE

public static final java.lang.String SVG_PROGRAMMING_LANGUAGE
Scalable Vector Graphic Programming Language.

See Also:
Constant Field Values

TCL_PROGRAMMING_LANGUAGE

public static final java.lang.String TCL_PROGRAMMING_LANGUAGE
Tcl Programming Language.

See Also:
Constant Field Values

PROGRAMMING_LANGUAGES

public static final java.lang.String[] PROGRAMMING_LANGUAGES
All Programming Languages supported by ASF

Constructor Detail

ASFExtOptions

public ASFExtOptions()
Method Detail

addStandard

public void addStandard(Standard standard)
Method addStandard.

Parameters:
standard -

equals

public boolean equals(java.lang.Object other)
Method equals.

Overrides:
equals in class java.lang.Object
Parameters:
other -
Returns:
boolean

getChair

public java.lang.String getChair()
Get this should contain the name of the current PMC chairperson. Optional.

Returns:
String
See Also:
http://projects.apache.org/docs/pmc.html

getCharter

public java.lang.String getCharter()
Get every PMC is created by a board resolution with a specific charter. That charter should be listed here as it gives the focus and scope of the PMC. Optional.

Returns:
String
See Also:
http://projects.apache.org/docs/pmc.html

getName

public java.lang.String getName()
Get the name of the PMC, including the 'Apache ', e.g. 'Apache Forrest'. Optional will be discovered from POM.

Returns:
String
See Also:
http://projects.apache.org/docs/pmc.html

getPmc

public java.lang.String getPmc()
Get the top level element within a file. Optional will be discovered from POM.

Returns:
String
See Also:
http://projects.apache.org/docs/pmc.html

getStandards

public java.util.List getStandards()
Method getStandards.

Returns:
java.util.List

hashCode

public int hashCode()
Method hashCode.

Overrides:
hashCode in class java.lang.Object
Returns:
int

isIncluded

public boolean isIncluded()
Get flag to use or not the ASF extension in the generated DOAP. Required.

Returns:
boolean

removeStandard

public void removeStandard(Standard standard)
Method removeStandard.

Parameters:
standard -

setChair

public void setChair(java.lang.String chair)
Set this should contain the name of the current PMC chairperson. Optional.

Parameters:
chair -
See Also:
http://projects.apache.org/docs/pmc.html

setCharter

public void setCharter(java.lang.String charter)
Set every PMC is created by a board resolution with a specific charter. That charter should be listed here as it gives the focus and scope of the PMC. Optional.

Parameters:
charter -
See Also:
http://projects.apache.org/docs/pmc.html

setIncluded

public void setIncluded(boolean included)
Set flag to use or not the ASF extension in the generated DOAP. Required.

Parameters:
included -

setName

public void setName(java.lang.String name)
Set the name of the PMC, including the 'Apache ', e.g. 'Apache Forrest'. Optional will be discovered from POM.

Parameters:
name -
See Also:
http://projects.apache.org/docs/pmc.html

setPmc

public void setPmc(java.lang.String pmc)
Set the top level element within a file. Optional will be discovered from POM.

Parameters:
pmc -
See Also:
http://projects.apache.org/docs/pmc.html

setStandards

public void setStandards(java.util.List standards)
Set list of Standard object. Optional.

Parameters:
standards -
See Also:
http://projects.apache.org/docs/standards.html

toString

public java.lang.String toString()
Method toString.

Overrides:
toString in class java.lang.Object
Returns:
java.lang.String

isCategorySupportedByASF

public static boolean isCategorySupportedByASF(java.lang.String category)
Parameters:
category - not null
Returns:
true if the given category is supported by ASF.
See Also:
http://projects.apache.org/categories.html, CATEGORIES

isProgrammingLanguageSupportedByASF

public static boolean isProgrammingLanguageSupportedByASF(java.lang.String programmingLanguage)
Parameters:
programmingLanguage - not null
Returns:
true if the given programming language is supported by ASF.
See Also:
http://projects.apache.org/languages.html, PROGRAMMING_LANGUAGES

findChair

public static org.apache.maven.model.Developer findChair(java.util.List developers)
Find the chair man of the project. The role of the developer should contain chair.

Parameters:
developers - list of Developer
Returns:
a Developer or null if not found.

findPMCMembers

public static java.util.List findPMCMembers(java.util.List developers)
Find the list of PMC members of the project. The role of each developer should contain pmc.

Parameters:
developers - list of Developer
Returns:
a not null list of Developer.

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)
Set an encoding used for reading/writing the model.

Parameters:
modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public java.lang.String getModelEncoding()
Returns:
the current encoding used when reading/writing this model.


Copyright © 2002-2008 The Apache Software Foundation. All Rights Reserved.