[jira] [Updated] (MNG-7393) API change: let `canGenerateReport` throw an Exception

["Benjamin Marwell (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/MNG-7393?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Benjamin Marwell updated MNG-7393:
----------------------------------
    Description: 
Hi everyone,

the `{{{}AbstractReportMojo{}}}` declares a method `{{{}canGenerateReport(){}}}`.

However, it is unable to throw any exceptions. Not even {{MojoExecutionEx}} or {{{}MavenReportEx{}}}, which is most unfortunate.

It is being used twice:

Once in {{execute() throws MojoExEx}}

and in

{{generate() throws MavenReportEx}} (and is called by execute()).

This way, there is no way for reporting plugins to scan for files, because {{FileUtils::getFiles}} DOES throw a {{{}IOException{}}}, which then cannot be wrapped. However, the {{IOException}} from that method is useless anyway, because it is never declared in any methods it calls.

Therefore please consider:
 * Declaring any Exception on `{{{}canGenerateReports(){}}}`
 * Removing the declared {{IOException}} in PlexusUtils ([PR exists|https://github.com/codehaus-plexus/plexus-utils/issues/180]) and Maven-Utils (issue: tbd).

Thanks!

 

  was:
Hi everyone,

the `AbstractReportMojo` declares a method `canGenerateReport`.

However, it is unable to throw any exceptions. Not even MojoExecutionEx or MavenReportEx, which is most unfortunate.

It is being used twice:

Once in execute() throws MojoExEx

and in

generate() throws MavenReportEx (and is called by execute()).

This way, there is no way for reporting plugins to scan for files, because FileUtils::getFiles DOES throw a IOException, which then cannot be wrapped. However, the IOException from that method is useless anyway, because it is never declared in any methods it calls.

Therefore please consider:
 * Declaring any Exception on `canGenerateReports`
 * Removing the declared IOException in PlexusUtils ([PR exists|https://github.com/codehaus-plexus/plexus-utils/issues/180]) and Maven-Utils (issue: tbd).

Thanks!

 


> API change: let `canGenerateReport` throw an Exception
> ------------------------------------------------------
>
>                 Key: MNG-7393
>                 URL: https://issues.apache.org/jira/browse/MNG-7393
>             Project: Maven
>          Issue Type: Improvement
>            Reporter: Benjamin Marwell
>            Priority: Major
>
> Hi everyone,
> the `{{{}AbstractReportMojo{}}}` declares a method `{{{}canGenerateReport(){}}}`.
> However, it is unable to throw any exceptions. Not even {{MojoExecutionEx}} or {{{}MavenReportEx{}}}, which is most unfortunate.
> It is being used twice:
> Once in {{execute() throws MojoExEx}}
> and in
> {{generate() throws MavenReportEx}} (and is called by execute()).
> This way, there is no way for reporting plugins to scan for files, because {{FileUtils::getFiles}} DOES throw a {{{}IOException{}}}, which then cannot be wrapped. However, the {{IOException}} from that method is useless anyway, because it is never declared in any methods it calls.
> Therefore please consider:
>  * Declaring any Exception on `{{{}canGenerateReports(){}}}`
>  * Removing the declared {{IOException}} in PlexusUtils ([PR exists|https://github.com/codehaus-plexus/plexus-utils/issues/180]) and Maven-Utils (issue: tbd).
> Thanks!
>  



--
This message was sent by Atlassian Jira
(v8.20.1#820001)