From 9adeac949b3dbaa3c86b4a8cae4362f27f65ba6e Mon Sep 17 00:00:00 2001 From: Michael Osipov Date: Sat, 4 Nov 2023 16:39:08 +0100 Subject: [PATCH] Deprecate #getOutputName() in favor of #getOutputPath() --- .../org/apache/maven/reporting/MavenReport.java | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/apache/maven/reporting/MavenReport.java b/src/main/java/org/apache/maven/reporting/MavenReport.java index e1867fe..7b950b4 100644 --- a/src/main/java/org/apache/maven/reporting/MavenReport.java +++ b/src/main/java/org/apache/maven/reporting/MavenReport.java @@ -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. + *

+ * 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(); /**