You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2009/01/29 00:23:09 UTC
svn commit: r738665 - in
/maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools:
DefaultSiteTool.java SiteTool.java
Author: dennisl
Date: Wed Jan 28 23:23:09 2009
New Revision: 738665
URL: http://svn.apache.org/viewvc?rev=738665&view=rev
Log:
[MSHARED-91] Use a more consistent naming of methods in the API for SiteTool
Create SiteTool.populateParentMenu(...) and deprecate SiteTool.populateProjectParentMenu(...).
Create SiteTool.populateModulesMenu(...) and deprecate SiteTool.populateModules(...).
Modified:
maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java
maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java
Modified: maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java?rev=738665&r1=738664&r2=738665&view=diff
==============================================================================
--- maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java (original)
+++ maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/DefaultSiteTool.java Wed Jan 28 23:23:09 2009
@@ -537,10 +537,10 @@
if ( parentProject != null )
{
- populateProjectParentMenu( decorationModel, locale, project, parentProject, true );
+ populateParentMenu( decorationModel, locale, project, parentProject, true );
}
- populateModules( project, reactorProjects, localRepository, decorationModel, locale, true );
+ populateModulesMenu( project, reactorProjects, localRepository, decorationModel, locale, true );
if ( decorationModel.getBannerLeft() == null )
{
@@ -776,8 +776,8 @@
}
/** {@inheritDoc} */
- public void populateProjectParentMenu( DecorationModel decorationModel, Locale locale, MavenProject project,
- MavenProject parentProject, boolean keepInheritedRefs )
+ public void populateParentMenu( DecorationModel decorationModel, Locale locale, MavenProject project,
+ MavenProject parentProject, boolean keepInheritedRefs )
{
if ( decorationModel == null )
{
@@ -838,11 +838,32 @@
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ * @deprecated Please use {@link #populateParentMenu(DecorationModel, Locale, MavenProject, MavenProject, boolean)} instead
+ */
+ public void populateProjectParentMenu( DecorationModel decorationModel, Locale locale, MavenProject project,
+ MavenProject parentProject, boolean keepInheritedRefs )
+ {
+ populateParentMenu( decorationModel, locale, project, parentProject, keepInheritedRefs );
+ }
+
+ /**
+ * {@inheritDoc}
+ * @deprecated Please use {@link #populateModulesMenu(MavenProject, List, ArtifactRepository, DecorationModel, Locale, boolean)} instead
+ */
public void populateModules( MavenProject project, List reactorProjects, ArtifactRepository localRepository,
DecorationModel decorationModel, Locale locale, boolean keepInheritedRefs )
throws SiteToolException
{
+ populateModulesMenu( project, reactorProjects, localRepository, decorationModel, locale, keepInheritedRefs );
+ }
+
+ /** {@inheritDoc} */
+ public void populateModulesMenu( MavenProject project, List reactorProjects, ArtifactRepository localRepository,
+ DecorationModel decorationModel, Locale locale, boolean keepInheritedRefs )
+ throws SiteToolException
+ {
if ( project == null )
{
throw new IllegalArgumentException( "The parameter 'project' can not be null" );
Modified: maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java?rev=738665&r1=738664&r2=738665&view=diff
==============================================================================
--- maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java (original)
+++ maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java Wed Jan 28 23:23:09 2009
@@ -214,6 +214,19 @@
* @param parentProject a Maven parent project, not null.
* @param keepInheritedRefs used for inherited references.
*/
+ void populateParentMenu( DecorationModel decorationModel, Locale locale, MavenProject project,
+ MavenProject parentProject, boolean keepInheritedRefs );
+
+ /**
+ * Populate the parent menu part of the decoration model.
+ *
+ * @param decorationModel the Doxia DecorationModel, not null.
+ * @param locale the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.
+ * @param project a Maven project, not null.
+ * @param parentProject a Maven parent project, not null.
+ * @param keepInheritedRefs used for inherited references.
+ * @deprecated Please use {@link #populateParentMenu(DecorationModel, Locale, MavenProject, MavenProject, boolean)} instead
+ */
void populateProjectParentMenu( DecorationModel decorationModel, Locale locale, MavenProject project,
MavenProject parentProject, boolean keepInheritedRefs );
@@ -227,12 +240,28 @@
* @param locale the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.
* @param keepInheritedRefs used for inherited references.
* @throws SiteToolException if any
+ * @deprecated Please use {@link #populateModulesMenu(MavenProject, List, ArtifactRepository, DecorationModel, Locale, boolean)} instead
*/
void populateModules( MavenProject project, List reactorProjects, ArtifactRepository localRepository,
DecorationModel decorationModel, Locale locale, boolean keepInheritedRefs )
throws SiteToolException;
/**
+ * Populate the modules menu part of the decoration model.
+ *
+ * @param project a Maven project, not null.
+ * @param reactorProjects the Maven reactor projects, not null.
+ * @param localRepository the Maven local repository, not null.
+ * @param decorationModel the Doxia site descriptor model, not null.
+ * @param locale the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.
+ * @param keepInheritedRefs used for inherited references.
+ * @throws SiteToolException if any
+ */
+ void populateModulesMenu( MavenProject project, List reactorProjects, ArtifactRepository localRepository,
+ DecorationModel decorationModel, Locale locale, boolean keepInheritedRefs )
+ throws SiteToolException;
+
+ /**
* Init the <code>localesList</code> variable.
* <p>If the <code>locales</code> variable is available, the first valid token will be the
* <code>defaultLocale</code> for this instance of the Java Virtual Machine.</p>