[
https://issues.apache.org/jira/browse/IO-778?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17575810#comment-17575810
]
Gilles Sadowski commented on IO-778:
------------------------------------
Back to the OP's original topic: see e.g. "Document all exceptions" [quoted
here|https://blog.maskalik.com/blog/2018/09/12/best-practices-for-exceptions-in-java/]
(from J. Bloch's "Effective Java").
Not documenting low-level exceptions (mainly, NPE) is arguably OK.
> FileUtils.copyFile(File srcFile, File destFile): Missing
> IllegalArgumentException in Javadoc
> --------------------------------------------------------------------------------------------
>
> Key: IO-778
> URL: https://issues.apache.org/jira/browse/IO-778
> Project: Commons IO
> Issue Type: Wish
> Components: Utilities
> Affects Versions: 2.11.0
> Reporter: Rainer Hochreiter
> Priority: Trivial
>
> Method {{FileUtils.copyFile(File srcFile, File destFile)}} throwsÂ
> {{{}IllegalArgumentException{}}}, when called with identical files. This is
> not documented in Javadoc.
> The {{IllegalArgumentException}} is thrown by
> {{FileUtils.requireCanonicalPathsNotEquals(File file1, File file2)}} in
> {{FileUtils.copyFile(File srcFile, File destFile, final CopyOption...
> copyOptions).}}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
