[MNG-5044] use maven-reporting-api 3.0 git-svn-id: https://svn.apache.org/repos/asf/maven/maven-2/branches/maven-2.2.x@1081596 13f79535-47bb-0310-9956-ffa450edef68
Project: http://git-wip-us.apache.org/repos/asf/maven/repo Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/268caef8 Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/268caef8 Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/268caef8 Branch: refs/heads/maven-2.2.x Commit: 268caef8e23063183635e1dfe61f17d8d15b1257 Parents: f1b3643 Author: Herve Boutemy <hbout...@apache.org> Authored: Mon Mar 14 22:37:58 2011 +0000 Committer: Herve Boutemy <hbout...@apache.org> Committed: Mon Mar 14 22:37:58 2011 +0000 ---------------------------------------------------------------------- maven-reporting/maven-reporting-api/pom.xml | 54 ------- .../org/apache/maven/reporting/MavenReport.java | 114 --------------- .../maven/reporting/MavenReportException.java | 55 ------- .../maven/reporting/MavenReportRenderer.java | 44 ------ .../src/main/resources/default-report.xml | 25 --- .../maven-reporting-api/src/site/apt/index.apt | 15 -- .../maven-reporting-api/src/site/site.xml | 6 - maven-reporting/pom.xml | 38 ----- maven-reporting/src/site/site.xml | 7 - pom.xml | 11 +- src/site/xdoc/index.xml | 2 +- 11 files changed, 6 insertions(+), 365 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/maven-reporting/maven-reporting-api/pom.xml ---------------------------------------------------------------------- diff --git a/maven-reporting/maven-reporting-api/pom.xml b/maven-reporting/maven-reporting-api/pom.xml deleted file mode 100644 index bb324b2..0000000 --- a/maven-reporting/maven-reporting-api/pom.xml +++ /dev/null @@ -1,54 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -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. ---><project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> - <modelVersion>4.0.0</modelVersion> - - <parent> - <groupId>org.apache.maven.reporting</groupId> - <artifactId>maven-reporting</artifactId> - <version>2.2.2-RC1-SNAPSHOT</version> - </parent> - - <artifactId>maven-reporting-api</artifactId> - - <name>Maven Reporting API</name> - - <developers> - <developer> - <id>vsiveton</id> - <name>Vincent Siveton</name> - <email>vincent.sive...@gmail.com</email> - <roles> - <role>Java Developer</role> - </roles> - <timezone>-5</timezone> - </developer> - </developers> - - <dependencies> - <dependency> - <groupId>org.apache.maven.doxia</groupId> - <artifactId>doxia-sink-api</artifactId> - </dependency> - <dependency> - <groupId>org.apache.maven.doxia</groupId> - <artifactId>doxia-logging-api</artifactId> - </dependency> - </dependencies> -</project> http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReport.java ---------------------------------------------------------------------- diff --git a/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReport.java b/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReport.java deleted file mode 100644 index 927c00c..0000000 --- a/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReport.java +++ /dev/null @@ -1,114 +0,0 @@ -package org.apache.maven.reporting; - -/* - * 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.codehaus.doxia.sink.Sink; - -import java.io.File; -import java.util.Locale; - -/** - * The basis for a Maven report. - * - * @author Brett Porter - * @author <a href="eveni...@apache.org">Emmanuel Venisse</a> - * @author <a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a> - * @version $Id$ - * @since 2.0 - */ -public interface MavenReport -{ - /** Plexus lookup name */ - String ROLE = MavenReport.class.getName(); - - /** Category for project information reports */ - String CATEGORY_PROJECT_INFORMATION = "Project Info"; - - /** Category for project reports */ - String CATEGORY_PROJECT_REPORTS = "Project Reports"; - - /** - * Generate the report depending the wanted locale. - * <br/> - * Mainly used for external reports like javadoc. - * - * @param sink the sink to use for the generation. - * @param locale the wanted locale to generate the report, could be null. - * @throws MavenReportException if any - */ - void generate( Sink sink, Locale locale ) - throws MavenReportException; - - /** - * @return the output name of this report. - */ - String getOutputName(); - - /** - * Get the category name for this report. - * - * @return the category name of this report. Should be <code>CATEGORY_PROJECT_INFORMATION</code> - * or <code>CATEGORY_PROJECT_REPORTS</code> - * {@link #CATEGORY_PROJECT_INFORMATION} - * {@link #CATEGORY_PROJECT_REPORTS} - */ - String getCategoryName(); - - /** - * @param locale the wanted locale to return the report's name, could be null. - * @return the name of this report. - */ - String getName( Locale locale ); - - /** - * @param locale the wanted locale to return the report's description, could be null. - * @return the description of this report. - */ - String getDescription( Locale locale ); - - /** - * Set a new output directory. Useful for staging. - * - * @param outputDirectory the new output directory - */ - void setReportOutputDirectory( File outputDirectory ); - - /** - * @return the current report output directory. - */ - File getReportOutputDirectory(); - - /** - * An external report is a report which calls a third party program which generates some reports too. - * A good example is javadoc tool. - * - * @return <tt>true</tt> if this report is external, <tt>false</tt> otherwise. - * Default should <tt>false</tt>. - */ - boolean isExternalReport(); - - /** - * Verify some conditions before generate the report. - * - * @return <tt>true</tt> if this report could be generated, <tt>false</tt> otherwise. - * Default should <tt>true</tt>. - */ - boolean canGenerateReport(); -} http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportException.java ---------------------------------------------------------------------- diff --git a/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportException.java b/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportException.java deleted file mode 100644 index 00b08a9..0000000 --- a/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportException.java +++ /dev/null @@ -1,55 +0,0 @@ -package org.apache.maven.reporting; - -/* - * 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 a Maven report. - * - * @author Brett Porter - * @author <a href="eveni...@apache.org">Emmanuel Venisse</a> - * @version $Id$ - * @since 2.0 - */ -public class MavenReportException extends Exception -{ - /** The serialVersionUID **/ - public static final long serialVersionUID = -6200353563231163785L; - - /** - * Default constructor. - * - * @param msg the exception message. - */ - public MavenReportException( String msg ) - { - super( msg ); - } - - /** - * Other constructor. - * - * @param msg the exception message. - * @param e the exception. - */ - public MavenReportException( String msg, Exception e ) - { - super( msg, e ); - } -} http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportRenderer.java ---------------------------------------------------------------------- diff --git a/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportRenderer.java b/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportRenderer.java deleted file mode 100644 index c3d40bf..0000000 --- a/maven-reporting/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportRenderer.java +++ /dev/null @@ -1,44 +0,0 @@ -package org.apache.maven.reporting; - -/* - * 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. - */ - -/** - * Basis for rendering report. - * - * @author <a href="mailto:ja...@maven.org";>Jason van Zyl</a> - * @author <a href="eveni...@apache.org">Emmanuel Venisse</a> - * @version $Id$ - * @since 2.0 - * @TODO Later it may be appropriate to create something like a VelocityMavenReportRenderer - * that could take a velocity template and pipe that through Doxia rather than coding - * them up like this. - */ -public interface MavenReportRenderer -{ - /** - * @return the wanted report's title. - */ - String getTitle(); - - /** - * Renderer a report. - */ - void render(); -} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/maven-reporting/maven-reporting-api/src/main/resources/default-report.xml ---------------------------------------------------------------------- diff --git a/maven-reporting/maven-reporting-api/src/main/resources/default-report.xml b/maven-reporting/maven-reporting-api/src/main/resources/default-report.xml deleted file mode 100644 index dde8d0d..0000000 --- a/maven-reporting/maven-reporting-api/src/main/resources/default-report.xml +++ /dev/null @@ -1,25 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<!-- -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. ---> - -<project name="${project.name}"> - <body> - ${reports} - </body> -</project> http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/maven-reporting/maven-reporting-api/src/site/apt/index.apt ---------------------------------------------------------------------- diff --git a/maven-reporting/maven-reporting-api/src/site/apt/index.apt b/maven-reporting/maven-reporting-api/src/site/apt/index.apt deleted file mode 100644 index e942ae8..0000000 --- a/maven-reporting/maven-reporting-api/src/site/apt/index.apt +++ /dev/null @@ -1,15 +0,0 @@ - ----- - Maven Reporting API - ----- - Hervé Boutemy - ----- - 2010-05-08 - ----- - -Maven Reporting API - - API to manage report generation. - - <<<maven-reporting-api>>> is included in Maven 2.x core distribution, but - {{{http://maven.apache.org/shared/maven-reporting-api/}moved to - shared components}} to achieve report decoupling from Maven 3 core. http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/maven-reporting/maven-reporting-api/src/site/site.xml ---------------------------------------------------------------------- diff --git a/maven-reporting/maven-reporting-api/src/site/site.xml b/maven-reporting/maven-reporting-api/src/site/site.xml deleted file mode 100644 index 15f431a..0000000 --- a/maven-reporting/maven-reporting-api/src/site/site.xml +++ /dev/null @@ -1,6 +0,0 @@ -<project> - <body> - <menu ref="parent"/> - <menu ref="reports"/> - </body> -</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/maven-reporting/pom.xml ---------------------------------------------------------------------- diff --git a/maven-reporting/pom.xml b/maven-reporting/pom.xml deleted file mode 100644 index 89a6440..0000000 --- a/maven-reporting/pom.xml +++ /dev/null @@ -1,38 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -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. ---><project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> - <modelVersion>4.0.0</modelVersion> - - <parent> - <groupId>org.apache.maven</groupId> - <artifactId>maven</artifactId> - <version>2.2.2-RC1-SNAPSHOT</version> - </parent> - - <groupId>org.apache.maven.reporting</groupId> - <artifactId>maven-reporting</artifactId> - <packaging>pom</packaging> - - <name>Maven Reporting</name> - <inceptionYear>2005</inceptionYear> - - <modules> - <module>maven-reporting-api</module> - </modules> -</project> http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/maven-reporting/src/site/site.xml ---------------------------------------------------------------------- diff --git a/maven-reporting/src/site/site.xml b/maven-reporting/src/site/site.xml deleted file mode 100644 index ee25331..0000000 --- a/maven-reporting/src/site/site.xml +++ /dev/null @@ -1,7 +0,0 @@ -<project> - <body> - <menu ref="parent"/> - <menu ref="modules"/> - <menu ref="reports"/> - </body> -</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 68a6e5f..b6a4c60 100644 --- a/pom.xml +++ b/pom.xml @@ -229,7 +229,6 @@ under the License. <module>maven-plugin-registry</module> <module>maven-profile</module> <module>maven-project</module> - <module>maven-reporting</module> <module>maven-repository-metadata</module> <module>maven-script</module> <module>maven-settings</module> @@ -279,11 +278,6 @@ under the License. <version>${mavenVersion}</version> </dependency> <dependency> - <groupId>org.apache.maven.reporting</groupId> - <artifactId>maven-reporting-api</artifactId> - <version>${mavenVersion}</version> - </dependency> - <dependency> <groupId>org.apache.maven</groupId> <artifactId>maven-repository-metadata</artifactId> <version>${mavenVersion}</version> @@ -355,6 +349,11 @@ under the License. <version>1.2</version> </dependency> <dependency> + <groupId>org.apache.maven.reporting</groupId> + <artifactId>maven-reporting-api</artifactId> + <version>3.0</version> + </dependency> + <dependency> <groupId>org.apache.maven.doxia</groupId> <artifactId>doxia-sink-api</artifactId> <version>${doxiaVersion}</version> http://git-wip-us.apache.org/repos/asf/maven/blob/268caef8/src/site/xdoc/index.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 26c5d8b..3ef50bb 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -46,7 +46,7 @@ <area shape="rect" coords="475,111,598,142" alt="maven-core" href="./maven-core/" /> <area shape="rect" coords="475,173,599,205" alt="maven-project" href="./maven-project/" /> <area shape="rect" coords="223,60,347,91" alt="maven-toolchain" href="./maven-toolchain/" /> - <area shape="rect" coords="142,110,267,142" alt="maven-reporting-api" href="./maven-reporting-api/" /> + <area shape="rect" coords="142,110,267,142" alt="maven-reporting-api" href="http://maven.apache.org/shared/maven-reporting-api/"; /> <area shape="rect" coords="106,151,266,182" alt="maven-error-diagnostics" href="./maven-error-diagnostics/" /> <area shape="rect" coords="174,189,267,220" alt="maven-monitor" href="./maven-monitor/" /> <area shape="rect" coords="0,226,267,259" alt="maven-plugin-parameter-documenter" href="./maven-plugin-parameter-documenter/" />
