[GitHub] [commons-net] jkbkupczyk commented on a diff in pull request #162: Add FTPFile tests and fix Javadoc typos

2023-07-05 Thread via GitHub 


jkbkupczyk commented on code in PR #162:
URL: https://github.com/apache/commons-net/pull/162#discussion_r1253112065


##
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  _ACCESS  
constants) has the given access permission (one of the  _PERMISSION 

+ * 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  _ACCESS  
constants)
- * @param permission The access permission (one of the  _PERMISSION 
 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:
   done,
   removed _throws_ tag and added _todo_ message



-- 
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: issues-unsubscr...@commons.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [commons-net] jkbkupczyk commented on a diff in pull request #162: Add FTPFile tests and fix Javadoc typos

2023-07-05 Thread via GitHub 


jkbkupczyk commented on code in PR #162:
URL: https://github.com/apache/commons-net/pull/162#discussion_r1253103689


##
src/main/java/org/apache/commons/net/ftp/FTPFile.java:
##
@@ -466,6 +467,9 @@ public String toFormattedString(final String timezone) {
 
 /**
  * Gets a string representation of the FTPFile information.
+ * The returned output will be an FTP server raw listing.
+ *
+ * @see #getRawListing()
  *

Review Comment:
   done, I also removed the blank line in `toFormattedString` Javadoc



-- 
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: issues-unsubscr...@commons.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [commons-net] jkbkupczyk commented on a diff in pull request #162: Add FTPFile tests and fix Javadoc typos

2023-07-05 Thread via GitHub 


jkbkupczyk commented on code in PR #162:
URL: https://github.com/apache/commons-net/pull/162#discussion_r1253099624


##
src/main/java/org/apache/commons/net/ftp/FTPFile.java:
##
@@ -466,6 +467,9 @@ public String toFormattedString(final String timezone) {
 
 /**
  * Gets a string representation of the FTPFile information.
+ * The returned output will be an FTP server raw listing.

Review Comment:
   done



-- 
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: issues-unsubscr...@commons.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [commons-net] jkbkupczyk commented on a diff in pull request #162: Add FTPFile tests and fix javadoc typos

2023-07-05 Thread via GitHub 


jkbkupczyk commented on code in PR #162:
URL: https://github.com/apache/commons-net/pull/162#discussion_r1252994889


##
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  _ACCESS  
constants) has the given access permission (one of the  _PERMISSION 

+ * 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  _ACCESS  
constants)
- * @param permission The access permission (one of the  _PERMISSION 
 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:
   
[FTPListParseEngine](https://github.com/apache/commons-net/blob/master/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java)
 will use `FTPFile(String)` constructor (for invalid files) that sets 
`permissions` to `null`;



-- 
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: issues-unsubscr...@commons.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [commons-net] jkbkupczyk commented on a diff in pull request #162: Add FTPFile tests and fix javadoc typos

2023-07-05 Thread via GitHub 


jkbkupczyk commented on code in PR #162:
URL: https://github.com/apache/commons-net/pull/162#discussion_r1252994889


##
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  _ACCESS  
constants) has the given access permission (one of the  _PERMISSION 

+ * 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  _ACCESS  
constants)
- * @param permission The access permission (one of the  _PERMISSION 
 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:
   
[FTPListParseEngine](https://github.com/apache/commons-net/blob/master/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java)
 will use `FTPFile(String)` constructor that sets `permissions` to `null`;



-- 
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: issues-unsubscr...@commons.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org