garydgregory commented on code in PR #162:
URL: https://github.com/apache/commons-net/pull/162#discussion_r1253053996
##########
src/main/java/org/apache/commons/net/ftp/FTPFile.java:
##########
@@ -330,13 +330,14 @@ public void setName(final String name) {
}
/**
- * Sets if the given access group (one of the <code> _ACCESS </code>
constants) has the given access permission (one of the <code> _PERMISSION
</code>
+ * Sets if the given access group (one of the {@code _ACCESS} constants)
has the given access permission (one of the {@code _PERMISSION}
* constants) to the file.
*
- * @param access The access group (one of the <code> _ACCESS </code>
constants)
- * @param permission The access permission (one of the <code> _PERMISSION
</code> constants)
- * @param value True if permission is allowed, false if not.
+ * @param access The access group (one of the {@code _ACCESS}
constants)
+ * @param permission The access permission (one of the {@code _PERMISSION}
constants)
+ * @param value {@code true} if permission is allowed, {@code false}
if not.
* @throws ArrayIndexOutOfBoundsException if either of the parameters is
out of range
+ * @throws NullPointerException if you're trying to set permission of an
invalid file
Review Comment:
That's not a "feature" and should not be documented but fixed in a different
PR or commit. IOW, if null input is illegal it should be made so in a setter or
ctor IMO.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
