Skip to content

Commit

Permalink
Remove extra whitespace in Javadoc @link tags
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Mar 5, 2025
1 parent 33a1949 commit 9154da3
Show file tree
Hide file tree
Showing 30 changed files with 99 additions and 99 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@
/**
* The DatagramSocketClient provides the basic operations that are required of client objects accessing datagram sockets. It is meant to be subclassed to avoid
* having to rewrite the same code over and over again to open a socket, close a socket, set timeouts, etc. Of special note is the
* {@link #setDatagramSocketFactory setDatagramSocketFactory } method, which allows you to control the type of DatagramSocket the DatagramSocketClient creates
* {@link #setDatagramSocketFactory setDatagramSocketFactory)} method, which allows you to control the type of DatagramSocket the DatagramSocketClient creates
* for network communications. This is especially useful for adding things like proxy support as well as better support for applets. For example, you could
* create a {@link org.apache.commons.net.DatagramSocketFactory} that requests browser security capabilities before creating a socket. All classes derived from
* DatagramSocketClient should use the {@link #_socketFactory_ _socketFactory_ } member variable to create DatagramSocket instances rather than instantiating
* DatagramSocketClient should use the {@link #_socketFactory_ _socketFactory_} member variable to create DatagramSocket instances rather than instantiating
* them by directly invoking a constructor. By honoring this contract you guarantee that a user will always be able to provide his own Socket implementations by
* substituting his own SocketFactory.
*
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/org/apache/commons/net/SocketClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@

/**
* The SocketClient provides the basic operations that are required of client objects accessing sockets. It is meant to be subclassed to avoid having to rewrite
* the same code over and over again to open a socket, close a socket, set timeouts, etc. Of special note is the {@link #setSocketFactory setSocketFactory }
* the same code over and over again to open a socket, close a socket, set timeouts, etc. Of special note is the {@link #setSocketFactory setSocketFactory}
* method, which allows you to control the type of Socket the SocketClient creates for initiating network connections. This is especially useful for adding SSL
* or proxy support as well as better support for applets. For example, you could create a {@link javax.net.SocketFactory} that requests browser security
* capabilities before creating a socket. All classes derived from SocketClient should use the {@link #_socketFactory_ _socketFactory_ } member variable to
* capabilities before creating a socket. All classes derived from SocketClient should use the {@link #_socketFactory_ _socketFactory_} member variable to
* create Socket and ServerSocket instances rather than instantiating them by directly invoking a constructor. By honoring this contract you guarantee that a
* user will always be able to provide his own Socket implementations by substituting his own SocketFactory.
*
Expand Down Expand Up @@ -404,7 +404,7 @@ public int getConnectTimeout() {
}

/**
* Gets the current value of the default port (stored in {@link #_defaultPort_ _defaultPort_ }).
* Gets the current value of the default port (stored in {@link #_defaultPort_ _defaultPort_}).
*
* @return The current value of the default port.
*/
Expand Down Expand Up @@ -646,7 +646,7 @@ public void setConnectTimeout(final int connectTimeout) {
}

/**
* Sets the default port the SocketClient should connect to when a port is not specified. The {@link #_defaultPort_ _defaultPort_ } variable stores this
* Sets the default port the SocketClient should connect to when a port is not specified. The {@link #_defaultPort_ _defaultPort_} variable stores this
* value. If never set, the default port is equal to zero.
*
* @param port The default port to set.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
* stream. The chargen protocol actually sends data until the receiving end closes the connection. All the others send only a fixed amount of data and then
* close the connection.
* <p>
* To use the CharGenTCPClient class, just establish a connection with {@link org.apache.commons.net.SocketClient#connect connect } and call
* To use the CharGenTCPClient class, just establish a connection with {@link org.apache.commons.net.SocketClient#connect connect} and call
* {@link #getInputStream getInputStream()} to access the data. Don't close the input stream when you're done with it. Rather, call
* {@link org.apache.commons.net.SocketClient#disconnect disconnect } to clean up properly.
* {@link org.apache.commons.net.SocketClient#disconnect disconnect} to clean up properly.
* </p>
*
* @see CharGenUDPClient
Expand Down Expand Up @@ -60,7 +60,7 @@ public CharGenTCPClient() {

/**
* Gets an InputStream from which the server generated data can be read. You should NOT close the InputStream when you're finished reading from it.
* Rather, you should call {@link org.apache.commons.net.SocketClient#disconnect disconnect } to clean up properly.
* Rather, you should call {@link org.apache.commons.net.SocketClient#disconnect disconnect} to clean up properly.
*
* @return An InputStream from which the server generated data can be read.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
* contained in one or more reply datagrams. The chargen and quote of the day protocols only send one reply datagram containing 512 bytes or fewer. The
* other protocols may reply with more than one datagram, in which case you must wait for a timeout to determine that all reply datagrams have been sent.
* <p>
* To use the CharGenUDPClient class, just open a local UDP port with {@link org.apache.commons.net.DatagramSocketClient#open open } and call {@link #send send
* } to send the datagram that will initiate the data reply. For chargen or quote of the day, just call {@link #receive receive }, and you're done. For netstat
* To use the CharGenUDPClient class, just open a local UDP port with {@link org.apache.commons.net.DatagramSocketClient#open open} and call {@link #send send
* } to send the datagram that will initiate the data reply. For chargen or quote of the day, just call {@link #receive receive}, and you're done. For netstat
* and systat, call receive in a while loop, and catch a SocketException and InterruptedIOException to detect a timeout (don't forget to set the timeout
* duration beforehand). Don't forget to call {@link org.apache.commons.net.DatagramSocketClient#close close()} to clean up properly.
* </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@

/**
* The DaytimeTCPClient class is a TCP implementation of a client for the Daytime protocol described in RFC 867. To use the class, merely establish a connection
* with {@link org.apache.commons.net.SocketClient#connect connect } and call {@link #getTime getTime()} to retrieve the daytime string, then call
* {@link org.apache.commons.net.SocketClient#disconnect disconnect } to close the connection properly.
* with {@link org.apache.commons.net.SocketClient#connect connect} and call {@link #getTime getTime()} to retrieve the daytime string, then call
* {@link org.apache.commons.net.SocketClient#disconnect disconnect} to close the connection properly.
*
* @see DaytimeUDPClient
*/
Expand All @@ -45,8 +45,8 @@ public DaytimeTCPClient() {

/**
* Gets the time string from the server and returns it. The server will have closed the connection at this point, so you should call
* {@link org.apache.commons.net.SocketClient#disconnect disconnect } after calling this method. To retrieve another time, you must initiate another
* connection with {@link org.apache.commons.net.SocketClient#connect connect } before calling {@code getTime()} again.
* {@link org.apache.commons.net.SocketClient#disconnect disconnect} after calling this method. To retrieve another time, you must initiate another
* connection with {@link org.apache.commons.net.SocketClient#connect connect} before calling {@code getTime()} again.
*
* @return The time string retrieved from the server.
* @throws IOException If an error occurs while fetching the time string.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@

/**
* The DaytimeUDPClient class is a UDP implementation of a client for the Daytime protocol described in RFC 867. To use the class, merely open a local datagram
* socket with {@link org.apache.commons.net.DatagramSocketClient#open open } and call {@link #getTime getTime } to retrieve the daytime string, then call
* {@link org.apache.commons.net.DatagramSocketClient#close close } to close the connection properly. Unlike
* {@link org.apache.commons.net.daytime.DaytimeTCPClient}, successive calls to {@link #getTime getTime } are permitted without re-establishing a connection.
* socket with {@link org.apache.commons.net.DatagramSocketClient#open open} and call {@link #getTime getTime} to retrieve the daytime string, then call
* {@link org.apache.commons.net.DatagramSocketClient#close close} to close the connection properly. Unlike
* {@link org.apache.commons.net.daytime.DaytimeTCPClient}, successive calls to {@link #getTime getTime} are permitted without re-establishing a connection.
* That is because UDP is a connectionless protocol and the Daytime protocol is stateless.
*
* @see DaytimeTCPClient
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@

/**
* The DiscardTCPClient class is a TCP implementation of a client for the Discard protocol described in RFC 863. To use the class, merely establish a connection
* with {@link org.apache.commons.net.SocketClient#connect connect } and call {@link #getOutputStream getOutputStream()} to retrieve the discard output stream.
* Don't close the output stream when you're done writing to it. Rather, call {@link org.apache.commons.net.SocketClient#disconnect disconnect } to clean up
* with {@link org.apache.commons.net.SocketClient#connect connect} and call {@link #getOutputStream getOutputStream()} to retrieve the discard output stream.
* Don't close the output stream when you're done writing to it. Rather, call {@link org.apache.commons.net.SocketClient#disconnect disconnect} to clean up
* properly.
*
* @see DiscardUDPClient
Expand All @@ -43,7 +43,7 @@ public DiscardTCPClient() {

/**
* Gets an OutputStream through which you may write data to the server. You should NOT close the OutputStream when you're finished reading from it.
* Rather, you should call {@link org.apache.commons.net.SocketClient#disconnect disconnect } to clean up properly.
* Rather, you should call {@link org.apache.commons.net.SocketClient#disconnect disconnect} to clean up properly.
*
* @return An OutputStream through which you can write data to the server.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

/**
* The DiscardUDPClient class is a UDP implementation of a client for the Discard protocol described in RFC 863. To use the class, just open a local UDP port
* with {@link org.apache.commons.net.DatagramSocketClient#open open } and call {@link #send send } to send datagrams to the server After you're done sending
* with {@link org.apache.commons.net.DatagramSocketClient#open open} and call {@link #send send} to send datagrams to the server After you're done sending
* discard data, call {@link org.apache.commons.net.DatagramSocketClient#close close()} to clean up properly.
*
* @see DiscardTCPClient
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/net/echo/EchoTCPClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@

/**
* The EchoTCPClient class is a TCP implementation of a client for the Echo protocol described in RFC 862. To use the class, merely establish a connection with
* {@link org.apache.commons.net.SocketClient#connect connect } and call {@link DiscardTCPClient#getOutputStream getOutputStream()} to retrieve the echo output
* {@link org.apache.commons.net.SocketClient#connect connect} and call {@link DiscardTCPClient#getOutputStream getOutputStream()} to retrieve the echo output
* stream and {@link #getInputStream getInputStream()} to get the echo input stream. Don't close either stream when you're done using them. Rather, call
* {@link org.apache.commons.net.SocketClient#disconnect disconnect } to clean up properly.
* {@link org.apache.commons.net.SocketClient#disconnect disconnect} to clean up properly.
*
* @see EchoUDPClient
* @see DiscardTCPClient
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

/**
* The EchoUDPClient class is a UDP implementation of a client for the Echo protocol described in RFC 862. To use the class, just open a local UDP port with
* {@link org.apache.commons.net.DatagramSocketClient#open open } and call {@link #send send } to send datagrams to the server, then call {@link #receive
* {@link org.apache.commons.net.DatagramSocketClient#open open} and call {@link #send send} to send datagrams to the server, then call {@link #receive
* receive } to receive echoes. After you're done echoing data, call {@link org.apache.commons.net.DatagramSocketClient#close close()} to clean up properly.
*
* @see EchoTCPClient
Expand Down
18 changes: 9 additions & 9 deletions src/main/java/org/apache/commons/net/ftp/FTP.java
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@
* <p>
* You should keep in mind that the FTP server may choose to prematurely close a connection if the client has been idle for longer than a given time period
* (usually 900 seconds). The FTP class will detect a premature FTP server connection closing when it receives a
* {@link org.apache.commons.net.ftp.FTPReply#SERVICE_NOT_AVAILABLE FTPReply.SERVICE_NOT_AVAILABLE } response to a command. When that occurs, the FTP class
* {@link org.apache.commons.net.ftp.FTPReply#SERVICE_NOT_AVAILABLE FTPReply.SERVICE_NOT_AVAILABLE} response to a command. When that occurs, the FTP class
* method encountering that reply will throw an {@link org.apache.commons.net.ftp.FTPConnectionClosedException}. {@code FTPConectionClosedException} is a
* subclass of {@code IOException} and therefore need not be caught separately, but if you are going to catch it separately, its catch block must appear
* before the more general {@code IOException} catch block. When you encounter an {@link org.apache.commons.net.ftp.FTPConnectionClosedException} , you
* must disconnect the connection with {@link #disconnect disconnect()} to properly clean up the system resources used by FTP. Before disconnecting, you may
* check the last reply code and text with {@link #getReplyCode getReplyCode }, {@link #getReplyString getReplyString }, and {@link #getReplyStrings
* check the last reply code and text with {@link #getReplyCode getReplyCode}, {@link #getReplyString getReplyString}, and {@link #getReplyStrings
* getReplyStrings}. You may avoid server disconnections while the client is idle by periodically sending NOOP commands to the server.
* </p>
* <p>
Expand Down Expand Up @@ -588,7 +588,7 @@ public String getControlEncoding() {

/**
* Gets a reply from the FTP server and returns the integer reply code. After calling this method, the actual reply text can be accessed from either
* calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }. Only use this method if you are implementing your own FTP
* calling {@link #getReplyString getReplyString} or {@link #getReplyStrings getReplyStrings}. Only use this method if you are implementing your own FTP
* client or if you need to fetch a secondary response from the FTP server.
*
* @return The integer value of the reply code of the fetched FTP reply.
Expand Down Expand Up @@ -1203,7 +1203,7 @@ private void send(final String message) throws IOException, FTPConnectionClosedE

/**
* Sends an FTP command to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the
* actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* actual reply text can be accessed by calling {@link #getReplyString getReplyString} or {@link #getReplyStrings getReplyStrings}.
*
* @param command The FTPCmd enum corresponding to the FTP command to send.
* @return The integer value of the FTP reply code returned by the server in response to the command.
Expand All @@ -1219,7 +1219,7 @@ public int sendCommand(final FTPCmd command) throws IOException {

/**
* Sends an FTP command to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the
* actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* actual reply text can be accessed by calling {@link #getReplyString getReplyString} or {@link #getReplyStrings getReplyStrings}.
*
* @param command The FTPCmd enum corresponding to the FTP command to send.
* @param args The arguments to the FTP command. If this parameter is set to null, then the command is sent with no argument.
Expand All @@ -1236,7 +1236,7 @@ public int sendCommand(final FTPCmd command, final String args) throws IOExcepti

/**
* Sends an FTP command with no arguments to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed
* information, the actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* information, the actual reply text can be accessed by calling {@link #getReplyString getReplyString} or {@link #getReplyStrings getReplyStrings}.
*
* @param command The FTPCommand constant corresponding to the FTP command to send.
* @return The integer value of the FTP reply code returned by the server in response to the command.
Expand All @@ -1251,7 +1251,7 @@ public int sendCommand(final int command) throws IOException {

/**
* Sends an FTP command to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the
* actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* actual reply text can be accessed by calling {@link #getReplyString getReplyString} or {@link #getReplyStrings getReplyStrings}.
*
* @param command The FTPCommand constant corresponding to the FTP command to send.
* @param args The arguments to the FTP command. If this parameter is set to null, then the command is sent with no argument.
Expand All @@ -1269,7 +1269,7 @@ public int sendCommand(final int command, final String args) throws IOException

/**
* Sends an FTP command with no arguments to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed
* information, the actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* information, the actual reply text can be accessed by calling {@link #getReplyString getReplyString} or {@link #getReplyStrings getReplyStrings}.
*
* @param command The text representation of the FTP command to send.
* @return The integer value of the FTP reply code returned by the server in response to the command.
Expand All @@ -1284,7 +1284,7 @@ public int sendCommand(final String command) throws IOException {

/**
* Sends an FTP command to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the
* actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* actual reply text can be accessed by calling {@link #getReplyString getReplyString} or {@link #getReplyStrings getReplyStrings}.
*
* @param command The text representation of the FTP command to send.
* @param args The arguments to the FTP command. If this parameter is set to null, then the command is sent with no argument.
Expand Down
Loading

0 comments on commit 9154da3

Please sign in to comment.