Skip to content

Commit

Permalink
No need for blank Javadoc lines between Javadoc @ tags
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Nov 28, 2024
1 parent b7c5fe5 commit d678126
Show file tree
Hide file tree
Showing 28 changed files with 0 additions and 69 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ public interface DatagramSocketFactory {
* Creates a DatagramSocket on the local host at the first available port.
*
* @return the socket
*
* @throws SocketException If the socket could not be created.
*/
DatagramSocket createDatagramSocket() throws SocketException;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ public PrintCommandListener(final PrintStream printStream) {
*
* @param printStream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
*
* @since 3.0
*/
@SuppressWarnings("resource")
Expand All @@ -66,7 +65,6 @@ public PrintCommandListener(final PrintStream printStream, final boolean suppres
* @param printStream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
*
* @since 3.0
*/
@SuppressWarnings("resource")
Expand All @@ -81,7 +79,6 @@ public PrintCommandListener(final PrintStream printStream, final boolean suppres
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @param showDirection if {@code true}, add {@code "> "} or {@code "< "} as appropriate to the output
*
* @since 3.0
*/
@SuppressWarnings("resource")
Expand All @@ -103,7 +100,6 @@ public PrintCommandListener(final PrintWriter writer) {
*
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
*
* @since 3.0
*/
public PrintCommandListener(final PrintWriter writer, final boolean suppressLogin) {
Expand All @@ -116,7 +112,6 @@ public PrintCommandListener(final PrintWriter writer, final boolean suppressLogi
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
*
* @since 3.0
*/
public PrintCommandListener(final PrintWriter writer, final boolean suppressLogin, final char eolMarker) {
Expand All @@ -130,7 +125,6 @@ public PrintCommandListener(final PrintWriter writer, final boolean suppressLogi
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @param showDirection if {@code true}, add {@code ">} " or {@code "< "} as appropriate to the output
*
* @since 3.0
*/
public PrintCommandListener(final PrintWriter writer, final boolean suppressLogin, final char eolMarker, final boolean showDirection) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ public int receive(final byte[] data) throws IOException {
*
* @param data the buffer to receive the input
* @param length of the buffer
*
* @return Length of actual data received.
* @throws IOException If an error occurs while receiving the data.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ public int getPort() {
*
* @param request incoming DatagramPacket
* @param rcvTime time packet received
*
* @throws IOException if an I/O error occurs.
*/
protected void handlePacket(final DatagramPacket request, final long rcvTime) throws IOException {
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/org/apache/commons/net/ftp/FTP.java
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,6 @@ public void disconnect() throws IOException {
* </ul>
*
* @see "http://www.faqs.org/rfcs/rfc2428.html"
*
* @param host The host owning the port.
* @param port The new port.
* @return The reply code received from the server.
Expand Down Expand Up @@ -683,7 +682,6 @@ public String getReplyString() {
* Returns the nth line of text from the last FTP server response as a string. The end of line markers of each are stripped from the line.
*
* @param index The index of the line to return, 0-based.
*
* @return The lines of text from the last FTP response as an array.
*/
String getReplyString(final int index) {
Expand Down
11 changes: 0 additions & 11 deletions src/main/java/org/apache/commons/net/ftp/FTPClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -1275,7 +1275,6 @@ public void disconnect() throws IOException {
* @param command The command to invoke
* @param params The parameters string, may be {@code null}
* @return True if successfully completed, false if not, in which case call {@link #getReplyCode()} or {@link #getReplyString()} to get the reason.
*
* @throws IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server.
* @since 3.0
*/
Expand Down Expand Up @@ -1405,7 +1404,6 @@ public boolean features() throws IOException {
* Queries the server for a supported feature, and returns its value (if any). Caches the parsed response to avoid resending the command repeatedly.
*
* @param feature the feature to check
*
* @return if the feature is present, returns the feature value or the empty string if the feature exists but has no value. Returns {@code null} if the
* feature is not found or the command failed. Check {@link #getReplyCode()} or {@link #getReplyString()} if so.
* @throws IOException on error
Expand All @@ -1423,7 +1421,6 @@ public String featureValue(final String feature) throws IOException {
* Queries the server for a supported feature, and returns its values (if any). Caches the parsed response to avoid resending the command repeatedly.
*
* @param feature the feature to check
*
* @return if the feature is present, returns the feature values (empty array if none) Returns {@code null} if the feature is not found or the command
* failed. Check {@link #getReplyCode()} or {@link #getReplyString()} if so.
* @throws IOException on error
Expand Down Expand Up @@ -1737,7 +1734,6 @@ public int getSendDataSocketBufferSize() {
* Issue the FTP SIZE command to the server for a given pathname. This should produce the size of the file.
*
* @param pathname the file name
*
* @return The size information returned by the server; {@code null} if there was an error
* @throws FTPConnectionClosedException If the FTP server prematurely closes the connection as a result of the client being idle or some other reason
* causing the server to send FTP reply code 421. This exception may be caught either as an IOException or
Expand Down Expand Up @@ -1772,7 +1768,6 @@ public String getStatus() throws IOException {
* Issue the FTP STAT command to the server for a given pathname. This should produce a listing of the file or directory.
*
* @param pathname the file name
*
* @return The status information returned by the server.
* @throws FTPConnectionClosedException If the FTP server prematurely closes the connection as a result of the client being idle or some other reason
* causing the server to send FTP reply code 421. This exception may be caught either as an IOException or
Expand Down Expand Up @@ -1873,7 +1868,6 @@ public boolean hasFeature(final String feature) throws IOException {
*
* @param feature the name of the feature; it is converted to upper case.
* @param value the value to find.
*
* @return {@code true} if the feature is present, {@code false} if the feature is not present or the {@link #feat()} command failed. Check
* {@link #getReplyCode()} or {@link #getReplyString()} if it is necessary to distinguish these cases.
*
Expand Down Expand Up @@ -2023,7 +2017,6 @@ private FTPListParseEngine initiateListParsing(final FTPFileEntryParser parser,
* </pre>
*
* @param pathname the starting directory
*
* @return A FTPListParseEngine object that holds the raw information and is capable of providing parsed FTPFile objects, one for each file containing
* information contained in the given path in the format determined by the {@code parser} parameter. Null will be returned if a data connection
* cannot be opened. If the current working directory contains no files, an empty array will be the return.
Expand Down Expand Up @@ -2059,7 +2052,6 @@ public FTPListParseEngine initiateListParsing(final String pathname) throws IOEx
* is not defined the SYST command is used to provide the value. To allow for arbitrary system types, the return from the SYST command is
* used to look up an alias for the type in the {@link #SYSTEM_TYPE_PROPERTIES} properties file if it is available.
* @param pathname the starting directory
*
* @return A FTPListParseEngine object that holds the raw information and is capable of providing parsed FTPFile objects, one for each file containing
* information contained in the given path in the format determined by the {@code parser} parameter. Null will be returned if a data connection
* cannot be opened. If the current working directory contains no files, an empty array will be the return.
Expand Down Expand Up @@ -2120,7 +2112,6 @@ public FTPListParseEngine initiateMListParsing(final String pathname) throws IOE
* restores the old behavior. To enable this by default, use the system property {@link FTPClient#FTP_IP_ADDRESS_FROM_PASV_RESPONSE}.
*
* @return True, if the IP address from the server's response will be used (pre-3.9 compatible behavior), or false (ignore that IP address).
*
* @see FTPClient#FTP_IP_ADDRESS_FROM_PASV_RESPONSE
* @see #setIpAddressFromPasvResponse(boolean)
* @since 3.9.0
Expand Down Expand Up @@ -2641,7 +2632,6 @@ public boolean reinitialize() throws IOException {
* The other server must have had a {@code remoteRetrieve} issued to it by another FTPClient.
*
* @param fileName The name of the file to be appended to, or if the file does not exist, the name to call the file being stored.
*
* @return True if successfully completed, false if not.
* @throws FTPConnectionClosedException If the FTP server prematurely closes the connection as a result of the client being idle or some other reason
* causing the server to send FTP reply code 421. This exception may be caught either as an IOException or
Expand Down Expand Up @@ -3124,7 +3114,6 @@ public boolean setModificationTime(final String pathname, final String timeval)
* set the factory used for parser creation to the supplied factory object.
*
* @param parserFactory factory object used to create FTPFileEntryParsers
*
* @see org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory
* @see org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ public interface FTPFileEntryParser {
* The default implementation can be a no-op.
*
* @param original Original list after it has been created from the server stream
*
* @return Original list as processed by this method.
*/
List<String> preParse(List<String> original);
Expand All @@ -92,7 +91,6 @@ public interface FTPFileEntryParser {
* particular ftp system being parsed. In many but not all cases, this can be defined simply by calling BufferedReader.readLine().
*
* @param reader The BufferedReader object from which entries are to be read.
*
* @return A string representing the next ftp entry or null if none found.
* @throws IOException thrown on any IO Error reading from the reader.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ public FTPFileEntryParserImpl() {
* This default implementation does nothing.
*
* @param original Original list after it has been created from the server stream
*
* @return {@code original} unmodified.
*/
@Override
Expand All @@ -52,7 +51,6 @@ public List<String> preParse(final List<String> original) {
* BufferedReader.readLine().
*
* @param reader The BufferedReader object from which entries are to be read.
*
* @return A string representing the next ftp entry or null if none found.
* @throws IOException thrown on any IO Error reading from the reader.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ public FTPListParseEngine(final FTPFileEntryParser parser) {
* before being added to the array.
*
* @param filter FTPFileFilter, must not be {@code null}.
*
* @return a list of FTPFile objects containing the whole list of files returned by the server as read by this object's parser.
* <p>
* <strong> NOTE:</strong> This array may contain null members if any of the individual file listings failed to parse. The caller should check each
Expand Down Expand Up @@ -129,7 +128,6 @@ public FTPFile[] getFiles() throws IOException {
* before being added to the array.
*
* @param filter FTPFileFilter, must not be {@code null}.
*
* @return an array of FTPFile objects containing the whole list of files returned by the server as read by this object's parser.
* <p>
* <strong> NOTE:</strong> This array may contain null members if any of the individual file listings failed to parse. The caller should check each
Expand All @@ -150,7 +148,6 @@ public FTPFile[] getFiles(final FTPFileFilter filter) throws IOException {
* After this method is called this object's internal iterator is advanced by a number of positions equal to the size of the array returned.
*
* @param quantityRequested the maximum number of entries we want to get.
*
* @return an array of at most {@code quantityRequested} FTPFile objects starting at the current position of this iterator within its list and at least the
* number of elements which exist in the list at and after its current position.
* <p>
Expand Down Expand Up @@ -183,7 +180,6 @@ public FTPFile[] getNext(final int quantityRequested) {
* After this method is called this object's internal iterator is moved back by a number of positions equal to the size of the array returned.
*
* @param quantityRequested the maximum number of entries we want to get.
*
* @return an array of at most {@code quantityRequested} FTPFile objects starting at the current position of this iterator within its list and at least the
* number of elements which exist in the list at and after its current position. This array will be in the same order as the underlying list (not
* reversed).
Expand Down Expand Up @@ -231,7 +227,6 @@ public boolean hasPrevious() {
*
* @param inputStream The socket stream on which the input will be read.
* @param charsetName The encoding to use.
*
* @throws IOException thrown on any failure to read the stream
*/
private void read(final InputStream inputStream, final String charsetName) throws IOException {
Expand Down Expand Up @@ -264,7 +259,6 @@ public void readServerList(final InputStream inputStream) throws IOException {
*
* @param inputStream input stream provided by the server socket.
* @param charsetName the encoding to be used for reading the stream
*
* @throws IOException thrown on any failure to read from the sever.
*/
public void readServerList(final InputStream inputStream, final String charsetName) throws IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ public class DefaultFTPFileEntryParserFactory implements FTPFileEntryParserFacto
* </p>
*
* @param config A {@link FTPClientConfig FTPClientConfig} used to configure the parser created
*
* @return the {@link FTPFileEntryParser} so created.
* @throws ParserInitializationException Thrown on any exception in instantiation
* @throws NullPointerException if {@code config} is {@code null}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ public interface FTPFileEntryParserFactory {
* </p>
*
* @param config A {@link FTPClientConfig FTPClientConfig} used to configure the parser created
*
* @return the {@link FTPFileEntryParser} so created.
* @throws ParserInitializationException Thrown on any exception in instantiation
* @since 1.4
Expand All @@ -48,7 +47,6 @@ public interface FTPFileEntryParserFactory {
* Implementation should be a method that decodes the supplied key and creates an object implementing the interface FTPFileEntryParser.
*
* @param key A string that somehow identifies an FTPFileEntryParser to be created.
*
* @return the FTPFileEntryParser created.
* @throws ParserInitializationException Thrown on any exception in instantiation
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,6 @@ boolean isLenientFutureDates() {
* This method assumes that the server time is the same as the local time.
*
* @see FTPTimestampParserImpl#parseTimestamp(String, Calendar)
*
* @param timestampStr The timestamp to be parsed
* @return a Calendar with the parsed timestamp
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ public abstract class RegexFTPFileEntryParserImpl extends FTPFileEntryParserImpl
* The constructor for a RegexFTPFileEntryParserImpl object. The expression is compiled with flags = 0.
*
* @param regex The regular expression with which this object is initialized.
*
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not be seen in normal conditions. If it is seen, this is a sign
* that a subclass has been created with a bad regular expression. Since the parser must be created before use, this means
* that any bad parser subclasses created from this will bomb very quickly, leading to easy detection.
Expand All @@ -65,7 +64,6 @@ public RegexFTPFileEntryParserImpl(final String regex) {
*
* @param regex The regular expression with which this object is initialized.
* @param flags the flags to apply, see {@link Pattern#compile(String, int)}. Use 0 for none.
*
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not be seen in normal conditions. If it is seen, this is a sign
* that a subclass has been created with a bad regular expression. Since the parser must be created before use, this means
* that any bad parser subclasses created from this will bomb very quickly, leading to easy detection.
Expand Down Expand Up @@ -123,7 +121,6 @@ public String getGroupsAsString() {
* Convenience method delegates to the internal MatchResult's group() method.
*
* @param matchNum match group number to be retrieved
*
* @return the content of the {@code matchnum'th} group of the internal match or null if this method is called without a match having been made.
*/
public String group(final int matchNum) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,6 @@ public FTPFile parseFTPEntry(final String entry) {
* implementation of simply calling BufferedReader.readLine(), because one entry may span multiple lines.
*
* @param reader The BufferedReader object from which entries are to be read.
*
* @return A string representing the next ftp entry or null if none found.
* @throws IOException thrown on any IO Error reading from the reader.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ protected boolean isVersioning() {
* to remove the duplicates.
*
* @param original Original list
*
* @return Original list purged of duplicates
*/
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
* information when issuing a STAT command, implemented by {@link NNTPClient#selectArticle selectArticle}.
*
* @see NNTPClient
*
* @deprecated 3.0 use {@link ArticleInfo} instead
*/
@Deprecated
Expand Down
Loading

0 comments on commit d678126

Please sign in to comment.