Return-Path: Delivered-To: apmail-maven-commits-archive@www.apache.org Received: (qmail 5834 invoked from network); 27 Jun 2008 12:05:53 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 27 Jun 2008 12:05:53 -0000 Received: (qmail 20721 invoked by uid 500); 27 Jun 2008 12:05:54 -0000 Delivered-To: apmail-maven-commits-archive@maven.apache.org Received: (qmail 20666 invoked by uid 500); 27 Jun 2008 12:05:54 -0000 Mailing-List: contact commits-help@maven.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@maven.apache.org Delivered-To: mailing list commits@maven.apache.org Received: (qmail 20656 invoked by uid 99); 27 Jun 2008 12:05:54 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 27 Jun 2008 05:05:54 -0700 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 27 Jun 2008 12:05:02 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 398A723889C1; Fri, 27 Jun 2008 05:05:22 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r672253 - /maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java Date: Fri, 27 Jun 2008 12:05:22 -0000 To: commits@maven.apache.org From: vsiveton@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20080627120522.398A723889C1@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: vsiveton Date: Fri Jun 27 05:05:21 2008 New Revision: 672253 URL: http://svn.apache.org/viewvc?rev=672253&view=rev Log: o improved javadoc and comments Modified: maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java Modified: maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java?rev=672253&r1=672252&r2=672253&view=diff ============================================================================== --- maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java (original) +++ maven/plugins/trunk/maven-doap-plugin/src/main/java/org/apache/maven/plugin/doap/DoapMojo.java Fri Jun 27 05:05:21 2008 @@ -58,9 +58,11 @@ import org.codehaus.plexus.util.xml.XmlWriterUtil; /** - * Generate a Description of a Project (DOAP) file from the information found in a POM. + * Generate a Description of a Project (DOAP) + * file from the main information found in a POM. * * @author Jason van Zyl + * @author Vincent Siveton * @version $Id$ * @since 1.0 * @goal generate @@ -118,8 +120,31 @@ private File doapFile; /** - * The category which should be displayed in the DOAP file. The POM doesn't have any - * notions of category yet. + * The local repository where the artifacts are located. + * + * @parameter expression="${localRepository}" + * @required + * @readonly + * @since 1.0 + */ + private ArtifactRepository localRepository; + + /** + * The remote repositories where the artifacts are located. + * + * @parameter expression="${project.remoteArtifactRepositories}" + * @required + * @readonly + * @since 1.0 + */ + private List remoteRepositories; + + // ---------------------------------------------------------------------- + // Doap options + // ---------------------------------------------------------------------- + + /** + * The category which should be displayed in the DOAP file. * * @parameter expression="${category}" * @deprecated Since 1.0. Instead of, configure category property in doapOptions parameter. @@ -127,8 +152,7 @@ private String category; /** - * The language which should be displayed in the DOAP file. The POM doesn't have any - * notions of language yet. + * The language which should be displayed in the DOAP file. * * @parameter expression="${language}" * @deprecated Since 1.0. Instead of, configure programmingLanguage property in doapOptions parameter. @@ -137,32 +161,19 @@ /** * Specific DOAP parameters, i.e. options that POM doesn't have any notions. + *
+ * Example: + *

+     * <doapOptions>
+     *   <programmingLanguage>java</programmingLanguage>
+     * </doapOptions>
+     *

* * @parameter expression="${doapOptions}" * @since 1.0 */ private DoapOptions doapOptions; - /** - * The local repository where the artifacts are located. - * - * @parameter expression="${localRepository}" - * @required - * @readonly - * @since 1.0 - */ - private ArtifactRepository localRepository; - - /** - * The remote repositories where the artifacts are located. - * - * @parameter expression="${project.remoteArtifactRepositories}" - * @required - * @readonly - * @since 1.0 - */ - private List remoteRepositories; - // ---------------------------------------------------------------------- // Public methods // ---------------------------------------------------------------------- @@ -280,7 +291,7 @@ /** * Write DOAP name. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#name */ private void writeName( XMLWriter writer ) @@ -292,14 +303,13 @@ XmlWriterUtil.writeLineBreak( writer ); XmlWriterUtil.writeCommentText( writer, "A name of something.", 2 ); - // http://usefulinc.com/ns/doap#name DoapUtil.writeElement( writer, "name", project.getName() ); } /** * Write DOAP description. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#description * @see http://usefulinc.com/ns/doap#shortdesc */ @@ -312,16 +322,14 @@ XmlWriterUtil.writeLineBreak( writer ); XmlWriterUtil.writeCommentText( writer, "Plain text description of a project, of 2-4 sentences in length.", 2 ); - // http://usefulinc.com/ns/doap#description DoapUtil.writeElement( writer, "description", project.getDescription() ); - // http://usefulinc.com/ns/doap#shortdesc DoapUtil.writeElement( writer, "shortdesc", project.getDescription() ); } /** * Write DOAP created. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#created */ private void writeCreated( XMLWriter writer ) @@ -334,14 +342,13 @@ XmlWriterUtil.writeLineBreak( writer ); XmlWriterUtil.writeCommentText( writer, "Date when something was created, in YYYY-MM-DD form. e.g. 2004-04-05", 2 ); - // http://usefulinc.com/ns/doap#created DoapUtil.writeElement( writer, "created", project.getInceptionYear() + "-01-01" ); } /** * Write DOAP homepage and old-homepage. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#homepage * @see http://usefulinc.com/ns/doap#old-homepage */ @@ -352,7 +359,6 @@ XmlWriterUtil.writeLineBreak( writer ); XmlWriterUtil.writeCommentText( writer, "URL of a project's homepage, associated with exactly one project.", 2 ); - // http://usefulinc.com/ns/doap#homepage DoapUtil.writeRdfResourceElement( writer, "homepage", project.getUrl() ); } @@ -361,7 +367,6 @@ XmlWriterUtil.writeLineBreak( writer ); XmlWriterUtil .writeCommentText( writer, "URL of a project's past homepage, associated with exactly one project.", 2 ); - // http://usefulinc.com/ns/doap#old-homepage DoapUtil.writeRdfResourceElement( writer, "old-homepage", doapOptions.getOldHomepage() ); } } @@ -369,7 +374,7 @@ /** * Write DOAP programming-language. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#programming-language */ private void writeProgrammingLanguage( XMLWriter writer ) @@ -384,7 +389,6 @@ if ( StringUtils.isNotEmpty( language ) ) // backward compatible { - // http://usefulinc.com/ns/doap#programming-language DoapUtil.writeRdfResourceElement( writer, "programming-language", language ); } @@ -393,7 +397,6 @@ String[] languages = StringUtils.split( doapOptions.getProgrammingLanguage(), "," ); for ( int i = 0; i < languages.length; i++ ) { - // http://usefulinc.com/ns/doap#programming-language DoapUtil.writeRdfResourceElement( writer, "programming-language", languages[i].trim() ); } } @@ -402,7 +405,7 @@ /** * Write DOAP category. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#category */ private void writeCategory( XMLWriter writer ) @@ -418,7 +421,6 @@ if ( StringUtils.isNotEmpty( category ) ) // backward compatible { - // http://usefulinc.com/ns/doap#category DoapUtil.writeRdfResourceElement( writer, "category", "http://projects.apache.org/category/" + category ); } @@ -427,7 +429,6 @@ String[] categories = StringUtils.split( doapOptions.getCategory(), "," ); for ( int i = 0; i < categories.length; i++ ) { - // http://usefulinc.com/ns/doap#category DoapUtil.writeRdfResourceElement( writer, "category", "http://projects.apache.org/category/" + categories[i].trim() ); } @@ -437,7 +438,7 @@ /** * Write DOAP download-page and download-mirror. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#download-page * @see http://usefulinc.com/ns/doap#download-mirror */ @@ -455,7 +456,6 @@ { XmlWriterUtil.writeLineBreak( writer ); XmlWriterUtil.writeCommentText( writer, "Download page.", 2 ); - // http://usefulinc.com/ns/doap#download-page DoapUtil.writeRdfResourceElement( writer, "download-page", doapOptions.getDownloadPage() ); } @@ -466,7 +466,6 @@ String[] downloadMirrors = StringUtils.split( doapOptions.getDownloadMirror(), "," ); for ( int i = 0; i < downloadMirrors.length; i++ ) { - // http://usefulinc.com/ns/doap#download-mirror DoapUtil.writeRdfResourceElement( writer, "download-mirror", downloadMirrors[i].trim() ); } } @@ -475,7 +474,7 @@ /** * Write DOAP OS. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#os */ private void writeOS( XMLWriter writer ) @@ -491,7 +490,6 @@ String[] oses = StringUtils.split( doapOptions.getOs(), "," ); for ( int i = 0; i < oses.length; i++ ) { - // http://usefulinc.com/ns/doap#os DoapUtil.writeRdfResourceElement( writer, "os", oses[i].trim() ); } } @@ -499,7 +497,7 @@ /** * Write DOAP screenshots. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#screenshots */ private void writeScreenshots( XMLWriter writer ) @@ -511,14 +509,13 @@ XmlWriterUtil.writeLineBreak( writer ); XmlWriterUtil.writeCommentText( writer, "Web page with screenshots of project.", 2 ); - // http://usefulinc.com/ns/doap#screenshots DoapUtil.writeRdfResourceElement( writer, "screenshots", doapOptions.getScreenshots() ); } /** * Write DOAP wiki. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#wiki */ private void writeWiki( XMLWriter writer ) @@ -530,14 +527,13 @@ XmlWriterUtil.writeLineBreak( writer ); XmlWriterUtil.writeCommentText( writer, "URL of Wiki for collaborative discussion of project.", 2 ); - // http://usefulinc.com/ns/doap#wiki DoapUtil.writeRdfResourceElement( writer, "wiki", doapOptions.getWiki() ); } /** * Write DOAP licenses. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#license */ private void writeLicenses( XMLWriter writer ) @@ -557,7 +553,6 @@ if ( StringUtils.isNotEmpty( license.getUrl() ) ) { - // http://usefulinc.com/ns/doap#license DoapUtil.writeRdfResourceElement( writer, "license", license.getUrl() ); } else @@ -570,7 +565,7 @@ /** * Write DOAP bug-database. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#bug-database */ private void writeBugDatabase( XMLWriter writer ) @@ -584,7 +579,6 @@ XmlWriterUtil.writeCommentText( writer, "bug database.", 2 ); if ( StringUtils.isNotEmpty( project.getIssueManagement().getUrl() ) ) { - // http://usefulinc.com/ns/doap#bug-database DoapUtil.writeRdfResourceElement( writer, "bug-database", project.getIssueManagement().getUrl() ); } else @@ -596,7 +590,7 @@ /** * Write DOAP mailing-list. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#mailing-list */ private void writeMailingList( XMLWriter writer ) @@ -614,7 +608,6 @@ if ( StringUtils.isNotEmpty( mailingList.getArchive() ) ) { - // http://usefulinc.com/ns/doap#mailing-list DoapUtil.writeRdfResourceElement( writer, "mailing-list", mailingList.getArchive() ); } else @@ -630,7 +623,6 @@ if ( StringUtils.isNotEmpty( otherArchive ) ) { - // http://usefulinc.com/ns/doap#mailing-list DoapUtil.writeRdfResourceElement( writer, "mailing-list", otherArchive ); } else @@ -645,7 +637,7 @@ /** * Write all DOAP releases. * - * @param writer + * @param writer not null * @throws MojoExecutionException if any * @see http://usefulinc.com/ns/doap#release * @see http://usefulinc.com/ns/doap#Version @@ -699,9 +691,7 @@ addComment = true; } - // http://usefulinc.com/ns/doap#release writer.startElement( "release" ); - // http://usefulinc.com/ns/doap#Version writer.startElement( "Version" ); writer.startElement( "name" ); @@ -766,7 +756,7 @@ /** * Write all DOAP repositories. * - * @param writer + * @param writer not null * @see http://usefulinc.com/ns/doap#Repository * @see http://usefulinc.com/ns/doap#CVSRepository * @see http://usefulinc.com/ns/doap#SVNRepository @@ -815,24 +805,19 @@ if ( isScmSystem( repository, "cvs" ) ) { - // http://usefulinc.com/ns/doap#CVSRepository writer.startElement( "CVSRepository" ); CvsScmProviderRepository cvsRepo = (CvsScmProviderRepository) repository.getProviderRepository(); - // http://usefulinc.com/ns/doap#anon-root DoapUtil.writeElement( writer, "anon-root", cvsRepo.getCvsRoot() ); - // http://usefulinc.com/ns/doap#module DoapUtil.writeElement( writer, "module", cvsRepo.getModule() ); } else if ( isScmSystem( repository, "svn" ) ) { - // http://usefulinc.com/ns/doap#SVNRepository writer.startElement( "SVNRepository" ); SvnScmProviderRepository svnRepo = (SvnScmProviderRepository) repository.getProviderRepository(); - // http://usefulinc.com/ns/doap#location DoapUtil.writeRdfResourceElement( writer, "location", svnRepo.getUrl() ); } else @@ -850,11 +835,9 @@ throw new IllegalArgumentException( "The source repository connection is too short." ); } - // http://usefulinc.com/ns/doap#location DoapUtil.writeRdfResourceElement( writer, "location", connection.substring( 4 ) ); } - // http://usefulinc.com/ns/doap#browse DoapUtil.writeRdfResourceElement( writer, "browse", project.getScm().getUrl() ); writer.endElement(); // CVSRepository || SVNRepository || Repository @@ -958,6 +941,11 @@ * @see http://usefulinc.com/ns/doap#translator * @see http://usefulinc.com/ns/doap#tester * @see http://usefulinc.com/ns/doap#helper + * @see http://xmlns.com/foaf/0.1/Person + * @see http://xmlns.com/foaf/0.1/name + * @see http://xmlns.com/foaf/0.1/mbox + * @see http://xmlns.com/foaf/0.1/Organization + * @see http://xmlns.com/foaf/0.1/homepage */ private void writeDeveloperOrContributor( XMLWriter writer, List developersOrContributors, String doapType ) { @@ -1039,32 +1027,21 @@ continue; } - // http://usefulinc.com/ns/doap#maintainer - // http://usefulinc.com/ns/doap#developer - // http://usefulinc.com/ns/doap#documenter - // http://usefulinc.com/ns/doap#translator - // http://usefulinc.com/ns/doap#tester - // http://usefulinc.com/ns/doap#helper writer.startElement( doapType ); - // http://xmlns.com/foaf/0.1/Person writer.startElement( "foaf:Person" ); - // http://xmlns.com/foaf/0.1/name writer.startElement( "foaf:name" ); writer.writeText( name ); writer.endElement(); // foaf:name if ( StringUtils.isNotEmpty( email ) ) { - // http://xmlns.com/foaf/0.1/mbox DoapUtil.writeRdfResourceElement( writer, "foaf:mbox", "mailto:" + email ); } if ( StringUtils.isNotEmpty( organization ) ) { - // http://xmlns.com/foaf/0.1/Organization DoapUtil.writeRdfResourceElement( writer, "foaf:Organization", organization ); } if ( StringUtils.isNotEmpty( homepage ) ) { - // http://xmlns.com/foaf/0.1/homepage DoapUtil.writeRdfResourceElement( writer, "foaf:homepage", homepage ); } writer.endElement(); // foaf:Person