Skip to content

Commit

Permalink
Deprecate #getOutputName() in favor of #getOutputPath()
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-o committed Nov 4, 2023
1 parent 8dd491a commit 9adeac9
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion src/main/java/org/apache/maven/reporting/MavenReport.java
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,22 @@ public interface MavenReport {
* Get the path relative to {@link #getReportOutputDirectory()} where the report's main output
* file will be written. The last component is the name of the file without any extension. The
* actual output extension will by added by the sink implementation.
* <p>
* Note: This method won't be {@code default} anymore when {@link #getOutputName()} is removed.
* You are advised to implement it as soon as possible.
*
* @return the relative path of this report
* @since 4.0.0
* @return the relative output path of this report
*/
default String getOutputPath() {
return getOutputName();
}

/**
* @deprecated Method name does not properly reflect its purpose. Implement and use
* {@link #getOutputPath()} instead.
*/
@Deprecated
String getOutputName();

/**
Expand Down

0 comments on commit 9adeac9

Please sign in to comment.