maven-doxia-tools-1.2.1/ 0000755 0001750 0001750 00000000000 11633744576 015037 5 ustar twerner twerner maven-doxia-tools-1.2.1/pom.xml 0000644 0001750 0001750 00000013744 11377556202 016355 0 ustar twerner twerner
4.0.0
org.apache.maven.shared
maven-shared-components
15
org.apache.maven.shared
maven-doxia-tools
1.2.1
Maven Doxia Integration Tools
A collection of tools to help the integration of Doxia in Maven plugins.
2.0.6
scm:svn:http://svn.apache.org/repos/asf/maven/shared/tags/maven-doxia-tools-1.2.1
scm:svn:https://svn.apache.org/repos/asf/maven/shared/tags/maven-doxia-tools-1.2.1
http://svn.apache.org/viewvc/maven/shared/tags/maven-doxia-tools-1.2.1
jira
http://jira.codehaus.org/browse/MSHARED
1.1.3
1.1.3
2.0.6
commons-io
commons-io
1.4
org.apache.maven
maven-artifact
${mavenVersion}
org.apache.maven
maven-artifact-manager
${mavenVersion}
org.apache.maven
maven-model
${mavenVersion}
org.apache.maven
maven-project
${mavenVersion}
org.apache.maven.reporting
maven-reporting-api
${mavenVersion}
org.apache.maven
maven-plugin-api
${mavenVersion}
org.apache.maven.doxia
doxia-logging-api
${doxiaVersion}
org.apache.maven.doxia
doxia-decoration-model
${doxiaSitetoolsVersion}
org.codehaus.plexus
plexus-container-default
1.0-alpha-9
org.codehaus.plexus
plexus-i18n
1.0-beta-7
org.codehaus.plexus
plexus-component-api
org.codehaus.plexus
plexus-utils
1.4.5
org.apache.maven.shared
maven-plugin-testing-harness
1.0
test
org.codehaus.plexus
plexus-maven-plugin
create-component-descriptor
descriptor
org.codehaus.mojo
l10n-maven-plugin
1.0-alpha-2
ca
cs
da
de
es
fr
hu
it
ja
ko
lt
nl
no
pl
pt
pt_BR
sk
sv
tr
zh_CN
zh_TW
maven-doxia-tools-1.2.1/src/ 0000755 0001750 0001750 00000000000 11633744576 015626 5 ustar twerner twerner maven-doxia-tools-1.2.1/src/test/ 0000755 0001750 0001750 00000000000 11633744576 016605 5 ustar twerner twerner maven-doxia-tools-1.2.1/src/test/resources/ 0000755 0001750 0001750 00000000000 11633744576 020617 5 ustar twerner twerner maven-doxia-tools-1.2.1/src/test/resources/unit/ 0000755 0001750 0001750 00000000000 11633744576 021576 5 ustar twerner twerner maven-doxia-tools-1.2.1/src/test/resources/unit/no-site-test/ 0000755 0001750 0001750 00000000000 11633744576 024131 5 ustar twerner twerner maven-doxia-tools-1.2.1/src/test/resources/unit/no-site-test/pom.xml 0000644 0001750 0001750 00000002624 11152230410 025417 0 ustar twerner twerner
4.0.0
org.apache.maven.shared
no-site-test
1.0-SNAPSHOT
jar
dummy
junit
junit
3.8.2
test
maven-doxia-tools-1.2.1/src/test/resources/unit/site-tool-test/ 0000755 0001750 0001750 00000000000 11633744576 024472 5 ustar twerner twerner maven-doxia-tools-1.2.1/src/test/resources/unit/site-tool-test/pom.xml 0000644 0001750 0001750 00000002626 11152230410 025762 0 ustar twerner twerner
4.0.0
org.apache.maven.shared
site-tool-test
1.0-SNAPSHOT
jar
dummy
junit
junit
3.8.1
test
maven-doxia-tools-1.2.1/src/test/resources/unit/site-tool-test/src/ 0000755 0001750 0001750 00000000000 11633744576 025261 5 ustar twerner twerner maven-doxia-tools-1.2.1/src/test/resources/unit/site-tool-test/src/site/ 0000755 0001750 0001750 00000000000 11633744576 026225 5 ustar twerner twerner maven-doxia-tools-1.2.1/src/test/resources/unit/site-tool-test/src/site/site.xml 0000644 0001750 0001750 00000002645 11020006575 027676 0 ustar twerner twerner
Maven Site
http://maven.apache.org/images/apache-maven-project.png
http://maven.apache.org/
http://maven.apache.org/images/maven-small.gif
org.apache.maven.skins
maven-stylus-skin
* - to = "http://maven.apache.org" and from = "http://maven.apache.org"
* - return ""
* - to = "http://maven.apache.org" and from = "http://maven.apache.org/plugins/maven-site-plugin/"
* - return "../.."
* - to = "http://maven.apache.org/plugins/maven-site-plugin/" and from = "http://maven.apache.org"
* - return "plugins/maven-site-plugin"
* - to = "/myproject/myproject-module1" and from = "/myproject/myproject"
* - return "../myproject-module1"
*
* Note: The file separator depends on the system.
*
* @param to the to url of file as string
* @param from the from url of file as string
* @return a relative path from from to to.
*/
String getRelativePath( String to, String from );
/**
* Get a site descriptor from the project's base direcory.
*
* @param siteDirectory The path to the directory containing the site.xml file, relative to the
* project base directory. If null, using by default "src/site".
* @param basedir not null.
* @param locale the locale wanted for the site descriptor. If not null, searching for
* site_localeLanguage.xml, otherwise searching for site.xml.
* @return the site descriptor relative file, i.e. src/site/site.xml, depending on parameter values.
*/
File getSiteDescriptorFromBasedir( String siteDirectory, File basedir, Locale locale );
/**
* Get a site descriptor from one of the repositories.
*
* @param project the Maven project, not null.
* @param localRepository the Maven local repository, not null.
* @param repositories the Maven remote repositories, not null.
* @param locale the locale wanted for the site descriptor. If not null, searching for
* site_localeLanguage.xml, otherwise searching for site.xml.
* @return the site descriptor into the local repository after download of it from repositories or null if not
* found in repositories.
* @throws SiteToolException if any
*/
File getSiteDescriptorFromRepository( MavenProject project, ArtifactRepository localRepository, List repositories,
Locale locale )
throws SiteToolException;
/**
* Get a decoration model for a project.
*
* @param project the Maven project, not null.
* @param reactorProjects the Maven reactor projects, not null.
* @param localRepository the Maven local repository, not null.
* @param repositories the Maven remote repositories, not null.
* @param siteDirectory The path to the directory containing the site.xml file, relative to the
* project base directory. If null, using by default "src/site".
* @param locale the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.
* @param inputEncoding the input encoding of the site descriptor, not null.
* @param outputEncoding the output encoding wanted, not null.
* @return the DecorationModel object corresponding to the site.xml file with some
* interpolations.
* @throws SiteToolException if any
*/
DecorationModel getDecorationModel( MavenProject project, List reactorProjects, ArtifactRepository localRepository,
List repositories, String siteDirectory, Locale locale, String inputEncoding,
String outputEncoding )
throws SiteToolException;
/**
* Populate the reports 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 categories a map to put on the decoration model, not null.
*/
void populateReportsMenu( DecorationModel decorationModel, Locale locale, Map categories );
/**
* Interpolating several expressions in the site descriptor content. Actually, the expressions can be in
* the project, the environment variables and the specific properties like encoding.
*
* For instance:
*
* - ${project.name}
* - The value from the POM of:
*
* <project>
* <name>myProjectName</name>
* </project>
*
* - ${my.value}
* - The value from the POM of:
*
* <properties>
* <my.value>hello</my.value>
* </properties>
*
* - ${JAVA_HOME}
* - The value of JAVA_HOME in the environment variables
*
*
* @param props a map used for interpolation, not null.
* @param aProject a Maven project, not null.
* @param inputEncoding the input encoding of the site descriptor, not null.
* @param outputEncoding the output encoding wanted, not null.
* @param siteDescriptorContent the site descriptor file, not null.
* @return the site descriptor content based on the site.xml file with interpolated strings.
* @throws SiteToolException if errors happened during the interpolation.
*/
String getInterpolatedSiteDescriptorContent( Map props, MavenProject aProject, String siteDescriptorContent,
String inputEncoding, String outputEncoding )
throws SiteToolException;
/**
* Returns the parent POM with interpolated URLs. Attempts to source this value from the
* reactorProjects parameters if available (reactor env model attributes
* are interpolated), or if the reactor is unavailable (-N) resorts to the
* project.getParent().getUrl() value which will NOT have been interpolated.
*
* TODO: once bug is fixed in Maven proper, remove this.
*
* @param aProject a Maven project, not null.
* @param reactorProjects the Maven reactor projects, not null.
* @param localRepository the Maven local repository, not null.
* @return the parent project with interpolated URLs.
*/
MavenProject getParentProject( MavenProject aProject, List reactorProjects, ArtifactRepository localRepository );
/**
* 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.
*/
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 );
/**
* 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
* @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 localesList variable.
* If the locales variable is available, the first valid token will be the
* defaultLocale for this instance of the Java Virtual Machine.
*
* @param locales A comma separated list of locales supported by Maven. The first valid token will be the
* default Locale for this instance of the Java Virtual Machine.
* @return a list of Locale
*/
List getAvailableLocales( String locales );
/**
* Converts a locale code like "en", "en_US" or "en_US_win" to a java.util.Locale
* object.
* If localeCode = default, return the current value of the default locale for this instance
* of the Java Virtual Machine.
*
* @param localeCode the locale code string.
* @return a java.util.Locale object instancied or null if errors occurred
* @see java.util.Locale#getDefault()
*/
Locale codeToLocale( String localeCode );
}
maven-doxia-tools-1.2.1/src/main/java/org/apache/maven/doxia/tools/SiteToolException.java 0000644 0001750 0001750 00000004204 11020006575 031315 0 ustar twerner twerner package org.apache.maven.doxia.tools;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* An exception occurring during the execution of this tool.
*
* @author Vincent Siveton
* @version $Id: SiteToolException.java 661727 2008-05-30 14:21:49Z bentmann $
*/
public class SiteToolException
extends Exception
{
/** serialVersionUID */
static final long serialVersionUID = 2331441332996055959L;
/**
* Construct a new SiteToolException exception wrapping an underlying Exception
* and providing a message.
*
* @param message could be null
* @param cause could be null
*/
public SiteToolException( String message, Exception cause )
{
super( message, cause );
}
/**
* Construct a new SiteToolException exception wrapping an underlying Throwable
* and providing a message.
*
* @param message could be null
* @param cause could be null
*/
public SiteToolException( String message, Throwable cause )
{
super( message, cause );
}
/**
* Construct a new SiteToolException exception providing a message.
*
* @param message could be null
*/
public SiteToolException( String message )
{
super( message );
}
}
maven-doxia-tools-1.2.1/src/main/java/org/apache/maven/doxia/tools/ReportComparator.java 0000644 0001750 0001750 00000003654 11004716073 031212 0 ustar twerner twerner package org.apache.maven.doxia.tools;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.reporting.MavenReport;
import java.text.Collator;
import java.util.Comparator;
import java.util.Locale;
/**
* Sorts reports.
*
* @author Brett Porter
* @version $Id: ReportComparator.java 651860 2008-04-26 21:18:51Z dennisl $
* @todo move to reporting API?
* @todo allow reports to define their order in some other way?
*/
public class ReportComparator
implements Comparator
{
/** the local */
private final Locale locale;
/**
* Default constructor.
*
* @param locale not null
*/
public ReportComparator( Locale locale )
{
if ( locale == null )
{
throw new IllegalArgumentException( "locale should be defined" );
}
this.locale = locale;
}
/** {@inheritDoc} */
public int compare( Object o1, Object o2 )
{
MavenReport r1 = (MavenReport) o1;
MavenReport r2 = (MavenReport) o2;
Collator collator = Collator.getInstance( locale );
return collator.compare( r1.getName( locale ), r2.getName( locale ) );
}
}