git-svn-id: https://svn.apache.org/repos/asf/commons/proper/net/trunk@1747119 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/commons/net/DatagramSocketClient.java b/src/main/java/org/apache/commons/net/DatagramSocketClient.java
index 5ba059f..ced4dc9 100644
--- a/src/main/java/org/apache/commons/net/DatagramSocketClient.java
+++ b/src/main/java/org/apache/commons/net/DatagramSocketClient.java
@@ -96,7 +96,7 @@
* _isOpen_ is set to true after calling this method and _socket_
* is set to the newly opened socket.
*
- * @exception SocketException If the socket could not be opened or the
+ * @throws SocketException If the socket could not be opened or the
* timeout could not be set.
***/
public void open() throws SocketException
@@ -116,7 +116,7 @@
* is set to the newly opened socket.
*
* @param port The port to use for the socket.
- * @exception SocketException If the socket could not be opened or the
+ * @throws SocketException If the socket could not be opened or the
* timeout could not be set.
***/
public void open(int port) throws SocketException
@@ -138,7 +138,7 @@
*
* @param port The port to use for the socket.
* @param laddr The local address to use.
- * @exception SocketException If the socket could not be opened or the
+ * @throws SocketException If the socket could not be opened or the
* timeout could not be set.
***/
public void open(int port, InetAddress laddr) throws SocketException
diff --git a/src/main/java/org/apache/commons/net/DatagramSocketFactory.java b/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
index 47c26ab..3fe8ded 100644
--- a/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
+++ b/src/main/java/org/apache/commons/net/DatagramSocketFactory.java
@@ -42,7 +42,7 @@
* Creates a DatagramSocket on the local host at the first available port.
* @return the socket
*
- * @exception SocketException If the socket could not be created.
+ * @throws SocketException If the socket could not be created.
***/
public DatagramSocket createDatagramSocket() throws SocketException;
@@ -51,7 +51,7 @@
*
* @param port The port to use for the socket.
* @return the socket
- * @exception SocketException If the socket could not be created.
+ * @throws SocketException If the socket could not be created.
***/
public DatagramSocket createDatagramSocket(int port) throws SocketException;
@@ -62,7 +62,7 @@
* @param port The port to use for the socket.
* @param laddr The local address to use.
* @return the socket
- * @exception SocketException If the socket could not be created.
+ * @throws SocketException If the socket could not be created.
***/
public DatagramSocket createDatagramSocket(int port, InetAddress laddr)
throws SocketException;
diff --git a/src/main/java/org/apache/commons/net/DefaultDatagramSocketFactory.java b/src/main/java/org/apache/commons/net/DefaultDatagramSocketFactory.java
index 6f46619..7ad1997 100644
--- a/src/main/java/org/apache/commons/net/DefaultDatagramSocketFactory.java
+++ b/src/main/java/org/apache/commons/net/DefaultDatagramSocketFactory.java
@@ -40,7 +40,7 @@
/***
* Creates a DatagramSocket on the local host at the first available port.
* @return a new DatagramSocket
- * @exception SocketException If the socket could not be created.
+ * @throws SocketException If the socket could not be created.
***/
@Override
public DatagramSocket createDatagramSocket() throws SocketException
@@ -53,7 +53,7 @@
*
* @param port The port to use for the socket.
* @return a new DatagramSocket
- * @exception SocketException If the socket could not be created.
+ * @throws SocketException If the socket could not be created.
***/
@Override
public DatagramSocket createDatagramSocket(int port) throws SocketException
@@ -68,7 +68,7 @@
* @param port The port to use for the socket.
* @param laddr The local address to use.
* @return a new DatagramSocket
- * @exception SocketException If the socket could not be created.
+ * @throws SocketException If the socket could not be created.
***/
@Override
public DatagramSocket createDatagramSocket(int port, InetAddress laddr)
diff --git a/src/main/java/org/apache/commons/net/DefaultSocketFactory.java b/src/main/java/org/apache/commons/net/DefaultSocketFactory.java
index 2f0d658..3e68b75 100644
--- a/src/main/java/org/apache/commons/net/DefaultSocketFactory.java
+++ b/src/main/java/org/apache/commons/net/DefaultSocketFactory.java
@@ -68,7 +68,7 @@
* Creates an unconnected Socket.
*
* @return A new unconnected Socket.
- * @exception IOException If an I/O error occurs while creating the Socket.
+ * @throws IOException If an I/O error occurs while creating the Socket.
* @since 3.2
*/
@Override
@@ -87,8 +87,8 @@
* @param host The hostname to connect to.
* @param port The port to connect to.
* @return A Socket connected to the given host and port.
- * @exception UnknownHostException If the hostname cannot be resolved.
- * @exception IOException If an I/O error occurs while creating the Socket.
+ * @throws UnknownHostException If the hostname cannot be resolved.
+ * @throws IOException If an I/O error occurs while creating the Socket.
***/
@Override
public Socket createSocket(String host, int port)
@@ -109,7 +109,7 @@
* @param address The address of the host to connect to.
* @param port The port to connect to.
* @return A Socket connected to the given host and port.
- * @exception IOException If an I/O error occurs while creating the Socket.
+ * @throws IOException If an I/O error occurs while creating the Socket.
***/
@Override
public Socket createSocket(InetAddress address, int port)
@@ -133,8 +133,8 @@
* @param localAddr The local address to use.
* @param localPort The local port to use.
* @return A Socket connected to the given host and port.
- * @exception UnknownHostException If the hostname cannot be resolved.
- * @exception IOException If an I/O error occurs while creating the Socket.
+ * @throws UnknownHostException If the hostname cannot be resolved.
+ * @throws IOException If an I/O error occurs while creating the Socket.
***/
@Override
public Socket createSocket(String host, int port,
@@ -160,7 +160,7 @@
* @param localAddr The local address to use.
* @param localPort The local port to use.
* @return A Socket connected to the given host and port.
- * @exception IOException If an I/O error occurs while creating the Socket.
+ * @throws IOException If an I/O error occurs while creating the Socket.
***/
@Override
public Socket createSocket(InetAddress address, int port,
@@ -183,7 +183,7 @@
*
* @param port The port on which to listen, or 0 to use any free port.
* @return A ServerSocket that will listen on a specified port.
- * @exception IOException If an I/O error occurs while creating
+ * @throws IOException If an I/O error occurs while creating
* the ServerSocket.
***/
public ServerSocket createServerSocket(int port) throws IOException
@@ -199,7 +199,7 @@
* @param port The port on which to listen, or 0 to use any free port.
* @param backlog The maximum length of the queue for incoming connections.
* @return A ServerSocket that will listen on a specified port.
- * @exception IOException If an I/O error occurs while creating
+ * @throws IOException If an I/O error occurs while creating
* the ServerSocket.
***/
public ServerSocket createServerSocket(int port, int backlog)
@@ -218,7 +218,7 @@
* @param backlog The maximum length of the queue for incoming connections.
* @param bindAddr The local address to which the ServerSocket should bind.
* @return A ServerSocket that will listen on a specified port.
- * @exception IOException If an I/O error occurs while creating
+ * @throws IOException If an I/O error occurs while creating
* the ServerSocket.
***/
public ServerSocket createServerSocket(int port, int backlog,
diff --git a/src/main/java/org/apache/commons/net/SocketClient.java b/src/main/java/org/apache/commons/net/SocketClient.java
index e23b985..84dd5a1 100644
--- a/src/main/java/org/apache/commons/net/SocketClient.java
+++ b/src/main/java/org/apache/commons/net/SocketClient.java
@@ -169,8 +169,8 @@
* <p>
* @param host The remote host.
* @param port The port to connect to on the remote host.
- * @exception SocketException If the socket timeout could not be set.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
*/
@@ -197,11 +197,11 @@
* <p>
* @param hostname The name of the remote host.
* @param port The port to connect to on the remote host.
- * @exception SocketException If the socket timeout could not be set.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
- * @exception java.net.UnknownHostException If the hostname cannot be resolved.
+ * @throws java.net.UnknownHostException If the hostname cannot be resolved.
*/
public void connect(String hostname, int port)
throws SocketException, IOException
@@ -221,8 +221,8 @@
* @param port The port to connect to on the remote host.
* @param localAddr The local address to use.
* @param localPort The local port to use.
- * @exception SocketException If the socket timeout could not be set.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
*/
@@ -254,11 +254,11 @@
* @param port The port to connect to on the remote host.
* @param localAddr The local address to use.
* @param localPort The local port to use.
- * @exception SocketException If the socket timeout could not be set.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
- * @exception java.net.UnknownHostException If the hostname cannot be resolved.
+ * @throws java.net.UnknownHostException If the hostname cannot be resolved.
*/
public void connect(String hostname, int port,
InetAddress localAddr, int localPort)
@@ -276,8 +276,8 @@
* is called to perform connection initialization actions.
* <p>
* @param host The remote host.
- * @exception SocketException If the socket timeout could not be set.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
*/
@@ -295,11 +295,11 @@
* is called to perform connection initialization actions.
* <p>
* @param hostname The name of the remote host.
- * @exception SocketException If the socket timeout could not be set.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
- * @exception java.net.UnknownHostException If the hostname cannot be resolved.
+ * @throws java.net.UnknownHostException If the hostname cannot be resolved.
*/
public void connect(String hostname) throws SocketException, IOException
{
@@ -316,7 +316,7 @@
* again. _isConnected_ is set to false, _socket_ is set to null,
* _input_ is set to null, and _output_ is set to null.
* <p>
- * @exception IOException If there is an error closing the socket.
+ * @throws IOException If there is an error closing the socket.
*/
public void disconnect() throws IOException
{
@@ -475,7 +475,7 @@
*
* @param timeout The timeout in milliseconds to use for the currently
* open socket connection.
- * @exception SocketException If the operation fails.
+ * @throws SocketException If the operation fails.
* @throws NullPointerException if the socket is not currently open
*/
public void setSoTimeout(int timeout) throws SocketException
@@ -528,7 +528,7 @@
* Returns the timeout in milliseconds of the currently opened socket.
* <p>
* @return The timeout in milliseconds of the currently opened socket.
- * @exception SocketException If the operation fails.
+ * @throws SocketException If the operation fails.
* @throws NullPointerException if the socket is not currently open
*/
public int getSoTimeout() throws SocketException
@@ -541,7 +541,7 @@
* currently opened socket.
* <p>
* @param on True if Nagle's algorithm is to be enabled, false if not.
- * @exception SocketException If the operation fails.
+ * @throws SocketException If the operation fails.
* @throws NullPointerException if the socket is not currently open
*/
public void setTcpNoDelay(boolean on) throws SocketException
@@ -556,7 +556,7 @@
* <p>
* @return True if Nagle's algorithm is enabled on the currently opened
* socket, false otherwise.
- * @exception SocketException If the operation fails.
+ * @throws SocketException If the operation fails.
* @throws NullPointerException if the socket is not currently open
*/
public boolean getTcpNoDelay() throws SocketException
@@ -597,7 +597,7 @@
* <p>
* @param on True if linger is to be enabled, false if not.
* @param val The linger timeout (in hundredths of a second?)
- * @exception SocketException If the operation fails.
+ * @throws SocketException If the operation fails.
* @throws NullPointerException if the socket is not currently open
*/
public void setSoLinger(boolean on, int val) throws SocketException
@@ -611,7 +611,7 @@
* <p>
* @return The current SO_LINGER timeout. If SO_LINGER is disabled returns
* -1.
- * @exception SocketException If the operation fails.
+ * @throws SocketException If the operation fails.
* @throws NullPointerException if the socket is not currently open
*/
public int getSoLinger() throws SocketException
diff --git a/src/main/java/org/apache/commons/net/bsd/RCommandClient.java b/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
index bf613e3..6819cae 100644
--- a/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
+++ b/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
@@ -171,9 +171,9 @@
* @param host The remote host.
* @param port The port to connect to on the remote host.
* @param localAddr The local address to use.
- * @exception SocketException If the socket timeout could not be set.
- * @exception BindException If all acceptable rshell ports are in use.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws BindException If all acceptable rshell ports are in use.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
***/
@@ -219,9 +219,9 @@
*
* @param host The remote host.
* @param port The port to connect to on the remote host.
- * @exception SocketException If the socket timeout could not be set.
- * @exception BindException If all acceptable rshell ports are in use.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws BindException If all acceptable rshell ports are in use.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
***/
@@ -242,12 +242,12 @@
*
* @param hostname The name of the remote host.
* @param port The port to connect to on the remote host.
- * @exception SocketException If the socket timeout could not be set.
- * @exception BindException If all acceptable rshell ports are in use.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws BindException If all acceptable rshell ports are in use.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
- * @exception UnknownHostException If the hostname cannot be resolved.
+ * @throws UnknownHostException If the hostname cannot be resolved.
***/
@Override
public void connect(String hostname, int port)
@@ -267,9 +267,9 @@
* @param hostname The remote host.
* @param port The port to connect to on the remote host.
* @param localAddr The local address to use.
- * @exception SocketException If the socket timeout could not be set.
- * @exception BindException If all acceptable rshell ports are in use.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws BindException If all acceptable rshell ports are in use.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
***/
@@ -293,11 +293,11 @@
* @param port The port to connect to on the remote host.
* @param localAddr The local address to use.
* @param localPort The local port to use.
- * @exception SocketException If the socket timeout could not be set.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
- * @exception IllegalArgumentException If an invalid local port number
+ * @throws IllegalArgumentException If an invalid local port number
* is specified.
***/
@Override
@@ -325,12 +325,12 @@
* @param port The port to connect to on the remote host.
* @param localAddr The local address to use.
* @param localPort The local port to use.
- * @exception SocketException If the socket timeout could not be set.
- * @exception IOException If the socket could not be opened. In most
+ * @throws SocketException If the socket timeout could not be set.
+ * @throws IOException If the socket could not be opened. In most
* cases you will only want to catch IOException since SocketException is
* derived from it.
- * @exception UnknownHostException If the hostname cannot be resolved.
- * @exception IllegalArgumentException If an invalid local port number
+ * @throws UnknownHostException If the hostname cannot be resolved.
+ * @throws IllegalArgumentException If an invalid local port number
* is specified.
***/
@Override
@@ -378,7 +378,7 @@
* @param separateErrorStream True if you would like the standard error
* to be transmitted through a different stream than standard output.
* False if not.
- * @exception IOException If the rcommand() attempt fails. The exception
+ * @throws IOException If the rcommand() attempt fails. The exception
* will contain a message indicating the nature of the failure.
***/
public void rcommand(String localUsername, String remoteUsername,
diff --git a/src/main/java/org/apache/commons/net/bsd/RExecClient.java b/src/main/java/org/apache/commons/net/bsd/RExecClient.java
index 7ecf8eb..37f9fbd 100644
--- a/src/main/java/org/apache/commons/net/bsd/RExecClient.java
+++ b/src/main/java/org/apache/commons/net/bsd/RExecClient.java
@@ -196,7 +196,7 @@
* @param separateErrorStream True if you would like the standard error
* to be transmitted through a different stream than standard output.
* False if not.
- * @exception IOException If the rexec() attempt fails. The exception
+ * @throws IOException If the rexec() attempt fails. The exception
* will contain a message indicating the nature of the failure.
***/
public void rexec(String username, String password,
@@ -255,7 +255,7 @@
* Disconnects from the server, closing all associated open sockets and
* streams.
*
- * @exception IOException If there an error occurs while disconnecting.
+ * @throws IOException If there an error occurs while disconnecting.
***/
@Override
public void disconnect() throws IOException
diff --git a/src/main/java/org/apache/commons/net/bsd/RLoginClient.java b/src/main/java/org/apache/commons/net/bsd/RLoginClient.java
index 9a4bc4a..9e60903 100644
--- a/src/main/java/org/apache/commons/net/bsd/RLoginClient.java
+++ b/src/main/java/org/apache/commons/net/bsd/RLoginClient.java
@@ -105,7 +105,7 @@
* "network", etc.)
* @param terminalSpeed The speed of the user's terminal, expressed
* as a baud rate or bps (e.g., 9600 or 38400)
- * @exception IOException If the rlogin() attempt fails. The exception
+ * @throws IOException If the rlogin() attempt fails. The exception
* will contain a message indicating the nature of the failure.
***/
public void rlogin(String localUsername, String remoteUsername,
diff --git a/src/main/java/org/apache/commons/net/chargen/CharGenUDPClient.java b/src/main/java/org/apache/commons/net/chargen/CharGenUDPClient.java
index 8df6506..5b51965 100644
--- a/src/main/java/org/apache/commons/net/chargen/CharGenUDPClient.java
+++ b/src/main/java/org/apache/commons/net/chargen/CharGenUDPClient.java
@@ -87,7 +87,7 @@
*
* @param host The address of the server.
* @param port The port of the service.
- * @exception IOException If an error occurs while sending the datagram.
+ * @throws IOException If an error occurs while sending the datagram.
***/
public void send(InetAddress host, int port) throws IOException
{
@@ -111,7 +111,7 @@
* and systat require multiple calls to receive() with timeout detection.
*
* @return The reply data from the server.
- * @exception IOException If an error occurs while receiving the datagram.
+ * @throws IOException If an error occurs while receiving the datagram.
***/
public byte[] receive() throws IOException
{
diff --git a/src/main/java/org/apache/commons/net/daytime/DaytimeTCPClient.java b/src/main/java/org/apache/commons/net/daytime/DaytimeTCPClient.java
index 0f95708..033a776 100644
--- a/src/main/java/org/apache/commons/net/daytime/DaytimeTCPClient.java
+++ b/src/main/java/org/apache/commons/net/daytime/DaytimeTCPClient.java
@@ -63,7 +63,7 @@
* before calling <code> getTime() </code> again.
*
* @return The time string retrieved from the server.
- * @exception IOException If an error occurs while fetching the time string.
+ * @throws IOException If an error occurs while fetching the time string.
*/
public String getTime() throws IOException
{
diff --git a/src/main/java/org/apache/commons/net/daytime/DaytimeUDPClient.java b/src/main/java/org/apache/commons/net/daytime/DaytimeUDPClient.java
index ba1bc4f..d221f79 100644
--- a/src/main/java/org/apache/commons/net/daytime/DaytimeUDPClient.java
+++ b/src/main/java/org/apache/commons/net/daytime/DaytimeUDPClient.java
@@ -54,7 +54,7 @@
* @param host The address of the server.
* @param port The port of the service.
* @return The time string.
- * @exception IOException If an error occurs while retrieving the time.
+ * @throws IOException If an error occurs while retrieving the time.
*/
public String getTime(InetAddress host, int port) throws IOException
{
diff --git a/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java b/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java
index 772f200..e7c092d 100644
--- a/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java
+++ b/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java
@@ -57,7 +57,7 @@
* or equal to the length of the data byte array.
* @param host The address of the server.
* @param port The service port.
- * @exception IOException If an error occurs during the datagram send
+ * @throws IOException If an error occurs during the datagram send
* operation.
***/
public void send(byte[] data, int length, InetAddress host, int port)
diff --git a/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java b/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
index 4d17b9a..96ab7df 100644
--- a/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
+++ b/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java
@@ -53,7 +53,7 @@
* @param length The length of the data to send. Should be less than
* or equal to the length of the data byte array.
* @param host The address of the server.
- * @exception IOException If an error occurs during the datagram send
+ * @throws IOException If an error occurs during the datagram send
* operation.
***/
@Override
@@ -81,7 +81,7 @@
* @param length of the buffer
*
* @return Length of actual data received.
- * @exception IOException If an error occurs while receiving the data.
+ * @throws IOException If an error occurs while receiving the data.
***/
public int receive(byte[] data, int length) throws IOException
{
diff --git a/src/main/java/org/apache/commons/net/finger/FingerClient.java b/src/main/java/org/apache/commons/net/finger/FingerClient.java
index f5daf00..7655917 100644
--- a/src/main/java/org/apache/commons/net/finger/FingerClient.java
+++ b/src/main/java/org/apache/commons/net/finger/FingerClient.java
@@ -79,7 +79,7 @@
* @param longOutput Set to true if long output is requested, false if not.
* @param username The name of the user to finger.
* @return The result of the finger query.
- * @exception IOException If an I/O error occurs while reading the socket.
+ * @throws IOException If an I/O error occurs while reading the socket.
***/
public String query(boolean longOutput, String username) throws IOException
{
@@ -116,7 +116,7 @@
*
* @param longOutput Set to true if long output is requested, false if not.
* @return The result of the finger query.
- * @exception IOException If an I/O error occurs while reading the socket.
+ * @throws IOException If an I/O error occurs while reading the socket.
***/
public String query(boolean longOutput) throws IOException
{
@@ -134,7 +134,7 @@
* @param username The name of the user to finger.
* @return The InputStream of the network connection of the finger query.
* Can be read to obtain finger results.
- * @exception IOException If an I/O error during the operation.
+ * @throws IOException If an I/O error during the operation.
***/
public InputStream getInputStream(boolean longOutput, String username)
throws IOException
@@ -154,7 +154,7 @@
* null for the platform's default encoding
* @return The InputStream of the network connection of the finger query.
* Can be read to obtain finger results.
- * @exception IOException If an I/O error during the operation.
+ * @throws IOException If an I/O error during the operation.
***/
public InputStream getInputStream(boolean longOutput, String username, String encoding)
throws IOException
@@ -188,7 +188,7 @@
* @param longOutput Set to true if long output is requested, false if not.
* @return The InputStream of the network connection of the finger query.
* Can be read to obtain finger results.
- * @exception IOException If an I/O error during the operation.
+ * @throws IOException If an I/O error during the operation.
***/
public InputStream getInputStream(boolean longOutput) throws IOException
{
diff --git a/src/main/java/org/apache/commons/net/ftp/FTP.java b/src/main/java/org/apache/commons/net/ftp/FTP.java
index d9469d7..7fcd052 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTP.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTP.java
@@ -455,7 +455,7 @@
* last command is voided so that the memory it used may be reclaimed.
* Also sets {@link #_controlInput_} and {@link #_controlOutput_} to null.
*
- * @exception IOException If an error occurs while disconnecting.
+ * @throws IOException If an error occurs while disconnecting.
***/
@Override
public void disconnect() throws IOException
@@ -480,12 +480,12 @@
* set to null, then the command is sent with no argument.
* @return The integer value of the FTP reply code returned by the server
* in response to the command.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(String command, String args) throws IOException
@@ -563,12 +563,12 @@
* set to null, then the command is sent with no argument.
* @return The integer value of the FTP reply code returned by the server
* in response to the command.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @deprecated (3.3) Use {@link #sendCommand(FTPCmd, String)} instead
***/
@@ -589,12 +589,12 @@
* to send.
* @return The integer value of the FTP reply code returned by the server
* in response to the command.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @since 3.3
*/
@@ -615,12 +615,12 @@
* set to null, then the command is sent with no argument.
* @return The integer value of the FTP reply code returned by the server
* in response to the command.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @since 3.3
*/
@@ -638,12 +638,12 @@
* @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.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(String command) throws IOException
@@ -663,12 +663,12 @@
* to send.
* @return The integer value of the FTP reply code returned by the server
* in response to the command.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(int command) throws IOException
@@ -699,12 +699,12 @@
* fetch a secondary response from the FTP server.
*
* @return The integer value of the reply code of the fetched FTP reply.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while receiving the
+ * @throws IOException If an I/O error occurs while receiving the
* server reply.
***/
public int getReply() throws IOException
@@ -760,12 +760,12 @@
*
* @param username The username to login under.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int user(String username) throws IOException
@@ -778,12 +778,12 @@
* receive the reply, and return the reply code.
* @param password The plain text password of the username being logged into.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
*/
public int pass(String password) throws IOException
@@ -797,12 +797,12 @@
*
* @param account The account name to access.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int acct(String account) throws IOException
@@ -816,12 +816,12 @@
* receive the reply, and return the reply code.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int abor() throws IOException
@@ -835,12 +835,12 @@
*
* @param directory The new working directory.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int cwd(String directory) throws IOException
@@ -853,12 +853,12 @@
* receive the reply, and return the reply code.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int cdup() throws IOException
@@ -871,12 +871,12 @@
* receive the reply, and return the reply code.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int quit() throws IOException
@@ -889,12 +889,12 @@
* receive the reply, and return the reply code.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int rein() throws IOException
@@ -908,12 +908,12 @@
*
* @param dir The directory name.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int smnt(String dir) throws IOException
@@ -928,12 +928,12 @@
* @param host The host owning the port.
* @param port The new port.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int port(InetAddress host, int port) throws IOException
@@ -967,12 +967,12 @@
* @param host The host owning the port.
* @param port The new port.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @since 2.2
***/
@@ -1012,12 +1012,12 @@
* information.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int pasv() throws IOException
@@ -1032,12 +1032,12 @@
* information.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @since 2.2
***/
@@ -1055,12 +1055,12 @@
* <code>_FORMAT</code> constants. In the case of
* <code>LOCAL_FILE_TYPE</code>, the byte size.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
*/
public int type(int fileType, int formatOrByteSize) throws IOException
@@ -1086,12 +1086,12 @@
* @param fileType The type of the file (one of the <code>FILE_TYPE</code>
* constants).
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
*/
public int type(int fileType) throws IOException
@@ -1107,12 +1107,12 @@
* @param structure The structure of the file (one of the
* <code>_STRUCTURE</code> constants).
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int stru(int structure) throws IOException
@@ -1128,12 +1128,12 @@
* @param mode The transfer mode to use (one of the
* <code>TRANSFER_MODE</code> constants).
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int mode(int mode) throws IOException
@@ -1151,12 +1151,12 @@
*
* @param pathname The pathname of the file to retrieve.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int retr(String pathname) throws IOException
@@ -1174,12 +1174,12 @@
* @param pathname The pathname to use for the file when stored at
* the remote end of the transfer.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int stor(String pathname) throws IOException
@@ -1195,12 +1195,12 @@
* , which will handle all low level details for you.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int stou() throws IOException
@@ -1218,12 +1218,12 @@
* the remote end of the transfer. Some FTP servers
* require this.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
*/
public int stou(String pathname) throws IOException
@@ -1241,12 +1241,12 @@
* @param pathname The pathname to use for the file when stored at
* the remote end of the transfer.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int appe(String pathname) throws IOException
@@ -1260,12 +1260,12 @@
*
* @param bytes The number of bytes to allocate.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int allo(int bytes) throws IOException
@@ -1293,12 +1293,12 @@
* @param bytes The number of bytes to allocate.
* @param recordSize The size of a record.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int allo(int bytes, int recordSize) throws IOException
@@ -1313,12 +1313,12 @@
*
* @param marker The marker at which to restart a transfer.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int rest(String marker) throws IOException
@@ -1346,12 +1346,12 @@
* @param pathname The pathname for which mtime is to be changed
* @param timeval Timestamp in <code>YYYYMMDDhhmmss</code> format
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @since 2.2
* @see <a href="http://tools.ietf.org/html/draft-somers-ftp-mfxx-04">http://tools.ietf.org/html/draft-somers-ftp-mfxx-04</a>
@@ -1368,12 +1368,12 @@
*
* @param pathname The pathname to rename from.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int rnfr(String pathname) throws IOException
@@ -1387,12 +1387,12 @@
*
* @param pathname The pathname to rename to
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int rnto(String pathname) throws IOException
@@ -1406,12 +1406,12 @@
*
* @param pathname The pathname to delete.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int dele(String pathname) throws IOException
@@ -1425,12 +1425,12 @@
*
* @param pathname The pathname of the directory to remove.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int rmd(String pathname) throws IOException
@@ -1444,12 +1444,12 @@
*
* @param pathname The pathname of the new directory to create.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int mkd(String pathname) throws IOException
@@ -1462,12 +1462,12 @@
* receive the reply, and return the reply code.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int pwd() throws IOException
@@ -1483,12 +1483,12 @@
* , which will handle all low level details for you.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int list() throws IOException
@@ -1506,12 +1506,12 @@
* @param pathname The pathname to list,
* may be {@code null} in which case the command is sent with no parameters
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int list(String pathname) throws IOException
@@ -1527,12 +1527,12 @@
* , which will handle all low level details for you.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @since 3.0
*/
@@ -1551,12 +1551,12 @@
* @param path the path to report on
* @return The reply code received from the server,
* may be {@code null} in which case the command is sent with no parameters
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @since 3.0
*/
@@ -1573,12 +1573,12 @@
* , which will handle all low level details for you.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @since 3.0
*/
@@ -1597,12 +1597,12 @@
* @param path the path to report on
* @return The reply code received from the server,
* may be {@code null} in which case the command is sent with no parameters
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
* @since 3.0
*/
@@ -1619,12 +1619,12 @@
* , which will handle all low level details for you.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int nlst() throws IOException
@@ -1642,12 +1642,12 @@
* @param pathname The pathname to list,
* may be {@code null} in which case the command is sent with no parameters
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int nlst(String pathname) throws IOException
@@ -1661,12 +1661,12 @@
*
* @param parameters The site parameters to send.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int site(String parameters) throws IOException
@@ -1679,12 +1679,12 @@
* receive the reply, and return the reply code.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int syst() throws IOException
@@ -1697,12 +1697,12 @@
* receive the reply, and return the reply code.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int stat() throws IOException
@@ -1716,12 +1716,12 @@
*
* @param pathname A pathname to list.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int stat(String pathname) throws IOException
@@ -1734,12 +1734,12 @@
* receive the reply, and return the reply code.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int help() throws IOException
@@ -1753,12 +1753,12 @@
*
* @param command The command name on which to request help.
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int help(String command) throws IOException
@@ -1771,12 +1771,12 @@
* receive the reply, and return the reply code.
*
* @return The reply code received from the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int noop() throws IOException
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPClient.java b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
index 107515a..fc11e62 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -753,7 +753,7 @@
* Null is returned if an FTP protocol error is reported at
* any point during the establishment and initialization of
* the connection.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
* @deprecated (3.3) Use {@link #_openDataConnection_(FTPCmd, String)} instead
*/
@@ -779,7 +779,7 @@
* Null is returned if an FTP protocol error is reported at
* any point during the establishment and initialization of
* the connection.
- * @exception IOException If an I/O error occurs while either sending a
+ * @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.3
*/
@@ -804,7 +804,7 @@
* Null is returned if an FTP protocol error is reported at
* any point during the establishment and initialization of
* the connection.
- * @exception IOException If an I/O error occurs while either sending a
+ * @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.1
*/
@@ -1021,7 +1021,7 @@
* Closes the connection to the FTP server and restores
* connection parameters to the default values.
*
- * @exception IOException If an error occurs while disconnecting.
+ * @throws IOException If an error occurs while disconnecting.
*/
@Override
public void disconnect() throws IOException
@@ -1063,12 +1063,12 @@
* @param username The username to login under.
* @param password The password to use.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean login(String username, String password) throws IOException
@@ -1099,12 +1099,12 @@
* @param password The password to use.
* @param account The account to use.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean login(String username, String password, String account)
@@ -1139,12 +1139,12 @@
* Logout of the FTP server by sending the QUIT command.
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean logout() throws IOException
@@ -1158,12 +1158,12 @@
*
* @param pathname The new current working directory.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean changeWorkingDirectory(String pathname) throws IOException
@@ -1176,12 +1176,12 @@
* Change to the parent directory of the current working directory.
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean changeToParentDirectory() throws IOException
@@ -1195,12 +1195,12 @@
*
* @param pathname The pathname to mount.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean structureMount(String pathname) throws IOException
@@ -1213,12 +1213,12 @@
* command, which issues the FTP REIN command.
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @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.4 (made public)
*/
@@ -1298,12 +1298,12 @@
* transfers.
* @param port The passive mode server's data port.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean enterRemoteActiveMode(InetAddress host, int port)
@@ -1333,12 +1333,12 @@
* wish to return to the normal data connection mode.
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean enterRemotePassiveMode() throws IOException
@@ -1550,12 +1550,12 @@
* @param fileType The <code> _FILE_TYPE </code> constant indcating the
* type of file.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean setFileType(int fileType) throws IOException
@@ -1598,12 +1598,12 @@
* <code>LOCAL_FILE_TYPE</code>, the byte size.
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean setFileType(int fileType, int formatOrByteSize)
@@ -1627,12 +1627,12 @@
* @param structure The structure of the file (one of the FTP class
* <code>_STRUCTURE</code> constants).
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean setFileStructure(int structure) throws IOException
@@ -1654,12 +1654,12 @@
* @param mode The new transfer mode to use (one of the FTP class
* <code>_TRANSFER_MODE</code> constants).
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean setFileTransferMode(int mode) throws IOException
@@ -1680,12 +1680,12 @@
*
* @param filename The name of the file to retrieve.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean remoteRetrieve(String filename) throws IOException
@@ -1707,12 +1707,12 @@
*
* @param filename The name to call the file that is to be stored.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean remoteStore(String filename) throws IOException
@@ -1735,12 +1735,12 @@
* @param filename The name on which to base the filename of the file
* that is to be stored.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean remoteStoreUnique(String filename) throws IOException
@@ -1763,12 +1763,12 @@
* those servers use the other version of <code> remoteStoreUnique</code>
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean remoteStoreUnique() throws IOException
@@ -1791,12 +1791,12 @@
* file does not exist, the name to call the file being stored.
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean remoteAppend(String filename) throws IOException
@@ -1844,12 +1844,12 @@
* </pre>
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean completePendingCommand() throws IOException
@@ -1869,18 +1869,18 @@
* @param remote The name of the remote file.
* @param local The local OutputStream to which to write the file.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception org.apache.commons.net.io.CopyStreamException
+ * @throws org.apache.commons.net.io.CopyStreamException
* If an I/O error occurs while actually
* transferring the file. The CopyStreamException allows you to
* determine the number of bytes transferred and the IOException
* causing the error. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean retrieveFile(String remote, OutputStream local)
@@ -1958,12 +1958,12 @@
* the data connection cannot be opened (e.g., the file does not
* exist), null is returned (in which case you may check the reply
* code to determine the exact reason for failure).
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public InputStream retrieveFileStream(String remote) throws IOException
@@ -2014,18 +2014,18 @@
* @param remote The name to give the remote file.
* @param local The local InputStream from which to read the file.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception org.apache.commons.net.io.CopyStreamException
+ * @throws org.apache.commons.net.io.CopyStreamException
* If an I/O error occurs while actually
* transferring the file. The CopyStreamException allows you to
* determine the number of bytes transferred and the IOException
* causing the error. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean storeFile(String remote, InputStream local)
@@ -2055,12 +2055,12 @@
* the data connection cannot be opened (e.g., the file does not
* exist), null is returned (in which case you may check the reply
* code to determine the exact reason for failure).
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public OutputStream storeFileStream(String remote) throws IOException
@@ -2079,18 +2079,18 @@
* @param local The local InputStream from which to read the data to
* be appended to the remote file.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception org.apache.commons.net.io.CopyStreamException
+ * @throws org.apache.commons.net.io.CopyStreamException
* If an I/O error occurs while actually
* transferring the file. The CopyStreamException allows you to
* determine the number of bytes transferred and the IOException
* causing the error. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean appendFile(String remote, InputStream local)
@@ -2119,12 +2119,12 @@
* If the data connection cannot be opened (e.g., the file does not
* exist), null is returned (in which case you may check the reply
* code to determine the exact reason for failure).
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public OutputStream appendFileStream(String remote) throws IOException
@@ -2144,18 +2144,18 @@
* the remote file.
* @param local The local InputStream from which to read the file.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception org.apache.commons.net.io.CopyStreamException
+ * @throws org.apache.commons.net.io.CopyStreamException
* If an I/O error occurs while actually
* transferring the file. The CopyStreamException allows you to
* determine the number of bytes transferred and the IOException
* causing the error. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean storeUniqueFile(String remote, InputStream local)
@@ -2187,12 +2187,12 @@
* the data connection cannot be opened (e.g., the file does not
* exist), null is returned (in which case you may check the reply
* code to determine the exact reason for failure).
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public OutputStream storeUniqueFileStream(String remote) throws IOException
@@ -2210,18 +2210,18 @@
*
* @param local The local InputStream from which to read the file.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception org.apache.commons.net.io.CopyStreamException
+ * @throws org.apache.commons.net.io.CopyStreamException
* If an I/O error occurs while actually
* transferring the file. The CopyStreamException allows you to
* determine the number of bytes transferred and the IOException
* causing the error. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean storeUniqueFile(InputStream local) throws IOException
@@ -2249,12 +2249,12 @@
* the data connection cannot be opened (e.g., the file does not
* exist), null is returned (in which case you may check the reply
* code to determine the exact reason for failure).
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public OutputStream storeUniqueFileStream() throws IOException
@@ -2267,12 +2267,12 @@
*
* @param bytes The number of bytes which the server should allocate.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean allocate(int bytes) throws IOException
@@ -2434,12 +2434,12 @@
* @param bytes The number of bytes which the server should allocate.
* @param recordSize The size of a file record.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean allocate(int bytes, int recordSize) throws IOException
@@ -2460,7 +2460,7 @@
* call {@link #getReplyCode()} or {@link #getReplyString()}
* to get the reason.
*
- * @exception IOException If an I/O error occurs while either sending a
+ * @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
*/
@@ -2481,7 +2481,7 @@
* call {@link #getReplyCode()} or {@link #getReplyString()}
* to get the reason.
*
- * @exception IOException If an I/O error occurs while either sending a
+ * @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
*/
@@ -2565,12 +2565,12 @@
* @param offset The offset into the remote file at which to start the
* next file transfer.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @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.1 (changed from private to protected)
*/
@@ -2622,12 +2622,12 @@
* @param from The name of the remote file to rename.
* @param to The new name of the remote file.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean rename(String from, String to) throws IOException
@@ -2644,12 +2644,12 @@
* Abort a transfer in progress.
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean abort() throws IOException
@@ -2662,12 +2662,12 @@
*
* @param pathname The pathname of the file to be deleted.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean deleteFile(String pathname) throws IOException
@@ -2681,12 +2681,12 @@
*
* @param pathname The pathname of the directory to remove.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean removeDirectory(String pathname) throws IOException
@@ -2702,12 +2702,12 @@
*
* @param pathname The pathname of the directory to create.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean makeDirectory(String pathname) throws IOException
@@ -2721,12 +2721,12 @@
*
* @return The pathname of the current working directory. If it cannot
* be obtained, returns null.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public String printWorkingDirectory() throws IOException
@@ -2743,12 +2743,12 @@
* Send a site specific command.
* @param arguments The site specific command and arguments.
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean sendSiteCommand(String arguments) throws IOException
@@ -2768,12 +2768,12 @@
* If the SYST command fails, and the system property
* {@link #FTP_SYSTEM_TYPE_DEFAULT} is defined, then this is used instead.
* @return The system type obtained from the server. Never null.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server (and the default
* system type property is not defined)
* @since 2.2
@@ -2808,12 +2808,12 @@
*
* @return The system help string obtained from the server. null if the
* information could not be obtained.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public String listHelp() throws IOException
@@ -2831,12 +2831,12 @@
* @param command The command on which to ask for help.
* @return The command help string obtained from the server. null if the
* information could not be obtained.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public String listHelp(String command) throws IOException
@@ -2853,12 +2853,12 @@
* server timeouts.
*
* @return True if successfully completed, false if not.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public boolean sendNoOp() throws IOException
@@ -2888,12 +2888,12 @@
* @return The list of filenames contained in the given path. null if
* the list could not be obtained. If there are no filenames in
* the directory, a zero-length array is returned.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public String[] listNames(String pathname) throws IOException
@@ -2939,12 +2939,12 @@
* directory. null if the list could not be obtained.
* If there are no filenames in the directory, a zero-length array
* is returned.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public String[] listNames() throws IOException
@@ -2981,17 +2981,17 @@
*
* @return The list of file information contained in the given path in
* the format determined by the autodetection mechanism
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException
+ * @throws IOException
* If an I/O error occurs while either sending a
* command to the server or receiving a reply
* from the server.
- * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
+ * @throws org.apache.commons.net.ftp.parser.ParserInitializationException
* Thrown if the parserKey parameter cannot be
* resolved by the selected parser factory.
* In the DefaultFTPEntryParserFactory, this will
@@ -3034,17 +3034,17 @@
* NOTE:</b> This array may contain null members if any of the
* individual file listings failed to parse. The caller should
* check each entry for null before referencing it.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException
+ * @throws IOException
* If an I/O error occurs while either sending a
* command to the server or receiving a reply
* from the server.
- * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
+ * @throws org.apache.commons.net.ftp.parser.ParserInitializationException
* Thrown if the parserKey parameter cannot be
* resolved by the selected parser factory.
* In the DefaultFTPEntryParserFactory, this will
@@ -3099,17 +3099,17 @@
* @return The list of directories contained in the current directory
* in the format determined by the autodetection mechanism.
*
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException
+ * @throws IOException
* If an I/O error occurs while either sending a
* command to the server or receiving a reply
* from the server.
- * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
+ * @throws org.apache.commons.net.ftp.parser.ParserInitializationException
* Thrown if the parserKey parameter cannot be
* resolved by the selected parser factory.
* In the DefaultFTPEntryParserFactory, this will
@@ -3147,17 +3147,17 @@
* @return The list of directories contained in the specified directory
* in the format determined by the autodetection mechanism.
*
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException
+ * @throws IOException
* If an I/O error occurs while either sending a
* command to the server or receiving a reply
* from the server.
- * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
+ * @throws org.apache.commons.net.ftp.parser.ParserInitializationException
* Thrown if the parserKey parameter cannot be
* resolved by the selected parser factory.
* In the DefaultFTPEntryParserFactory, this will
@@ -3197,15 +3197,15 @@
* returned if a data connection cannot be opened. If the current working
* directory contains no files, an empty array will be the return.
*
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException
+ * @throws IOException
* If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
- * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
+ * @throws org.apache.commons.net.ftp.parser.ParserInitializationException
* Thrown if the autodetect mechanism cannot
* resolve the type of system we are connected with.
* @see FTPListParseEngine
@@ -3253,15 +3253,15 @@
* returned if a data connection cannot be opened. If the current working
* directory contains no files, an empty array will be the return.
*
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException
+ * @throws IOException
* If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
- * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
+ * @throws org.apache.commons.net.ftp.parser.ParserInitializationException
* Thrown if the autodetect mechanism cannot
* resolve the type of system we are connected with.
* @see FTPListParseEngine
@@ -3306,15 +3306,15 @@
* returned if a data connection cannot be opened. If the current working
* directory contains no files, an empty array will be the return.
*
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException
+ * @throws IOException
* If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
- * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
+ * @throws org.apache.commons.net.ftp.parser.ParserInitializationException
* Thrown if the parserKey parameter cannot be
* resolved by the selected parser factory.
* In the DefaultFTPEntryParserFactory, this will
@@ -3388,12 +3388,12 @@
* private method through which all listFiles() and
* initiateListParsing methods pass once a parser is determined.
*
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException
+ * @throws IOException
* If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
* @see FTPListParseEngine
@@ -3476,12 +3476,12 @@
* Issue the FTP STAT command to the server.
*
* @return The status information returned by the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public String getStatus() throws IOException
@@ -3499,12 +3499,12 @@
* @param pathname the filename
*
* @return The status information returned by the server.
- * @exception FTPConnectionClosedException
+ * @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 independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*/
public String getStatus(String pathname) throws IOException
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
index db1b465..d917800 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
@@ -102,7 +102,7 @@
* read.
*
* @return A string representing the next ftp entry or null if none found.
- * @exception IOException thrown on any IO Error reading from the reader.
+ * @throws IOException thrown on any IO Error reading from the reader.
*/
String readNextEntry(BufferedReader reader) throws IOException;
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParserImpl.java b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParserImpl.java
index f6a83df..7f29224 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParserImpl.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParserImpl.java
@@ -45,7 +45,7 @@
* read.
*
* @return A string representing the next ftp entry or null if none found.
- * @exception java.io.IOException thrown on any IO Error reading from the reader.
+ * @throws java.io.IOException thrown on any IO Error reading from the reader.
*/
@Override
public String readNextEntry(BufferedReader reader) throws IOException
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java b/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
index 5048af9..46bee34 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
@@ -109,7 +109,7 @@
* @param stream input stream provided by the server socket.
* @param encoding the encoding to be used for reading the stream
*
- * @exception IOException
+ * @throws IOException
* thrown on any failure to read from the sever.
*/
public void readServerList(InputStream stream, String encoding)
@@ -132,7 +132,7 @@
* @param stream The socket stream on which the input will be read.
* @param encoding The encoding to use.
*
- * @exception IOException
+ * @throws IOException
* thrown on any failure to read the stream
*/
private void readStream(InputStream stream, String encoding) throws IOException
@@ -237,7 +237,7 @@
* @return an array of FTPFile objects containing the whole list of
* files returned by the server as read by this object's parser.
* None of the entries will be null
- * @exception IOException - not ever thrown, may be removed in a later release
+ * @throws IOException - not ever thrown, may be removed in a later release
*/
public FTPFile[] getFiles()
throws IOException // TODO remove; not actually thrown
@@ -261,7 +261,7 @@
* a filter such as {@link FTPFileFilters#NON_NULL} which does not
* allow null entries.
* @since 2.2
- * @exception IOException - not ever thrown, may be removed in a later release
+ * @throws IOException - not ever thrown, may be removed in a later release
*/
public FTPFile[] getFiles(FTPFileFilter filter)
throws IOException // TODO remove; not actually thrown
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
index 31b7349..71c0ec2 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
@@ -740,7 +740,7 @@
* Calls {@code setSocketFactory(null)} and {@code setServerSocketFactory(null)}
* to reset the factories that may have been changed during the session,
* e.g. by {@link #execPROT(String)}
- * @exception IOException If an error occurs while disconnecting.
+ * @throws IOException If an error occurs while disconnecting.
* @since 3.0
*/
@Override
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java b/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
index 4a6b0ba..f4d0df0 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
@@ -192,7 +192,7 @@
* used to configure the parser created
*
* @return the @link FTPFileEntryParser FTPFileEntryParser} so created.
- * @exception ParserInitializationException
+ * @throws ParserInitializationException
* Thrown on any exception in instantiation
* @throws NullPointerException if {@code config} is {@code null}
* @since 1.4
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/FTPFileEntryParserFactory.java b/src/main/java/org/apache/commons/net/ftp/parser/FTPFileEntryParserFactory.java
index b46eaf7..9901a97 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/FTPFileEntryParserFactory.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/FTPFileEntryParserFactory.java
@@ -34,7 +34,7 @@
* FTPFileEntryParser to be created.
*
* @return the FTPFileEntryParser created.
- * @exception ParserInitializationException
+ * @throws ParserInitializationException
* Thrown on any exception in instantiation
*/
public FTPFileEntryParser createFileEntryParser(String key)
@@ -58,7 +58,7 @@
* used to configure the parser created
*
* @return the @link FTPFileEntryParser FTPFileEntryParser} so created.
- * @exception ParserInitializationException
+ * @throws ParserInitializationException
* Thrown on any exception in instantiation
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java
index 1718c1c..2878002 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java
@@ -87,7 +87,7 @@
/**
* The default constructor for a UnixFTPEntryParser object.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -103,7 +103,7 @@
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java
index 13408c6..29df5b0 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java
@@ -51,7 +51,7 @@
/**
* The sole constructor for an NTFTPEntryParser object.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -67,7 +67,7 @@
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java
index ae0cd44..c3f0af9 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java
@@ -58,7 +58,7 @@
/**
* The default constructor for a NetwareFTPEntryParser object.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -73,7 +73,7 @@
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java
index 74ebab2..0fc9451 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java
@@ -46,7 +46,7 @@
/**
* The default constructor for a OS2FTPEntryParser object.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -62,7 +62,7 @@
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
index 3d0ae1e..c4d52b7 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
@@ -249,7 +249,7 @@
/**
* The default constructor for a OS400FTPEntryParser object.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -265,7 +265,7 @@
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java b/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
index c73d960..50ef365 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
@@ -58,7 +58,7 @@
* @param regex The regular expression with which this object is
* initialized.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen in
* normal conditions. It it is seen, this is a sign that a subclass has
* been created with a bad regular expression. Since the parser must be
@@ -78,7 +78,7 @@
* initialized.
* @param flags the flags to apply, see {@link Pattern#compile(String, int)}. Use 0 for none.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen in
* normal conditions. It it is seen, this is a sign that a subclass has
* been created with a bad regular expression. Since the parser must be
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
index 894d0bc..fde74a8 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
@@ -134,7 +134,7 @@
/**
* The default constructor for a UnixFTPEntryParser object.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -150,7 +150,7 @@
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -168,7 +168,7 @@
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
* @param trimLeadingSpaces if {@code true}, trim leading spaces from file names
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
index 4c66a48..73531ce 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
@@ -65,7 +65,7 @@
/**
* Constructor for a VMSFTPEntryParser object.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -81,7 +81,7 @@
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -206,7 +206,7 @@
* read.
*
* @return A string representing the next ftp entry or null if none found.
- * @exception IOException thrown on any IO Error reading from the reader.
+ * @throws IOException thrown on any IO Error reading from the reader.
*/
@Override
public String readNextEntry(BufferedReader reader) throws IOException
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java
index c6d24ef..c097fc5 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java
@@ -53,7 +53,7 @@
/**
* Constructor for a VMSFTPEntryParser object.
*
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
@@ -69,7 +69,7 @@
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
- * @exception IllegalArgumentException
+ * @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
diff --git a/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java b/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
index 93055d6..30f5cee 100644
--- a/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
+++ b/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
@@ -108,13 +108,13 @@
* @param username user
* @param password password
* @return True if successfully completed, false if not.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
- * @exception NoSuchAlgorithmException If the CRAM hash algorithm
+ * @throws NoSuchAlgorithmException If the CRAM hash algorithm
* cannot be instantiated by the Java runtime system.
- * @exception InvalidKeyException If the CRAM hash algorithm
+ * @throws InvalidKeyException If the CRAM hash algorithm
* failed to use the given password.
- * @exception InvalidKeySpecException If the CRAM hash algorithm
+ * @throws InvalidKeySpecException If the CRAM hash algorithm
* failed to use the given password.
*/
public boolean authenticate(AuthenticatingIMAPClient.AUTH_METHOD method,
@@ -133,13 +133,13 @@
* @param username user
* @param password password
* @return True if successfully completed, false if not.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
- * @exception NoSuchAlgorithmException If the CRAM hash algorithm
+ * @throws NoSuchAlgorithmException If the CRAM hash algorithm
* cannot be instantiated by the Java runtime system.
- * @exception InvalidKeyException If the CRAM hash algorithm
+ * @throws InvalidKeyException If the CRAM hash algorithm
* failed to use the given password.
- * @exception InvalidKeySpecException If the CRAM hash algorithm
+ * @throws InvalidKeySpecException If the CRAM hash algorithm
* failed to use the given password.
*/
public boolean auth(AuthenticatingIMAPClient.AUTH_METHOD method,
diff --git a/src/main/java/org/apache/commons/net/imap/IMAP.java b/src/main/java/org/apache/commons/net/imap/IMAP.java
index b255e2b..5469116 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAP.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAP.java
@@ -259,7 +259,7 @@
* from the last issued command is voided to allow garbage collection
* of the memory used to store that information.
*
- * @exception IOException If there is an error in disconnecting.
+ * @throws IOException If there is an error in disconnecting.
*/
@Override
public void disconnect() throws IOException
diff --git a/src/main/java/org/apache/commons/net/imap/IMAPClient.java b/src/main/java/org/apache/commons/net/imap/IMAPClient.java
index c0ab347..5ae1487 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPClient.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPClient.java
@@ -34,7 +34,7 @@
/**
* Send a CAPABILITY command to the server.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs
+ * @throws IOException If a network I/O error occurs
*/
public boolean capability() throws IOException
{
@@ -46,7 +46,7 @@
* a connection alive since most IMAP servers will timeout after 10
* minutes of inactivity.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean noop() throws IOException
{
@@ -60,7 +60,7 @@
* the client is in the not authenticated or authenticated state, it enters the
* logout on a successful logout.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean logout() throws IOException
{
@@ -82,7 +82,7 @@
* @param username The account name being logged in to.
* @param password The plain text password of the account.
* @return True if the login attempt was successful, false if not.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* logging in.
*/
public boolean login(String username, String password) throws IOException
@@ -108,7 +108,7 @@
* Send a SELECT command to the server.
* @param mailboxName The mailbox name to select.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean select(String mailboxName) throws IOException
{
@@ -119,7 +119,7 @@
* Send an EXAMINE command to the server.
* @param mailboxName The mailbox name to examine.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean examine(String mailboxName) throws IOException
{
@@ -130,7 +130,7 @@
* Send a CREATE command to the server.
* @param mailboxName The mailbox name to create.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean create(String mailboxName) throws IOException
{
@@ -141,7 +141,7 @@
* Send a DELETE command to the server.
* @param mailboxName The mailbox name to delete.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean delete(String mailboxName) throws IOException
{
@@ -153,7 +153,7 @@
* @param oldMailboxName The existing mailbox name to rename.
* @param newMailboxName The new mailbox name.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean rename(String oldMailboxName, String newMailboxName) throws IOException
{
@@ -164,7 +164,7 @@
* Send a SUBSCRIBE command to the server.
* @param mailboxName The mailbox name to subscribe to.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean subscribe(String mailboxName) throws IOException
{
@@ -175,7 +175,7 @@
* Send a UNSUBSCRIBE command to the server.
* @param mailboxName The mailbox name to unsubscribe from.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean unsubscribe(String mailboxName) throws IOException
{
@@ -187,7 +187,7 @@
* @param refName The reference name.
* @param mailboxName The mailbox name.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean list(String refName, String mailboxName) throws IOException
{
@@ -199,7 +199,7 @@
* @param refName The reference name.
* @param mailboxName The mailbox name.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean lsub(String refName, String mailboxName) throws IOException
{
@@ -211,7 +211,7 @@
* @param mailboxName The reference name.
* @param itemNames The status data item names.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean status(String mailboxName, String[] itemNames) throws IOException
{
@@ -242,7 +242,7 @@
* @param datetime The date/time string (optional).
* @param message The message to append.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
* @since 3.4
*/
public boolean append(String mailboxName, String flags, String datetime, String message) throws IOException
@@ -277,7 +277,7 @@
* @param flags The flag parenthesized list (optional).
* @param datetime The date/time string (optional).
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
* @deprecated (3.4) Does not work; the message body is not optional.
* Use {@link #append(String, String, String, String)} instead.
*/
@@ -302,7 +302,7 @@
* Send an APPEND command to the server.
* @param mailboxName The mailbox name.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
* @deprecated (3.4) Does not work; the message body is not optional.
* Use {@link #append(String, String, String, String)} instead.
*/
@@ -317,7 +317,7 @@
/**
* Send a CHECK command to the server.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean check() throws IOException
{
@@ -327,7 +327,7 @@
/**
* Send a CLOSE command to the server.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean close() throws IOException
{
@@ -337,7 +337,7 @@
/**
* Send an EXPUNGE command to the server.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean expunge() throws IOException
{
@@ -349,7 +349,7 @@
* @param charset The charset (optional).
* @param criteria The search criteria.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean search(String charset, String criteria) throws IOException
{
@@ -365,7 +365,7 @@
* Send a SEARCH command to the server.
* @param criteria The search criteria.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean search(String criteria) throws IOException
{
@@ -379,7 +379,7 @@
* @param itemNames The item names for the FETCH command. (e.g. BODY.PEEK[HEADER.FIELDS (SUBJECT)])
* If multiple item names are requested, these must be enclosed in parentheses, e.g. "(UID FLAGS BODY.PEEK[])"
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
* @see #getReplyString()
* @see #getReplyStrings()
*/
@@ -394,7 +394,7 @@
* @param itemNames The item name for the STORE command (i.e. [+|-]FLAGS[.SILENT])
* @param itemValues The item values for the STORE command. (e.g. (\Deleted) )
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean store(String sequenceSet, String itemNames, String itemValues)
throws IOException
@@ -407,7 +407,7 @@
* @param sequenceSet The sequence set to fetch.
* @param mailboxName The mailbox name.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean copy(String sequenceSet, String mailboxName) throws IOException
{
@@ -419,7 +419,7 @@
* @param command The command for UID.
* @param commandArgs The arguments for the command.
* @return {@code true} if the command was successful,{@code false} if not.
- * @exception IOException If a network I/O error occurs.
+ * @throws IOException If a network I/O error occurs.
*/
public boolean uid(String command, String commandArgs) throws IOException
{
diff --git a/src/main/java/org/apache/commons/net/io/DotTerminatedMessageReader.java b/src/main/java/org/apache/commons/net/io/DotTerminatedMessageReader.java
index 612f565..91ff13c 100644
--- a/src/main/java/org/apache/commons/net/io/DotTerminatedMessageReader.java
+++ b/src/main/java/org/apache/commons/net/io/DotTerminatedMessageReader.java
@@ -69,7 +69,7 @@
* completeness.
* @return The next character in the message. Returns -1 if the end of the
* message has been reached.
- * @exception IOException If an error occurs while reading the underlying
+ * @throws IOException If an error occurs while reading the underlying
* stream.
*/
@Override
@@ -140,7 +140,7 @@
* @param buffer The character array in which to store the characters.
* @return The number of characters read. Returns -1 if the
* end of the message has been reached.
- * @exception IOException If an error occurs in reading the underlying
+ * @throws IOException If an error occurs in reading the underlying
* stream.
*/
@Override
@@ -160,7 +160,7 @@
* @param length The number of characters to read.
* @return The number of characters read. Returns -1 if the
* end of the message has been reached.
- * @exception IOException If an error occurs in reading the underlying
+ * @throws IOException If an error occurs in reading the underlying
* stream.
*/
@Override
@@ -201,7 +201,7 @@
* for communicating with the server. If you do not fully read
* a message, you MUST close it, otherwise your program will likely
* hang or behave improperly.
- * @exception IOException If an error occurs while reading the
+ * @throws IOException If an error occurs while reading the
* underlying stream.
*/
@Override
diff --git a/src/main/java/org/apache/commons/net/io/DotTerminatedMessageWriter.java b/src/main/java/org/apache/commons/net/io/DotTerminatedMessageWriter.java
index 44e19ba..cb98cb8 100644
--- a/src/main/java/org/apache/commons/net/io/DotTerminatedMessageWriter.java
+++ b/src/main/java/org/apache/commons/net/io/DotTerminatedMessageWriter.java
@@ -68,7 +68,7 @@
* is only mentioned for completeness.
*
* @param ch The character to write.
- * @exception IOException If an error occurs while writing to the
+ * @throws IOException If an error occurs while writing to the
* underlying output.
***/
@Override
@@ -111,7 +111,7 @@
* @param buffer The character array to write.
* @param offset The offset into the array at which to start copying data.
* @param length The number of characters to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* output.
***/
@Override
@@ -130,7 +130,7 @@
* Writes a character array to the output.
*
* @param buffer The character array to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* output.
***/
@Override
@@ -144,7 +144,7 @@
* Writes a String to the output.
*
* @param string The String to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* output.
***/
@Override
@@ -160,7 +160,7 @@
* @param string The String to write.
* @param offset The offset into the String at which to start copying data.
* @param length The number of characters to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* output.
***/
@Override
@@ -173,7 +173,7 @@
/***
* Flushes the underlying output, writing all buffered output.
*
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* output.
***/
@Override
@@ -191,7 +191,7 @@
* actually close the underlying stream. The underlying stream may still
* be used for communicating with the server and therefore is not closed.
*
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* output or closing the Writer.
***/
@Override
diff --git a/src/main/java/org/apache/commons/net/io/FromNetASCIIInputStream.java b/src/main/java/org/apache/commons/net/io/FromNetASCIIInputStream.java
index 5cba6e5..3d1b231 100644
--- a/src/main/java/org/apache/commons/net/io/FromNetASCIIInputStream.java
+++ b/src/main/java/org/apache/commons/net/io/FromNetASCIIInputStream.java
@@ -114,7 +114,7 @@
*
* @return The next character in the stream. Returns -1 if the end of the
* stream has been reached.
- * @exception IOException If an error occurs while reading the underlying
+ * @throws IOException If an error occurs while reading the underlying
* stream.
***/
@Override
@@ -136,7 +136,7 @@
* @param buffer The byte array in which to store the data.
* @return The number of bytes read. Returns -1 if the
* end of the message has been reached.
- * @exception IOException If an error occurs in reading the underlying
+ * @throws IOException If an error occurs in reading the underlying
* stream.
***/
@Override
@@ -157,7 +157,7 @@
* @param length The number of bytes to read.
* @return The number of bytes read. Returns -1 if the
* end of the stream has been reached.
- * @exception IOException If an error occurs while reading the underlying
+ * @throws IOException If an error occurs while reading the underlying
* stream.
***/
@Override
diff --git a/src/main/java/org/apache/commons/net/io/FromNetASCIIOutputStream.java b/src/main/java/org/apache/commons/net/io/FromNetASCIIOutputStream.java
index f7484a7..412addc 100644
--- a/src/main/java/org/apache/commons/net/io/FromNetASCIIOutputStream.java
+++ b/src/main/java/org/apache/commons/net/io/FromNetASCIIOutputStream.java
@@ -92,7 +92,7 @@
* completeness.
*
* @param ch The byte to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
@@ -113,7 +113,7 @@
* Writes a byte array to the stream.
*
* @param buffer The byte array to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
@@ -131,7 +131,7 @@
* @param buffer The byte array to write.
* @param offset The offset into the array at which to start copying data.
* @param length The number of bytes to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
@@ -155,7 +155,7 @@
/***
* Closes the stream, writing all pending data.
*
- * @exception IOException If an error occurs while closing the stream.
+ * @throws IOException If an error occurs while closing the stream.
***/
@Override
public synchronized void close()
diff --git a/src/main/java/org/apache/commons/net/io/SocketInputStream.java b/src/main/java/org/apache/commons/net/io/SocketInputStream.java
index b186c09..b84a4a2 100644
--- a/src/main/java/org/apache/commons/net/io/SocketInputStream.java
+++ b/src/main/java/org/apache/commons/net/io/SocketInputStream.java
@@ -56,7 +56,7 @@
* Closes the stream and immediately afterward closes the referenced
* socket.
*
- * @exception IOException If there is an error in closing the stream
+ * @throws IOException If there is an error in closing the stream
* or socket.
***/
@Override
diff --git a/src/main/java/org/apache/commons/net/io/SocketOutputStream.java b/src/main/java/org/apache/commons/net/io/SocketOutputStream.java
index f1f8781..6af8f54 100644
--- a/src/main/java/org/apache/commons/net/io/SocketOutputStream.java
+++ b/src/main/java/org/apache/commons/net/io/SocketOutputStream.java
@@ -62,7 +62,7 @@
* @param buffer The byte array to write.
* @param offset The offset into the array at which to start copying data.
* @param length The number of bytes to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
@@ -76,7 +76,7 @@
* Closes the stream and immediately afterward closes the referenced
* socket.
*
- * @exception IOException If there is an error in closing the stream
+ * @throws IOException If there is an error in closing the stream
* or socket.
***/
@Override
diff --git a/src/main/java/org/apache/commons/net/io/ToNetASCIIInputStream.java b/src/main/java/org/apache/commons/net/io/ToNetASCIIInputStream.java
index 1c34c2f..f0ec930 100644
--- a/src/main/java/org/apache/commons/net/io/ToNetASCIIInputStream.java
+++ b/src/main/java/org/apache/commons/net/io/ToNetASCIIInputStream.java
@@ -58,7 +58,7 @@
*
* @return The next character in the stream. Returns -1 if the end of the
* stream has been reached.
- * @exception IOException If an error occurs while reading the underlying
+ * @throws IOException If an error occurs while reading the underlying
* stream.
***/
@Override
@@ -103,7 +103,7 @@
* @param buffer The byte array in which to store the data.
* @return The number of bytes read. Returns -1 if the
* end of the message has been reached.
- * @exception IOException If an error occurs in reading the underlying
+ * @throws IOException If an error occurs in reading the underlying
* stream.
***/
@Override
@@ -124,7 +124,7 @@
* @param length The number of bytes to read.
* @return The number of bytes read. Returns -1 if the
* end of the stream has been reached.
- * @exception IOException If an error occurs while reading the underlying
+ * @throws IOException If an error occurs while reading the underlying
* stream.
***/
@Override
diff --git a/src/main/java/org/apache/commons/net/io/ToNetASCIIOutputStream.java b/src/main/java/org/apache/commons/net/io/ToNetASCIIOutputStream.java
index b31a448..989bfc3 100644
--- a/src/main/java/org/apache/commons/net/io/ToNetASCIIOutputStream.java
+++ b/src/main/java/org/apache/commons/net/io/ToNetASCIIOutputStream.java
@@ -57,7 +57,7 @@
* completeness.
*
* @param ch The byte to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
@@ -87,7 +87,7 @@
* Writes a byte array to the stream.
*
* @param buffer The byte array to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
@@ -105,7 +105,7 @@
* @param buffer The byte array to write.
* @param offset The offset into the array at which to start copying data.
* @param length The number of bytes to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
diff --git a/src/main/java/org/apache/commons/net/io/Util.java b/src/main/java/org/apache/commons/net/io/Util.java
index 80c932f..1f4e5b5 100644
--- a/src/main/java/org/apache/commons/net/io/Util.java
+++ b/src/main/java/org/apache/commons/net/io/Util.java
@@ -78,7 +78,7 @@
* buffered streams. If you don't flush, the data will stay in
* the stream buffer.
* @return number of bytes read/written
- * @exception CopyStreamException If an error occurs while reading from the
+ * @throws CopyStreamException If an error occurs while reading from the
* source or writing to the destination. The CopyStreamException
* will contain the number of bytes confirmed to have been
* transferred before an
@@ -166,7 +166,7 @@
* @param listener The CopyStreamListener to notify of progress. If
* this parameter is null, notification is not attempted.
* @return number of bytes read/written
- * @exception CopyStreamException If an error occurs while reading from the
+ * @throws CopyStreamException If an error occurs while reading from the
* source or writing to the destination. The CopyStreamException
* will contain the number of bytes confirmed to have been
* transferred before an
@@ -198,7 +198,7 @@
* @param bufferSize The number of bytes to buffer during the copy.
* A zero or negative value means to use {@link #DEFAULT_COPY_BUFFER_SIZE}.
* @return The number of bytes read/written in the copy operation.
- * @exception CopyStreamException If an error occurs while reading from the
+ * @throws CopyStreamException If an error occurs while reading from the
* source or writing to the destination. The CopyStreamException
* will contain the number of bytes confirmed to have been
* transferred before an
@@ -254,7 +254,7 @@
* @param listener The CopyStreamListener to notify of progress. If
* this parameter is null, notification is not attempted.
* @return The number of characters read/written in the copy operation.
- * @exception CopyStreamException If an error occurs while reading from the
+ * @throws CopyStreamException If an error occurs while reading from the
* source or writing to the destination. The CopyStreamException
* will contain the number of bytes confirmed to have been
* transferred before an
@@ -323,7 +323,7 @@
* @param bufferSize The number of characters to buffer during the copy.
* A zero or negative value means to use {@link #DEFAULT_COPY_BUFFER_SIZE}.
* @return The number of characters read/written in the copy operation.
- * @exception CopyStreamException If an error occurs while reading from the
+ * @throws CopyStreamException If an error occurs while reading from the
* source or writing to the destination. The CopyStreamException
* will contain the number of bytes confirmed to have been
* transferred before an
diff --git a/src/main/java/org/apache/commons/net/nntp/NNTP.java b/src/main/java/org/apache/commons/net/nntp/NNTP.java
index 2a4eba5..3ab7e7c 100644
--- a/src/main/java/org/apache/commons/net/nntp/NNTP.java
+++ b/src/main/java/org/apache/commons/net/nntp/NNTP.java
@@ -187,7 +187,7 @@
* garbage collector. The reply text and code information from the
* last command is voided so that the memory it used may be reclaimed.
* <p>
- * @exception IOException If an error occurs while disconnecting.
+ * @throws IOException If an error occurs while disconnecting.
***/
@Override
public void disconnect() throws IOException
@@ -224,12 +224,12 @@
* set to null, then the command is sent with no argument.
* @return The integer value of the NNTP reply code returned by the server
* in response to the command.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(String command, String args) throws IOException
@@ -268,12 +268,12 @@
* @return The integer value of the NNTP reply code returned by the server
* in response to the command.
* in response to the command.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(int command, String args) throws IOException
@@ -292,12 +292,12 @@
* @return The integer value of the NNTP reply code returned by the server
* in response to the command.
* in response to the command.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(String command) throws IOException
@@ -317,12 +317,12 @@
* @return The integer value of the NNTP reply code returned by the server
* in response to the command.
* in response to the command.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(int command) throws IOException
@@ -353,12 +353,12 @@
* <p>
* @return The integer value of the reply code of the fetched NNTP reply.
* in response to the command.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while
+ * @throws IOException If an I/O error occurs while
* receiving the server reply.
***/
public int getReply() throws IOException
@@ -387,12 +387,12 @@
* @param messageId The message identifier of the requested article,
* including the encapsulating < and > characters.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int article(String messageId) throws IOException
@@ -407,12 +407,12 @@
* @param articleNumber The number of the article to request from the
* currently selected newsgroup.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int article(long articleNumber) throws IOException
@@ -425,12 +425,12 @@
* receive the initial reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int article() throws IOException
@@ -447,12 +447,12 @@
* @param messageId The message identifier of the requested article,
* including the encapsulating < and > characters.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int body(String messageId) throws IOException
@@ -467,12 +467,12 @@
* @param articleNumber The number of the article to request from the
* currently selected newsgroup.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int body(long articleNumber) throws IOException
@@ -485,12 +485,12 @@
* receive the initial reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int body() throws IOException
@@ -507,12 +507,12 @@
* @param messageId The message identifier of the requested article,
* including the encapsulating < and > characters.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int head(String messageId) throws IOException
@@ -527,12 +527,12 @@
* @param articleNumber The number of the article to request from the
* currently selected newsgroup.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int head(long articleNumber) throws IOException
@@ -545,12 +545,12 @@
* receive the initial reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int head() throws IOException
@@ -567,12 +567,12 @@
* @param messageId The message identifier of the requested article,
* including the encapsulating < and > characters.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int stat(String messageId) throws IOException
@@ -587,12 +587,12 @@
* @param articleNumber The number of the article to request from the
* currently selected newsgroup.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int stat(long articleNumber) throws IOException
@@ -605,12 +605,12 @@
* receive the initial reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int stat() throws IOException
@@ -625,12 +625,12 @@
* <p>
* @param newsgroup The name of the newsgroup to select.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int group(String newsgroup) throws IOException
@@ -644,12 +644,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int help() throws IOException
@@ -665,12 +665,12 @@
* @param messageId The article identifier,
* including the encapsulating < and > characters.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int ihave(String messageId) throws IOException
@@ -684,12 +684,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int last() throws IOException
@@ -704,12 +704,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int list() throws IOException
@@ -724,12 +724,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int next() throws IOException
@@ -750,12 +750,12 @@
* @param distributions Comma-separated distribution list to check for
* new groups. Set to null if no distributions.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int newgroups(String date, String time, boolean GMT,
@@ -798,12 +798,12 @@
* @param distributions Comma-separated distribution list to check for
* new news. Set to null if no distributions.
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int newnews(String newsgroups, String date, String time, boolean GMT,
@@ -840,12 +840,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int post() throws IOException
@@ -860,12 +860,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int quit() throws IOException
@@ -880,12 +880,12 @@
* @param username A valid username.
* @return The reply code received from the server. The server should
* return a 381 or 281 for this command.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int authinfoUser(String username) throws IOException {
@@ -902,12 +902,12 @@
* @param password a valid password.
* @return The reply code received from the server. The server should
* return a 281 or 502 for this command.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int authinfoPass(String password) throws IOException {
@@ -927,12 +927,12 @@
* following articles" In this revision, the last format is not
* possible (yet).
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int xover(String selectedArticles) throws IOException {
@@ -953,12 +953,12 @@
* following articles" In this revision, the last format is not
* possible (yet).
* @return The reply code received from the server.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int xhdr(String header, String selectedArticles) throws IOException {
diff --git a/src/main/java/org/apache/commons/net/nntp/NNTPClient.java b/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
index 4c64466..be3f0de 100644
--- a/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
+++ b/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
@@ -347,12 +347,12 @@
* returned article information.
* @return A DotTerminatedMessageReader instance from which the article
* can be read. null if the article does not exist.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public BufferedReader retrieveArticle(String articleId, ArticleInfo pointer)
@@ -418,12 +418,12 @@
* returned article information.
* @return A DotTerminatedMessageReader instance from which the article
* can be read. null if the article does not exist.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public BufferedReader retrieveArticle(long articleNumber, ArticleInfo pointer)
@@ -478,12 +478,12 @@
* returned article information.
* @return A DotTerminatedMessageReader instance from which the article
* header can be read. null if the article does not exist.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public BufferedReader retrieveArticleHeader(String articleId, ArticleInfo pointer)
@@ -547,12 +547,12 @@
* returned article information.
* @return A DotTerminatedMessageReader instance from which the article
* header can be read. null if the article does not exist.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public BufferedReader retrieveArticleHeader(long articleNumber,
@@ -609,12 +609,12 @@
* returned article information.
* @return A DotTerminatedMessageReader instance from which the article
* body can be read. null if the article does not exist.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public BufferedReader retrieveArticleBody(String articleId, ArticleInfo pointer)
@@ -680,12 +680,12 @@
* returned article information.
* @return A DotTerminatedMessageReader instance from which the article
* body can be read. null if the article does not exist.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public BufferedReader retrieveArticleBody(long articleNumber,
@@ -718,12 +718,12 @@
* the selected newsgroup contained in the server reply is returned.
* Set this to null if you do not desire this information.
* @return True if the newsgroup exists and was selected, false otherwise.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean selectNewsgroup(String newsgroup, NewsgroupInfo info)
@@ -755,12 +755,12 @@
* List the command help from the server.
* <p>
* @return The sever help information.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public String listHelp() throws IOException
@@ -816,12 +816,12 @@
* set this parameter to null if you do not desire to retrieve the
* returned article information.
* @return True if successful, false if not.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean selectArticle(String articleId, ArticleInfo pointer)
@@ -885,12 +885,12 @@
* to this particular command. You may set this parameter to null if
* you do not desire to retrieve the returned article information.
* @return True if successful, false if not.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean selectArticle(long articleNumber, ArticleInfo pointer)
@@ -934,12 +934,12 @@
* returned article information.
* @return True if successful, false if not (e.g., there is no previous
* article).
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean selectPreviousArticle(ArticleInfo pointer)
@@ -981,12 +981,12 @@
* returned article information.
* @return True if successful, false if not (e.g., there is no following
* article).
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean selectNextArticle(ArticleInfo pointer) throws IOException
@@ -1022,12 +1022,12 @@
* for each newsgroup served by the NNTP server. If no newsgroups
* are served, a zero length array will be returned. If the command
* fails, null will be returned.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
* @see #iterateNewsgroupListing()
* @see #iterateNewsgroups()
@@ -1049,12 +1049,12 @@
* @return An iterable of NewsgroupInfo instances containing the information
* for each newsgroup served by the NNTP server. If no newsgroups
* are served, no entries will be returned.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @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
*/
@@ -1073,12 +1073,12 @@
* @return An iterable of Strings containing the raw information
* for each newsgroup served by the NNTP server. If no newsgroups
* are served, no entries will be returned.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @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
*/
@@ -1155,12 +1155,12 @@
* for each new newsgroup added to the NNTP server. If no newsgroups
* were added, a zero length array will be returned. If the command
* fails, null will be returned.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
* @see #iterateNewNewsgroups(NewGroupsOrNewsQuery)
* @see #iterateNewNewsgroupListing(NewGroupsOrNewsQuery)
@@ -1188,12 +1188,12 @@
* @return An iterable of Strings containing the raw information
* for each new newsgroup added to the NNTP server. If no newsgroups
* were added, no entries will be returned.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @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
*/
@@ -1216,12 +1216,12 @@
* @return An iterable of NewsgroupInfo instances containing the information
* for each new newsgroup added to the NNTP server. If no newsgroups
* were added, no entries will be returned.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @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
*/
@@ -1245,12 +1245,12 @@
* identifiers for each new article added to the NNTP server. If no
* new news is found, a zero length array will be returned. If the
* command fails, null will be returned.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
*
* @see #iterateNewNews(NewGroupsOrNewsQuery)
@@ -1301,12 +1301,12 @@
* @return An iterator of String instances containing the unique message
* identifiers for each new article added to the NNTP server. If no
* new news is found, no strings will be returned.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @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
*/
@@ -1343,12 +1343,12 @@
* </pre>
* <p>
* @return True if successfully completed, false if not.
- * @exception NNTPConnectionClosedException
+ * @throws NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send NNTP reply code 400. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean completePendingCommand() throws IOException
@@ -1390,7 +1390,7 @@
* <p>
* @return A DotTerminatedMessageWriter to which the article (including
* header) can be written. Returns null if the command fails.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
@@ -1420,7 +1420,7 @@
* a new connection.
* <p>
* @return True if successfully completed, false if not.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean logout() throws IOException
@@ -1466,7 +1466,7 @@
* @param articleRange
* @return Returns a DotTerminatedMessageReader if successful, null
* otherwise
- * @exception IOException
+ * @throws IOException
*/
private BufferedReader __retrieveArticleInfo(String articleRange)
throws IOException
@@ -1539,7 +1539,7 @@
* @param articleRange
* @return Returns a DotTerminatedMessageReader if successful, null
* otherwise
- * @exception IOException
+ * @throws IOException
*/
private BufferedReader __retrieveHeader(String header, String articleRange)
throws IOException
diff --git a/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java b/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
index 77065a9..a3be036 100644
--- a/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
+++ b/src/main/java/org/apache/commons/net/ntp/NTPUDPClient.java
@@ -55,7 +55,7 @@
* @param host The address of the server.
* @param port The port of the service.
* @return The time value retrieved from the server.
- * @exception IOException If an error occurs while retrieving the time.
+ * @throws IOException If an error occurs while retrieving the time.
***/
public TimeInfo getTime(InetAddress host, int port) throws IOException
{
@@ -106,7 +106,7 @@
* <p>
* @param host The address of the server.
* @return The time value retrieved from the server.
- * @exception IOException If an error occurs while retrieving the time.
+ * @throws IOException If an error occurs while retrieving the time.
***/
public TimeInfo getTime(InetAddress host) throws IOException
{
diff --git a/src/main/java/org/apache/commons/net/pop3/ExtendedPOP3Client.java b/src/main/java/org/apache/commons/net/pop3/ExtendedPOP3Client.java
index dd7301e..a806c11 100644
--- a/src/main/java/org/apache/commons/net/pop3/ExtendedPOP3Client.java
+++ b/src/main/java/org/apache/commons/net/pop3/ExtendedPOP3Client.java
@@ -53,13 +53,13 @@
* @param username the user name
* @param password the password
* @return True if successfully completed, false if not.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
- * @exception NoSuchAlgorithmException If the CRAM hash algorithm
+ * @throws NoSuchAlgorithmException If the CRAM hash algorithm
* cannot be instantiated by the Java runtime system.
- * @exception InvalidKeyException If the CRAM hash algorithm
+ * @throws InvalidKeyException If the CRAM hash algorithm
* failed to use the given password.
- * @exception InvalidKeySpecException If the CRAM hash algorithm
+ * @throws InvalidKeySpecException If the CRAM hash algorithm
* failed to use the given password.
***/
public boolean auth(AUTH_METHOD method,
diff --git a/src/main/java/org/apache/commons/net/pop3/POP3.java b/src/main/java/org/apache/commons/net/pop3/POP3.java
index 16dff6b..7363581 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3.java
@@ -202,7 +202,7 @@
* from the last issued command is voided to allow garbage collection
* of the memory used to store that information.
*
- * @exception IOException If there is an error in disconnecting.
+ * @throws IOException If there is an error in disconnecting.
***/
@Override
public void disconnect() throws IOException
diff --git a/src/main/java/org/apache/commons/net/pop3/POP3Client.java b/src/main/java/org/apache/commons/net/pop3/POP3Client.java
index 21a399e..16339bc 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3Client.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3Client.java
@@ -116,7 +116,7 @@
/***
* Send a CAPA command to the POP3 server.
* @return True if the command was successful, false if not.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the CAPA command.
* @since 3.1 (was previously in ExtendedPOP3Client)
***/
@@ -144,7 +144,7 @@
* @param username The account name being logged in to.
* @param password The plain text password of the account.
* @return True if the login attempt was successful, false if not.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* logging in.
***/
public boolean login(String username, String password) throws IOException
@@ -195,9 +195,9 @@
* @param secret The shared secret which produces the MD5 digest when
* combined with the timestamp.
* @return True if the login attempt was successful, false if not.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* logging in.
- * @exception NoSuchAlgorithmException If the MD5 encryption algorithm
+ * @throws NoSuchAlgorithmException If the MD5 encryption algorithm
* cannot be instantiated by the Java runtime system.
***/
public boolean login(String username, String timestamp, String secret)
@@ -252,7 +252,7 @@
* on a successful logout.
*
* @return True if the logout attempt was successful, false if not.
- * @exception IOException If a network I/O error occurs in the process
+ * @throws IOException If a network I/O error occurs in the process
* of logging out.
***/
public boolean logout() throws IOException
@@ -274,7 +274,7 @@
* .
*
* @return True if the noop attempt was successful, false if not.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the NOOP command.
***/
public boolean noop() throws IOException
@@ -298,7 +298,7 @@
*
* @param messageId The message number to delete.
* @return True if the deletion attempt was successful, false if not.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the delete command.
***/
public boolean deleteMessage(int messageId) throws IOException
@@ -319,7 +319,7 @@
* .
*
* @return True if the reset attempt was successful, false if not.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the reset command.
***/
public boolean reset() throws IOException
@@ -342,7 +342,7 @@
* @return A POP3MessageInfo instance containing the number of
* messages in the mailbox and the total size of the messages
* in bytes. Returns null if the status the attempt fails.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the status command.
***/
public POP3MessageInfo status() throws IOException
@@ -371,7 +371,7 @@
* @return A POP3MessageInfo instance containing the number of the
* listed message and the size of the message in bytes. Returns
* null if the list attempt fails.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the list command.
***/
public POP3MessageInfo listMessage(int messageId) throws IOException
@@ -401,7 +401,7 @@
* each containing the number of a message and its size in bytes.
* If there are no messages, this method returns a zero length array.
* If the list attempt fails, it returns null.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the list command.
***/
public POP3MessageInfo[] listMessages() throws IOException
@@ -441,7 +441,7 @@
* @return A POP3MessageInfo instance containing the number of the
* listed message and the unique identifier for that message.
* Returns null if the list attempt fails.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the list unique identifier command.
***/
public POP3MessageInfo listUniqueIdentifier(int messageId)
@@ -472,7 +472,7 @@
* each containing the number of a message and its unique identifier
* If there are no messages, this method returns a zero length array.
* If the list attempt fails, it returns null.
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the list unique identifier command.
***/
public POP3MessageInfo[] listUniqueIdentifiers() throws IOException
@@ -521,7 +521,7 @@
* use the {@link java.io.BufferedReader#readLine() BufferedReader#readLine()} method.
* Returns null if the retrieval attempt fails (e.g., if the specified
* message number does not exist).
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the retrieve message command.
*/
public Reader retrieveMessage(int messageId) throws IOException
@@ -562,7 +562,7 @@
* use the {@link java.io.BufferedReader#readLine() BufferedReader#readLine()} method.
* Returns null if the retrieval attempt fails (e.g., if the specified
* message number does not exist).
- * @exception IOException If a network I/O error occurs in the process of
+ * @throws IOException If a network I/O error occurs in the process of
* sending the top command.
*/
public Reader retrieveMessageTop(int messageId, int numLines)
diff --git a/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java b/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
index e3a9376..30dde84 100644
--- a/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
@@ -104,12 +104,12 @@
* <p>
* @param hostname The hostname of the sender.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int ehlo(String hostname) throws IOException
@@ -124,12 +124,12 @@
* <p>
* @param hostname The hostname with which to greet the SMTP server.
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean elogin(String hostname) throws IOException
@@ -144,12 +144,12 @@
* you must first login.
* <p>
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean elogin() throws IOException
@@ -196,18 +196,18 @@
* Ignored for XOAUTH.
*
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
- * @exception NoSuchAlgorithmException If the CRAM hash algorithm
+ * @throws NoSuchAlgorithmException If the CRAM hash algorithm
* cannot be instantiated by the Java runtime system.
- * @exception InvalidKeyException If the CRAM hash algorithm
+ * @throws InvalidKeyException If the CRAM hash algorithm
* failed to use the given password.
- * @exception InvalidKeySpecException If the CRAM hash algorithm
+ * @throws InvalidKeySpecException If the CRAM hash algorithm
* failed to use the given password.
***/
public boolean auth(AuthenticatingSMTPClient.AUTH_METHOD method,
diff --git a/src/main/java/org/apache/commons/net/smtp/SMTP.java b/src/main/java/org/apache/commons/net/smtp/SMTP.java
index 77aa23f..c09dca4 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTP.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTP.java
@@ -275,7 +275,7 @@
* garbage collector. The reply text and code information from the
* last command is voided so that the memory it used may be reclaimed.
* <p>
- * @exception IOException If an error occurs while disconnecting.
+ * @throws IOException If an error occurs while disconnecting.
***/
@Override
public void disconnect() throws IOException
@@ -301,12 +301,12 @@
* set to null, then the command is sent with no argument.
* @return The integer value of the SMTP reply code returned by the server
* in response to the command.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(String command, String args) throws IOException
@@ -328,12 +328,12 @@
* set to null, then the command is sent with no argument.
* @return The integer value of the SMTP reply code returned by the server
* in response to the command.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(int command, String args) throws IOException
@@ -352,12 +352,12 @@
* @param command The text representation of the SMTP command to send.
* @return The integer value of the SMTP reply code returned by the server
* in response to the command.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(String command) throws IOException
@@ -377,12 +377,12 @@
* to send.
* @return The integer value of the SMTP reply code returned by the server
* in response to the command.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int sendCommand(int command) throws IOException
@@ -413,12 +413,12 @@
* fetch a secondary response from the SMTP server.
* <p>
* @return The integer value of the reply code of the fetched SMTP reply.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while receiving the
+ * @throws IOException If an I/O error occurs while receiving the
* server reply.
***/
public int getReply() throws IOException
@@ -475,12 +475,12 @@
* <p>
* @param hostname The hostname of the sender.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int helo(String hostname) throws IOException
@@ -495,12 +495,12 @@
* <p>
* @param reversePath The reverese path.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int mail(String reversePath) throws IOException
@@ -515,12 +515,12 @@
* <p>
* @param forwardPath The forward path.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int rcpt(String forwardPath) throws IOException
@@ -534,12 +534,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int data() throws IOException
@@ -554,12 +554,12 @@
* <p>
* @param reversePath The reverese path.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int send(String reversePath) throws IOException
@@ -574,12 +574,12 @@
* <p>
* @param reversePath The reverese path.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int soml(String reversePath) throws IOException
@@ -594,12 +594,12 @@
* <p>
* @param reversePath The reverese path.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int saml(String reversePath) throws IOException
@@ -613,12 +613,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int rset() throws IOException
@@ -633,12 +633,12 @@
* <p>
* @param user The user address to verify.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int vrfy(String user) throws IOException
@@ -653,12 +653,12 @@
* <p>
* @param name The name to expand.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int expn(String name) throws IOException
@@ -671,12 +671,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int help() throws IOException
@@ -690,12 +690,12 @@
* <p>
* @param command The command name on which to request help.
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int help(String command) throws IOException
@@ -708,12 +708,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int noop() throws IOException
@@ -727,12 +727,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int turn() throws IOException
@@ -746,12 +746,12 @@
* receive the reply, and return the reply code.
* <p>
* @return The reply code received from the server.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending the
+ * @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
***/
public int quit() throws IOException
diff --git a/src/main/java/org/apache/commons/net/smtp/SMTPClient.java b/src/main/java/org/apache/commons/net/smtp/SMTPClient.java
index 6b076ad..606643f 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTPClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTPClient.java
@@ -163,12 +163,12 @@
* </pre>
* <p>
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean completePendingCommand() throws IOException
@@ -184,12 +184,12 @@
* <p>
* @param hostname The hostname with which to greet the SMTP server.
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean login(String hostname) throws IOException
@@ -204,12 +204,12 @@
* you must first login.
* <p>
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean login() throws IOException
@@ -236,12 +236,12 @@
* <p>
* @param path The reverse relay path pointing back to the sender.
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean setSender(RelayPath path) throws IOException
@@ -258,12 +258,12 @@
* <p>
* @param address The sender's email address.
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean setSender(String address) throws IOException
@@ -280,12 +280,12 @@
* <p>
* @param path The forward relay path pointing to the recipient.
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean addRecipient(RelayPath path) throws IOException
@@ -302,12 +302,12 @@
* <p>
* @param address The recipient's email address.
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean addRecipient(String address) throws IOException
@@ -348,12 +348,12 @@
* <p>
* @return A DotTerminatedMessageWriter to which the message (including
* header) can be written. Returns null if the command fails.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
* @see #sendShortMessageData(String)
***/
@@ -378,12 +378,12 @@
* @param message The short email message to send.
* This must include the headers and the body, but not the trailing "."
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean sendShortMessageData(String message) throws IOException
@@ -416,12 +416,12 @@
* @param message The short email message to send.
* This must include the headers and the body, but not the trailing "."
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean sendSimpleMessage(String sender, String recipient,
@@ -460,12 +460,12 @@
* @param message The short email message to send.
* This must include the headers and the body, but not the trailing "."
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean sendSimpleMessage(String sender, String[] recipients,
@@ -498,12 +498,12 @@
* Logout of the SMTP server by sending the QUIT command.
* <p>
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean logout() throws IOException
@@ -518,12 +518,12 @@
* sender, recipient, and mail data, cleaing all buffers and tables.
* <p>
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean reset() throws IOException
@@ -538,12 +538,12 @@
* <p>
* @param username The username or email address to validate.
* @return True if the username is valid, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean verify(String username) throws IOException
@@ -563,12 +563,12 @@
* <p>
* @return The system help string obtained from the server. null if the
* information could not be obtained.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public String listHelp() throws IOException
@@ -587,12 +587,12 @@
* @param command The command on which to ask for help.
* @return The command help string obtained from the server. null if the
* information could not be obtained.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public String listHelp(String command) throws IOException
@@ -609,12 +609,12 @@
* server timeouts.
* <p>
* @return True if successfully completed, false if not.
- * @exception SMTPConnectionClosedException
+ * @throws SMTPConnectionClosedException
* If the SMTP server prematurely closes the connection as a result
* of the client being idle or some other reason causing the server
* to send SMTP reply code 421. This exception may be caught either
* as an IOException or independently as itself.
- * @exception IOException If an I/O error occurs while either sending a
+ * @throws IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
***/
public boolean sendNoOp() throws IOException
diff --git a/src/main/java/org/apache/commons/net/telnet/TelnetClient.java b/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
index d53067c..3ad8d06 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
@@ -86,7 +86,7 @@
/***
* Handles special connection requirements.
*
- * @exception IOException If an error occurs during connection setup.
+ * @throws IOException If an error occurs during connection setup.
***/
@Override
protected void _connectAction_() throws IOException
diff --git a/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java b/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
index 082bbea..c6dbcbf 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetInputStream.java
@@ -482,7 +482,7 @@
* @param buffer The byte array in which to store the data.
* @return The number of bytes read. Returns -1 if the
* end of the message has been reached.
- * @exception IOException If an error occurs in reading the underlying
+ * @throws IOException If an error occurs in reading the underlying
* stream.
***/
@Override
@@ -503,7 +503,7 @@
* @param length The number of bytes to read.
* @return The number of bytes read. Returns -1 if the
* end of the stream has been reached.
- * @exception IOException If an error occurs while reading the underlying
+ * @throws IOException If an error occurs while reading the underlying
* stream.
***/
@Override
diff --git a/src/main/java/org/apache/commons/net/telnet/TelnetOutputStream.java b/src/main/java/org/apache/commons/net/telnet/TelnetOutputStream.java
index 2f99f3e..19f4f13 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetOutputStream.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetOutputStream.java
@@ -49,7 +49,7 @@
* Writes a byte to the stream.
* <p>
* @param ch The byte to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
@@ -118,7 +118,7 @@
* Writes a byte array to the stream.
* <p>
* @param buffer The byte array to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
@@ -135,7 +135,7 @@
* @param buffer The byte array to write.
* @param offset The offset into the array at which to start copying data.
* @param length The number of bytes to write.
- * @exception IOException If an error occurs while writing to the underlying
+ * @throws IOException If an error occurs while writing to the underlying
* stream.
***/
@Override
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTP.java b/src/main/java/org/apache/commons/net/tftp/TFTP.java
index f13d44b..c08e1a4 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTP.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTP.java
@@ -136,7 +136,7 @@
* may be in the local socket buffer. This method need only be called
* when you implement your own TFTP client or server.
*
- * @exception IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs.
***/
public final void discardPackets() throws IOException
{
@@ -183,16 +183,16 @@
* will be overwritten by the the call.
*
* @return The TFTPPacket received.
- * @exception InterruptedIOException If a socket timeout occurs. The
+ * @throws InterruptedIOException If a socket timeout occurs. The
* Java documentation claims an InterruptedIOException is thrown
* on a DatagramSocket timeout, but in practice we find a
* SocketException is thrown. You should catch both to be safe.
- * @exception SocketException If a socket timeout occurs. The
+ * @throws SocketException If a socket timeout occurs. The
* Java documentation claims an InterruptedIOException is thrown
* on a DatagramSocket timeout, but in practice we find a
* SocketException is thrown. You should catch both to be safe.
- * @exception IOException If some other I/O error occurs.
- * @exception TFTPPacketException If an invalid TFTP packet is received.
+ * @throws IOException If some other I/O error occurs.
+ * @throws TFTPPacketException If an invalid TFTP packet is received.
***/
public final TFTPPacket bufferedReceive() throws IOException,
InterruptedIOException, SocketException, TFTPPacketException
@@ -220,7 +220,7 @@
* will be overwritten by the the call.
*
* @param packet The TFTP packet to send.
- * @exception IOException If some I/O error occurs.
+ * @throws IOException If some I/O error occurs.
***/
public final void bufferedSend(TFTPPacket packet) throws IOException
{
@@ -262,7 +262,7 @@
* Sends a TFTP packet to its destination.
*
* @param packet The TFTP packet to send.
- * @exception IOException If some I/O error occurs.
+ * @throws IOException If some I/O error occurs.
***/
public final void send(TFTPPacket packet) throws IOException
{
@@ -274,16 +274,16 @@
* Receives a TFTPPacket.
*
* @return The TFTPPacket received.
- * @exception InterruptedIOException If a socket timeout occurs. The
+ * @throws InterruptedIOException If a socket timeout occurs. The
* Java documentation claims an InterruptedIOException is thrown
* on a DatagramSocket timeout, but in practice we find a
* SocketException is thrown. You should catch both to be safe.
- * @exception SocketException If a socket timeout occurs. The
+ * @throws SocketException If a socket timeout occurs. The
* Java documentation claims an InterruptedIOException is thrown
* on a DatagramSocket timeout, but in practice we find a
* SocketException is thrown. You should catch both to be safe.
- * @exception IOException If some other I/O error occurs.
- * @exception TFTPPacketException If an invalid TFTP packet is received.
+ * @throws IOException If some other I/O error occurs.
+ * @throws TFTPPacketException If an invalid TFTP packet is received.
***/
public final TFTPPacket receive() throws IOException, InterruptedIOException,
SocketException, TFTPPacketException
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTPClient.java b/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
index c6b57e0..ef4f1b7 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
@@ -120,7 +120,7 @@
* @param host The remote host serving the file.
* @param port The port number of the remote TFTP server.
* @return number of bytes read
- * @exception IOException If an I/O error occurs. The nature of the
+ * @throws IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
***/
public int receiveFile(String filename, int mode, OutputStream output,
@@ -302,9 +302,9 @@
* @param hostname The name of the remote host serving the file.
* @param port The port number of the remote TFTP server.
* @return number of bytes read
- * @exception IOException If an I/O error occurs. The nature of the
+ * @throws IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
- * @exception UnknownHostException If the hostname cannot be resolved.
+ * @throws UnknownHostException If the hostname cannot be resolved.
***/
public int receiveFile(String filename, int mode, OutputStream output,
String hostname, int port)
@@ -323,7 +323,7 @@
* @param output The OutputStream to which the file should be written.
* @param host The remote host serving the file.
* @return number of bytes read
- * @exception IOException If an I/O error occurs. The nature of the
+ * @throws IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
***/
public int receiveFile(String filename, int mode, OutputStream output,
@@ -341,9 +341,9 @@
* @param output The OutputStream to which the file should be written.
* @param hostname The name of the remote host serving the file.
* @return number of bytes read
- * @exception IOException If an I/O error occurs. The nature of the
+ * @throws IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
- * @exception UnknownHostException If the hostname cannot be resolved.
+ * @throws UnknownHostException If the hostname cannot be resolved.
***/
public int receiveFile(String filename, int mode, OutputStream output,
String hostname)
@@ -368,7 +368,7 @@
* @param input the input stream containing the data to be sent
* @param host The remote host receiving the file.
* @param port The port number of the remote TFTP server.
- * @exception IOException If an I/O error occurs. The nature of the
+ * @throws IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
***/
public void sendFile(String filename, int mode, InputStream input,
@@ -565,9 +565,9 @@
* @param input the input stream containing the data to be sent
* @param hostname The name of the remote host receiving the file.
* @param port The port number of the remote TFTP server.
- * @exception IOException If an I/O error occurs. The nature of the
+ * @throws IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
- * @exception UnknownHostException If the hostname cannot be resolved.
+ * @throws UnknownHostException If the hostname cannot be resolved.
***/
public void sendFile(String filename, int mode, InputStream input,
String hostname, int port)
@@ -585,9 +585,9 @@
* @param mode The TFTP mode of the transfer (one of the MODE constants).
* @param input the input stream containing the data to be sent
* @param host The name of the remote host receiving the file.
- * @exception IOException If an I/O error occurs. The nature of the
+ * @throws IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
- * @exception UnknownHostException If the hostname cannot be resolved.
+ * @throws UnknownHostException If the hostname cannot be resolved.
***/
public void sendFile(String filename, int mode, InputStream input,
InetAddress host)
@@ -604,9 +604,9 @@
* @param mode The TFTP mode of the transfer (one of the MODE constants).
* @param input the input stream containing the data to be sent
* @param hostname The name of the remote host receiving the file.
- * @exception IOException If an I/O error occurs. The nature of the
+ * @throws IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
- * @exception UnknownHostException If the hostname cannot be resolved.
+ * @throws UnknownHostException If the hostname cannot be resolved.
***/
public void sendFile(String filename, int mode, InputStream input,
String hostname)
diff --git a/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java b/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
index 7de148c..1e51253 100644
--- a/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
+++ b/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
@@ -118,7 +118,7 @@
*
* @param datagram The datagram containing a TFTP packet.
* @return The TFTPPacket object corresponding to the datagram.
- * @exception TFTPPacketException If the datagram does not contain a valid
+ * @throws TFTPPacketException If the datagram does not contain a valid
* TFTP packet.
***/
public static final TFTPPacket newTFTPPacket(DatagramPacket datagram)
diff --git a/src/main/java/org/apache/commons/net/time/TimeTCPClient.java b/src/main/java/org/apache/commons/net/time/TimeTCPClient.java
index 78fe2c5..5f82c2a 100644
--- a/src/main/java/org/apache/commons/net/time/TimeTCPClient.java
+++ b/src/main/java/org/apache/commons/net/time/TimeTCPClient.java
@@ -74,7 +74,7 @@
* before calling <code> getTime() </code> again.
*
* @return The time value retrieved from the server.
- * @exception IOException If an error occurs while fetching the time.
+ * @throws IOException If an error occurs while fetching the time.
***/
public long getTime() throws IOException
{
@@ -97,7 +97,7 @@
*
* @return A Date value containing the time retrieved from the server
* converted to the local timezone.
- * @exception IOException If an error occurs while fetching the time.
+ * @throws IOException If an error occurs while fetching the time.
***/
public Date getDate() throws IOException
{
diff --git a/src/main/java/org/apache/commons/net/time/TimeUDPClient.java b/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
index 13597be..57e4fa1 100644
--- a/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
+++ b/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
@@ -69,7 +69,7 @@
* @param host The address of the server.
* @param port The port of the service.
* @return The time value retrieved from the server.
- * @exception IOException If an error occurs while retrieving the time.
+ * @throws IOException If an error occurs while retrieving the time.
***/
public long getTime(InetAddress host, int port) throws IOException
{
@@ -111,7 +111,7 @@
* @param port The port of the service.
* @return A Date value containing the time retrieved from the server
* converted to the local timezone.
- * @exception IOException If an error occurs while fetching the time.
+ * @throws IOException If an error occurs while fetching the time.
***/
public Date getDate(InetAddress host, int port) throws IOException
{
diff --git a/src/main/java/org/apache/commons/net/whois/WhoisClient.java b/src/main/java/org/apache/commons/net/whois/WhoisClient.java
index f6e8d94..816f58b 100644
--- a/src/main/java/org/apache/commons/net/whois/WhoisClient.java
+++ b/src/main/java/org/apache/commons/net/whois/WhoisClient.java
@@ -78,7 +78,7 @@
*
* @param handle The handle to lookup.
* @return The result of the whois query.
- * @exception IOException If an I/O error occurs during the operation.
+ * @throws IOException If an I/O error occurs during the operation.
***/
public String query(String handle) throws IOException
{
@@ -97,7 +97,7 @@
* @param handle The handle to lookup.
* @return The InputStream of the network connection of the whois query.
* Can be read to obtain whois results.
- * @exception IOException If an I/O error occurs during the operation.
+ * @throws IOException If an I/O error occurs during the operation.
***/
public InputStream getInputStream(String handle) throws IOException
{
