You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2010/06/20 23:51:03 UTC

svn commit: r956420 - in /maven/plugins/trunk/maven-site-plugin: ./ src/main/java/org/apache/maven/plugins/site/ src/main/java/org/apache/maven/plugins/site/webapp/

Author: hboutemy
Date: Sun Jun 20 21:51:02 2010
New Revision: 956420

URL: http://svn.apache.org/viewvc?rev=956420&view=rev
Log:
[MSITE-487] use Java 5 generics (merged from 3.0.x branch r940318)

Modified:
    maven/plugins/trunk/maven-site-plugin/   (props changed)
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteMojo.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/CategorySummaryDocumentRenderer.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteRunMojo.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaBean.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaFilter.java

Propchange: maven/plugins/trunk/maven-site-plugin/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Sun Jun 20 21:51:02 2010
@@ -1 +1 @@
-/maven/plugins/branches/maven-site-plugin-3.x:956257
+/maven/plugins/branches/maven-site-plugin-3.x:940318,956257

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteMojo.java?rev=956420&r1=956419&r2=956420&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteMojo.java Sun Jun 20 21:51:02 2010
@@ -133,7 +133,8 @@ public abstract class AbstractSiteMojo
         return ( outputEncoding == null ) ? ReaderFactory.UTF_8 : outputEncoding;
     }
 
-    protected void populateReportItems( DecorationModel decorationModel, Locale locale, Map reportsByOutputName )
+    protected void populateReportItems( DecorationModel decorationModel, Locale locale,
+                                        Map<String, MavenReport> reportsByOutputName )
     {
         for ( Iterator i = decorationModel.getMenus().iterator(); i.hasNext(); )
         {
@@ -143,17 +144,18 @@ public abstract class AbstractSiteMojo
         }
     }
 
-    private void populateItemRefs( List items, Locale locale, Map reportsByOutputName )
+    private void populateItemRefs( List<MenuItem> items, Locale locale, Map<String, MavenReport> reportsByOutputName )
     {
-        for ( Iterator i = items.iterator(); i.hasNext(); )
+        for ( Iterator<MenuItem> i = items.iterator(); i.hasNext(); )
         {
-            MenuItem item = (MenuItem) i.next();
+            MenuItem item = i.next();
 
             if ( item.getRef() != null )
             {
-                if ( reportsByOutputName.containsKey( item.getRef() ) )
+                MavenReport report = reportsByOutputName.get( item.getRef() );
+
+                if ( report != null )
                 {
-                    MavenReport report = (MavenReport) reportsByOutputName.get( item.getRef() );
 
                     if ( item.getName() == null )
                     {

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java?rev=956420&r1=956419&r2=956420&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java Sun Jun 20 21:51:02 2010
@@ -304,7 +304,8 @@ public abstract class AbstractSiteRender
      * @return A map with all reports keyed by filename having the report itself as value.
      * The map will be used to populate a menu.
      */
-    protected Map locateReports( List reports, Map documents, Locale locale )
+    protected Map<String, MavenReport> locateReports( List<MavenReport> reports,
+                                                      Map<String, DocumentRenderer> documents, Locale locale )
     {
         Map reportsByOutputName = new HashMap();
         for ( Iterator i = reports.iterator(); i.hasNext(); )
@@ -341,12 +342,11 @@ public abstract class AbstractSiteRender
      * @param reports A Collection of MavenReports
      * @return A map keyed category having the report itself as value
      */
-    protected Map categoriseReports( Collection reports )
+    protected Map categoriseReports( Collection<MavenReport> reports )
     {
         Map categories = new HashMap();
-        for ( Iterator i = reports.iterator(); i.hasNext(); )
+        for ( MavenReport report : reports )
         {
-            MavenReport report = (MavenReport) i.next();
             List categoryReports = (List) categories.get( report.getCategoryName() );
             if ( categoryReports == null )
             {

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/CategorySummaryDocumentRenderer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/CategorySummaryDocumentRenderer.java?rev=956420&r1=956419&r2=956420&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/CategorySummaryDocumentRenderer.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/CategorySummaryDocumentRenderer.java Sun Jun 20 21:51:02 2010
@@ -34,7 +34,6 @@ import org.codehaus.plexus.i18n.I18N;
 import java.io.FileNotFoundException;
 import java.io.Writer;
 import java.util.Collections;
-import java.util.Iterator;
 import java.util.List;
 import java.util.Locale;
 
@@ -56,18 +55,18 @@ public class CategorySummaryDocumentRend
 
     private I18N i18n;
 
-    private List categoryReports;
+    private List<MavenReport> categoryReports;
 
     private final Log log;
 
     public CategorySummaryDocumentRenderer( RenderingContext renderingContext, String title, String desc1, String desc2,
-                                            I18N i18n, List categoryReports )
+                                            I18N i18n, List<MavenReport> categoryReports )
     {
         this( renderingContext, title, desc1, desc2, i18n, categoryReports, null );
     }
 
     public CategorySummaryDocumentRenderer( RenderingContext renderingContext, String title, String desc1, String desc2,
-                                            I18N i18n, List categoryReports, Log log )
+                                            I18N i18n, List<MavenReport> categoryReports, Log log )
     {
         this.renderingContext = renderingContext;
         this.title = title;
@@ -144,10 +143,8 @@ public class CategorySummaryDocumentRend
 
         if ( categoryReports != null )
         {
-            for ( Iterator i1 = categoryReports.iterator(); i1.hasNext(); )
+            for ( MavenReport report : categoryReports )
             {
-                MavenReport report = (MavenReport) i1.next();
-
                 sink.tableRow();
                 sink.tableCell();
                 sink.link( report.getOutputName() + ".html" );

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java?rev=956420&r1=956419&r2=956420&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java Sun Jun 20 21:51:02 2010
@@ -37,7 +37,6 @@ import java.io.IOException;
 import java.io.StringReader;
 import java.io.Writer;
 import java.util.HashMap;
-import java.util.Iterator;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
@@ -79,19 +78,17 @@ public class SiteDescriptorAttachMojo
     public void execute()
         throws MojoExecutionException
     {
-        List localesList = siteTool.getAvailableLocales( locales );
+        List<Locale> localesList = siteTool.getAvailableLocales( locales );
 
-        for ( Iterator iterator = localesList.iterator(); iterator.hasNext(); )
+        for ( Locale locale : localesList )
         {
-            Locale locale = (Locale) iterator.next();
-
             File descriptorFile = siteTool.getSiteDescriptorFromBasedir( toRelative( project.getBasedir(),
                                                                                      siteDirectory.getAbsolutePath() ),
                                                                          basedir, locale );
 
             if ( descriptorFile.exists() )
             {
-                Map props = new HashMap();
+                Map<String, String> props = new HashMap<String, String>();
                 props.put( "reports", "<menu ref=\"reports\"/>" );
                 props.put( "modules", "<menu ref=\"modules\"/>" );
 

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java?rev=956420&r1=956419&r2=956420&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java Sun Jun 20 21:51:02 2010
@@ -138,9 +138,9 @@ public class SiteMap
         sink.text( i18n.getString( "site-plugin", locale, "site.sitemap.description" ) );
         sink.paragraph_();
 
-        for ( Iterator it = decoration.getMenus().iterator(); it.hasNext(); )
+        for ( Iterator<Menu> it = decoration.getMenus().iterator(); it.hasNext(); )
         {
-            Menu menu = (Menu) it.next();
+            Menu menu = it.next();
 
             sink.section3();
             sink.sectionTitle3();
@@ -157,7 +157,7 @@ public class SiteMap
         sink.body_();
     }
 
-    private void extractItems( List items, Sink sink )
+    private void extractItems( List<MenuItem> items, Sink sink )
     {
         if ( items == null || items.isEmpty() )
         {
@@ -166,10 +166,8 @@ public class SiteMap
 
         sink.list();
 
-        for ( Iterator it = items.iterator(); it.hasNext(); )
+        for ( MenuItem item : items )
         {
-            MenuItem item = (MenuItem) it.next();
-
             sink.listItem();
             sink.link( item.getHref() );
             sink.text( item.getName() );

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteRunMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteRunMojo.java?rev=956420&r1=956419&r2=956420&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteRunMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteRunMojo.java Sun Jun 20 21:51:02 2010
@@ -160,21 +160,19 @@ public class SiteRunMojo
 
         List filteredReports = filterReports( reports );
 
-        List localesList = siteTool.getAvailableLocales( locales );
+        List<Locale> localesList = siteTool.getAvailableLocales( locales );
         webapp.setAttribute( DoxiaFilter.LOCALES_LIST_KEY, localesList );
 
         // Default is first in the list
-        Locale defaultLocale = (Locale) localesList.get( 0 );
+        Locale defaultLocale = localesList.get( 0 );
         Locale.setDefault( defaultLocale );
 
         try
         {
-            Map i18nDoxiaContexts = new HashMap();
+            Map<String, DoxiaBean> i18nDoxiaContexts = new HashMap<String, DoxiaBean>();
 
-            for ( Iterator it = localesList.iterator(); it.hasNext(); )
+            for ( Locale locale : localesList )
             {
-                Locale locale = (Locale) it.next();
-
                 SiteRenderingContext i18nContext = createSiteRenderingContext( locale );
                 i18nContext.setInputEncoding( getInputEncoding() );
                 i18nContext.setOutputEncoding( getOutputEncoding() );

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java?rev=956420&r1=956419&r2=956420&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java Sun Jun 20 21:51:02 2010
@@ -19,6 +19,10 @@ package org.apache.maven.plugins.site;
  * under the License.
  */
 
+
+import java.io.File;
+import java.util.List;
+
 import org.apache.maven.model.Site;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaBean.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaBean.java?rev=956420&r1=956419&r2=956420&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaBean.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaBean.java Sun Jun 20 21:51:02 2010
@@ -22,6 +22,7 @@ package org.apache.maven.plugins.site.we
 import java.io.File;
 import java.util.Map;
 
+import org.apache.maven.doxia.siterenderer.DocumentRenderer;
 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
 
 /**
@@ -34,7 +35,7 @@ public class DoxiaBean
 {
     private SiteRenderingContext context;
 
-    private Map documents;
+    private Map<String, DocumentRenderer> documents;
 
     private File generatedSiteDirectory;
 
@@ -43,7 +44,7 @@ public class DoxiaBean
      * @param documents
      * @param generatedSiteDirectory
      */
-    public DoxiaBean( SiteRenderingContext context, Map documents,
+    public DoxiaBean( SiteRenderingContext context, Map<String, DocumentRenderer> documents,
                                  File generatedSiteDirectory )
     {
         this.context = context;
@@ -61,12 +62,12 @@ public class DoxiaBean
         this.context = context;
     }
 
-    public Map getDocuments()
+    public Map<String, DocumentRenderer> getDocuments()
     {
         return documents;
     }
 
-    public void setDocuments( Map documents )
+    public void setDocuments( Map<String, DocumentRenderer> documents )
     {
         this.documents = documents;
     }

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaFilter.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaFilter.java?rev=956420&r1=956419&r2=956420&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaFilter.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/webapp/DoxiaFilter.java Sun Jun 20 21:51:02 2010
@@ -36,7 +36,6 @@ import javax.servlet.http.HttpServletReq
 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Iterator;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
@@ -57,9 +56,9 @@ public class DoxiaFilter
 
     private Renderer siteRenderer;
 
-    private Map i18nDoxiaContexts;
+    private Map<String, DoxiaBean> i18nDoxiaContexts;
 
-    private List localesList;
+    private List<Locale> localesList;
 
     /**
      * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
@@ -71,9 +70,9 @@ public class DoxiaFilter
 
         siteRenderer = (Renderer) servletContext.getAttribute( SITE_RENDERER_KEY );
 
-        i18nDoxiaContexts = (Map) servletContext.getAttribute( I18N_DOXIA_CONTEXTS_KEY );
+        i18nDoxiaContexts = (Map<String, DoxiaBean>) servletContext.getAttribute( I18N_DOXIA_CONTEXTS_KEY );
 
-        localesList = (List) servletContext.getAttribute( LOCALES_LIST_KEY );
+        localesList = (List<Locale>) servletContext.getAttribute( LOCALES_LIST_KEY );
     }
 
     /**
@@ -99,14 +98,12 @@ public class DoxiaFilter
 
         // Handle locale request
         SiteRenderingContext context;
-        Map documents;
+        Map<String, DocumentRenderer> documents;
         File generatedSiteDirectory;
 
         String localeWanted = null;
-        for ( Iterator it = localesList.iterator(); it.hasNext(); )
+        for ( Locale locale : localesList )
         {
-            Locale locale = (Locale) it.next();
-
             if ( path.startsWith( locale.getLanguage() + "/" ) )
             {
                 localeWanted = locale.toString();
@@ -116,7 +113,7 @@ public class DoxiaFilter
 
         if ( localeWanted == null )
         {
-            DoxiaBean defaultDoxiaBean = (DoxiaBean) i18nDoxiaContexts.get( "default" );
+            DoxiaBean defaultDoxiaBean = i18nDoxiaContexts.get( "default" );
             if ( defaultDoxiaBean == null )
             {
                 throw new ServletException( "No doxia bean found for the default locale" );
@@ -127,7 +124,7 @@ public class DoxiaFilter
         }
         else
         {
-            DoxiaBean i18nDoxiaBean = (DoxiaBean) i18nDoxiaContexts.get( localeWanted );
+            DoxiaBean i18nDoxiaBean = i18nDoxiaContexts.get( localeWanted );
             if ( i18nDoxiaBean == null )
             {
                 throw new ServletException( "No doxia bean found for the locale " + localeWanted );
@@ -174,7 +171,7 @@ public class DoxiaFilter
             context.addSiteDirectory( generatedSiteDirectory );
             try
             {
-                Map locateDocuments = siteRenderer.locateDocumentFiles( context );
+                Map<String, DocumentRenderer> locateDocuments = siteRenderer.locateDocumentFiles( context );
 
                 if ( locateDocuments.containsKey( path ) )
                 {
@@ -187,10 +184,9 @@ public class DoxiaFilter
                 throw new ServletException( e );
             }
 
-            List originalSiteDirectories = new ArrayList( context.getSiteDirectories() );
-            for ( Iterator i = originalSiteDirectories.iterator(); i.hasNext(); )
+            List<File> originalSiteDirectories = new ArrayList<File>( context.getSiteDirectories() );
+            for ( File dir : originalSiteDirectories )
             {
-                File dir = (File) i.next();
                 context.addSiteDirectory( dir );
             }
         }