Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 17 additions & 19 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<?xml version='1.0' encoding='UTF-8'?>

<?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
Expand All @@ -18,14 +17,13 @@ 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.shared</groupId>
<artifactId>maven-shared-components</artifactId>
<version>34</version>
<version>49</version>
<relativePath />
</parent>

Expand All @@ -51,8 +49,8 @@ under the License.
<scm>
<connection>scm:git:https://gitbox.apache.org/repos/asf/maven-reporting-api.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-reporting-api.git</developerConnection>
<url>https://github.com/apache/maven-reporting-api/tree/${project.scm.tag}</url>
<tag>HEAD</tag>
<url>https://github.com/apache/maven-reporting-api/tree/${project.scm.tag}</url>
</scm>
<issueManagement>
<system>jira</system>
Expand All @@ -68,11 +66,24 @@ under the License.
<url>scm:svn:https://svn.apache.org/repos/asf/maven/website/components/${maven.site.path}</url>
</site>
</distributionManagement>

<properties>
<javaVersion>7</javaVersion>
<project.build.outputTimestamp>2022-07-29T20:28:12Z</project.build.outputTimestamp>
</properties>
<dependencies>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-sink-api</artifactId>
<version>1.11.1</version>
<exclusions>
<exclusion>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-container-default</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>

<build>
<pluginManagement>
Expand All @@ -90,17 +101,4 @@ under the License.
</plugins>
</pluginManagement>
</build>
<dependencies>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-sink-api</artifactId>
<version>1.11.1</version>
<exclusions>
<exclusion>
<artifactId>plexus-container-default</artifactId>
<groupId>org.codehaus.plexus</groupId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
</project>
16 changes: 6 additions & 10 deletions src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
package org.apache.maven.reporting;

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand All @@ -9,7 +7,7 @@
* "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
* 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
Expand All @@ -18,12 +16,13 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.reporting;

import java.util.Locale;

import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkFactory;

import java.util.Locale;

/**
* Interface created separately for backwards compatibility. This method
* would ideally have been added in the {@link MavenReport} interface, and the other 'generate'
Expand All @@ -33,16 +32,13 @@
* @see MavenReport#generate(org.codehaus.doxia.sink.Sink, Locale)
* @since 3.0 (copied in maven-site-plugin 2.0-beta-6)
*/
public interface MavenMultiPageReport
extends MavenReport
{
public interface MavenMultiPageReport extends MavenReport {
/**
* Generate multi page report.
*
* @param sink The sink to write to.
* @param locale The locale to use.
* @throws MavenReportException if an error occurs.
*/
void generate( Sink sink, SinkFactory sinkFactory, Locale locale )
throws MavenReportException;
void generate(Sink sink, SinkFactory sinkFactory, Locale locale) throws MavenReportException;
}
21 changes: 9 additions & 12 deletions src/main/java/org/apache/maven/reporting/MavenReport.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
package org.apache.maven.reporting;

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand All @@ -9,7 +7,7 @@
* "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
* 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
Expand All @@ -18,12 +16,13 @@
* specific language governing permissions and limitations
* under the License.
*/

import org.codehaus.doxia.sink.Sink;
package org.apache.maven.reporting;

import java.io.File;
import java.util.Locale;

import org.codehaus.doxia.sink.Sink;

/**
* The basis for a Maven report.
*
Expand All @@ -32,8 +31,7 @@
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @since 2.0
*/
public interface MavenReport
{
public interface MavenReport {
/** Plexus lookup name */
String ROLE = MavenReport.class.getName();

Expand All @@ -52,8 +50,7 @@ public interface MavenReport
* @param locale the wanted locale to generate the report, could be null.
* @throws MavenReportException if any
*/
void generate( Sink sink, Locale locale )
throws MavenReportException;
void generate(Sink sink, Locale locale) throws MavenReportException;

/**
* Get the base name used to create report's output file(s).
Expand All @@ -76,22 +73,22 @@ void generate( Sink sink, Locale locale )
* @param locale the wanted locale to return the report's name, could be null.
* @return the name of this report.
*/
String getName( Locale locale );
String getName(Locale locale);

/**
* Get the localized report description.
*
* @param locale the wanted locale to return the report's description, could be null.
* @return the description of this report.
*/
String getDescription( Locale locale );
String getDescription(Locale locale);

/**
* Set a new output directory. Useful for staging.
*
* @param outputDirectory the new output directory
*/
void setReportOutputDirectory( File outputDirectory );
void setReportOutputDirectory(File outputDirectory);

/**
* @return the current report output directory.
Expand Down
19 changes: 7 additions & 12 deletions src/main/java/org/apache/maven/reporting/MavenReportException.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
package org.apache.maven.reporting;

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand All @@ -9,7 +7,7 @@
* "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
* 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
Expand All @@ -18,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.reporting;

/**
* An exception occurring during the execution of a Maven report.
Expand All @@ -26,9 +25,7 @@
* @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
* @since 2.0
*/
public class MavenReportException
extends Exception
{
public class MavenReportException extends Exception {
/** The serialVersionUID **/
public static final long serialVersionUID = -6200353563231163785L;

Expand All @@ -37,9 +34,8 @@ public class MavenReportException
*
* @param msg the exception message.
*/
public MavenReportException( String msg )
{
super( msg );
public MavenReportException(String msg) {
super(msg);
}

/**
Expand All @@ -48,8 +44,7 @@ public MavenReportException( String msg )
* @param msg the exception message.
* @param cause the cause.
*/
public MavenReportException( String msg, Exception cause )
{
super( msg, cause );
public MavenReportException(String msg, Exception cause) {
super(msg, cause);
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
package org.apache.maven.reporting;

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
Expand All @@ -9,7 +7,7 @@
* "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
* 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
Expand All @@ -18,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.reporting;

/**
* Basis for rendering report.
Expand All @@ -29,8 +28,7 @@
* that could take a velocity template and pipe that through Doxia rather than coding
* them up like this.
*/
public interface MavenReportRenderer
{
public interface MavenReportRenderer {
/**
* @return the wanted report's title.
*/
Expand All @@ -40,4 +38,4 @@ public interface MavenReportRenderer
* Renderer a report.
*/
void render();
}
}
Loading