You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/06/16 16:00:15 UTC
(commons-net) branch master updated (58c36f92 -> 89bfae71)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-net.git
from 58c36f92 Fix PMD CollapsibleIfStatements in TelnetInputStream
new bbb0a2c7 Fix PMD CollapsibleIfStatements in TerminalTypeOptionHandler
new 89bfae71 Normalize Javadoc @param formatting
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../net/examples/telnet/TelnetClientExample.java | 4 +-
.../commons/net/ftp/parser/FTPTimestampParser.java | 2 +-
.../org/apache/commons/net/ntp/NtpV3Packet.java | 10 +--
.../java/org/apache/commons/net/ntp/TimeStamp.java | 10 +--
.../commons/net/telnet/EchoOptionHandler.java | 8 +--
.../net/telnet/InvalidTelnetOptionException.java | 4 +-
.../commons/net/telnet/SimpleOptionHandler.java | 12 ++--
.../net/telnet/SuppressGAOptionHandler.java | 8 +--
.../java/org/apache/commons/net/telnet/Telnet.java | 84 +++++++++++-----------
.../apache/commons/net/telnet/TelnetClient.java | 16 ++---
.../net/telnet/TelnetNotificationHandler.java | 4 +-
.../commons/net/telnet/TelnetOptionHandler.java | 26 +++----
.../net/telnet/TerminalTypeOptionHandler.java | 35 ++++-----
.../net/telnet/WindowSizeOptionHandler.java | 16 ++---
.../commons/net/telnet/TelnetClientTest.java | 4 +-
.../commons/net/telnet/TelnetTestResponder.java | 10 +--
.../commons/net/telnet/TelnetTestSimpleServer.java | 2 +-
17 files changed, 125 insertions(+), 130 deletions(-)
(commons-net) 01/02: Fix PMD CollapsibleIfStatements in TerminalTypeOptionHandler
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-net.git
commit bbb0a2c7a53ec323edee0d6374cb5b89e8322844
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jun 16 11:44:05 2024 -0400
Fix PMD CollapsibleIfStatements in TerminalTypeOptionHandler
---
.../commons/net/telnet/TerminalTypeOptionHandler.java | 19 +++++++------------
1 file changed, 7 insertions(+), 12 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java b/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
index fc7141a2..0a621aa8 100644
--- a/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
@@ -76,19 +76,14 @@ public class TerminalTypeOptionHandler extends TelnetOptionHandler {
*/
@Override
public int[] answerSubnegotiation(final int suboptionData[], final int suboptionLength) {
- if (suboptionData != null && suboptionLength > 1 && termType != null) {
- if (suboptionData[0] == TERMINAL_TYPE && suboptionData[1] == TERMINAL_TYPE_SEND) {
- final int[] response = new int[termType.length() + 2];
-
- response[0] = TERMINAL_TYPE;
- response[1] = TERMINAL_TYPE_IS;
-
- for (int ii = 0; ii < termType.length(); ii++) {
- response[ii + 2] = termType.charAt(ii);
- }
-
- return response;
+ if (suboptionData != null && suboptionLength > 1 && termType != null && suboptionData[0] == TERMINAL_TYPE && suboptionData[1] == TERMINAL_TYPE_SEND) {
+ final int[] response = new int[termType.length() + 2];
+ response[0] = TERMINAL_TYPE;
+ response[1] = TERMINAL_TYPE_IS;
+ for (int ii = 0; ii < termType.length(); ii++) {
+ response[ii + 2] = termType.charAt(ii);
}
+ return response;
}
return null;
}
(commons-net) 02/02: Normalize Javadoc @param formatting
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-net.git
commit 89bfae7136d380c22976f49196e95261dc9586e3
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jun 16 11:49:43 2024 -0400
Normalize Javadoc @param formatting
---
.../net/examples/telnet/TelnetClientExample.java | 4 +-
.../commons/net/ftp/parser/FTPTimestampParser.java | 2 +-
.../org/apache/commons/net/ntp/NtpV3Packet.java | 10 +--
.../java/org/apache/commons/net/ntp/TimeStamp.java | 10 +--
.../commons/net/telnet/EchoOptionHandler.java | 8 +--
.../net/telnet/InvalidTelnetOptionException.java | 4 +-
.../commons/net/telnet/SimpleOptionHandler.java | 12 ++--
.../net/telnet/SuppressGAOptionHandler.java | 8 +--
.../java/org/apache/commons/net/telnet/Telnet.java | 84 +++++++++++-----------
.../apache/commons/net/telnet/TelnetClient.java | 16 ++---
.../net/telnet/TelnetNotificationHandler.java | 4 +-
.../commons/net/telnet/TelnetOptionHandler.java | 26 +++----
.../net/telnet/TerminalTypeOptionHandler.java | 16 ++---
.../net/telnet/WindowSizeOptionHandler.java | 16 ++---
.../commons/net/telnet/TelnetClientTest.java | 4 +-
.../commons/net/telnet/TelnetTestResponder.java | 10 +--
.../commons/net/telnet/TelnetTestSimpleServer.java | 2 +-
17 files changed, 118 insertions(+), 118 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/examples/telnet/TelnetClientExample.java b/src/main/java/org/apache/commons/net/examples/telnet/TelnetClientExample.java
index 1e645dd7..f160e7f9 100644
--- a/src/main/java/org/apache/commons/net/examples/telnet/TelnetClientExample.java
+++ b/src/main/java/org/apache/commons/net/examples/telnet/TelnetClientExample.java
@@ -207,8 +207,8 @@ public class TelnetClientExample implements Runnable, TelnetNotificationHandler
/**
* Callback method called when TelnetClient receives an option negotiation command.
*
- * @param negotiation_code - type of negotiation command received (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT, RECEIVED_COMMAND)
- * @param option_code - code of the option negotiated
+ * @param negotiation_code type of negotiation command received (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT, RECEIVED_COMMAND)
+ * @param option_code code of the option negotiated
*/
@Override
public void receivedNegotiation(final int negotiation_code, final int option_code) {
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
index 04f561aa..d137363d 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParser.java
@@ -39,7 +39,7 @@ public interface FTPTimestampParser {
/**
* Parses the supplied datestamp parameter. This parameter typically would have been pulled from a longer FTP listing via the regular expression mechanism
*
- * @param timestampStr - the timestamp portion of the FTP directory listing to be parsed
+ * @param timestampStr the timestamp portion of the FTP directory listing to be parsed
* @return a <code>java.util.Calendar</code> object initialized to the date parsed by the parser
* @throws ParseException if none of the parser mechanisms belonging to the implementor can parse the input.
*/
diff --git a/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java b/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
index 7bd3613e..5f8dcc39 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
@@ -238,7 +238,7 @@ public interface NtpV3Packet {
/**
* Sets leap indicator.
*
- * @param li - leap indicator code
+ * @param li leap indicator code
*/
void setLeapIndicator(int li);
@@ -252,7 +252,7 @@ public interface NtpV3Packet {
/**
* Sets originate timestamp given NTP TimeStamp object.
*
- * @param ts - timestamp
+ * @param ts timestamp
*/
void setOriginateTimeStamp(TimeStamp ts);
@@ -274,7 +274,7 @@ public interface NtpV3Packet {
/**
* Sets receive timestamp given NTP TimeStamp object.
*
- * @param ts - timestamp
+ * @param ts timestamp
*/
void setReceiveTimeStamp(TimeStamp ts);
@@ -288,7 +288,7 @@ public interface NtpV3Packet {
/**
* Sets the reference timestamp given NTP TimeStamp object.
*
- * @param ts - timestamp
+ * @param ts timestamp
*/
void setReferenceTime(TimeStamp ts);
@@ -317,7 +317,7 @@ public interface NtpV3Packet {
/**
* Sets the {@code transmit} timestamp given NTP TimeStamp object.
*
- * @param ts - timestamp
+ * @param ts timestamp
*/
void setTransmitTime(TimeStamp ts);
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
index 46275ed6..3ff31089 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
@@ -59,8 +59,8 @@ public class TimeStamp implements Serializable, Comparable<TimeStamp> {
/**
* Left-pad 8-character hexadecimal string with 0's
*
- * @param buf - StringBuilder which is appended with leading 0's.
- * @param l - a long.
+ * @param buf StringBuilder which is appended with leading 0's.
+ * @param l a long.
*/
private static void appendHexString(final StringBuilder buf, final long l) {
final String s = Long.toHexString(l);
@@ -157,7 +157,7 @@ public class TimeStamp implements Serializable, Comparable<TimeStamp> {
/**
* Parses the string argument as a NTP hexidecimal timestamp representation string (e.g. "c1a089bd.fc904f6d").
*
- * @param s - hexstring.
+ * @param s hexstring.
* @return the Timestamp represented by the argument in hexidecimal.
* @throws NumberFormatException - if the string does not contain a parsable timestamp.
*/
@@ -224,7 +224,7 @@ public class TimeStamp implements Serializable, Comparable<TimeStamp> {
/**
* Constructs a newly allocated NTP timestamp object that represents the Java Date argument.
*
- * @param d - the Date to be represented by the Timestamp object.
+ * @param d the Date to be represented by the Timestamp object.
*/
public TimeStamp(final Date d) {
ntpTime = d == null ? 0 : toNtpTime(d.getTime());
@@ -253,7 +253,7 @@ public class TimeStamp implements Serializable, Comparable<TimeStamp> {
/**
* Compares two Timestamps numerically.
*
- * @param anotherTimeStamp - the <code>TimeStamp</code> to be compared.
+ * @param anotherTimeStamp the <code>TimeStamp</code> to be compared.
* @return the value <code>0</code> if the argument TimeStamp is equal to this TimeStamp; a value less than <code>0</code> if this TimeStamp is numerically
* less than the TimeStamp argument; and a value greater than <code>0</code> if this TimeStamp is numerically greater than the TimeStamp argument
* (signed comparison).
diff --git a/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java b/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java
index b17331bc..5364cb41 100644
--- a/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java
@@ -32,10 +32,10 @@ public class EchoOptionHandler extends TelnetOptionHandler {
* Constructor for the EchoOptionHandler. Allows defining desired initial setting for local/remote activation of this option and behavior in case a
* local/remote activation request for this option is received.
*
- * @param initlocal - if set to true, a WILL is sent upon connection.
- * @param initremote - if set to true, a DO is sent upon connection.
- * @param acceptlocal - if set to true, any DO request is accepted.
- * @param acceptremote - if set to true, any WILL request is accepted.
+ * @param initlocal if set to true, a WILL is sent upon connection.
+ * @param initremote if set to true, a DO is sent upon connection.
+ * @param acceptlocal if set to true, any DO request is accepted.
+ * @param acceptremote if set to true, any WILL request is accepted.
*/
public EchoOptionHandler(final boolean initlocal, final boolean initremote, final boolean acceptlocal, final boolean acceptremote) {
super(TelnetOption.ECHO, initlocal, initremote, acceptlocal, acceptremote);
diff --git a/src/main/java/org/apache/commons/net/telnet/InvalidTelnetOptionException.java b/src/main/java/org/apache/commons/net/telnet/InvalidTelnetOptionException.java
index 1f821d0a..c27b1258 100644
--- a/src/main/java/org/apache/commons/net/telnet/InvalidTelnetOptionException.java
+++ b/src/main/java/org/apache/commons/net/telnet/InvalidTelnetOptionException.java
@@ -38,8 +38,8 @@ public class InvalidTelnetOptionException extends Exception {
/**
* Constructor for the exception.
*
- * @param message - Error message.
- * @param optcode - Option code.
+ * @param message Error message.
+ * @param optcode Option code.
*/
public InvalidTelnetOptionException(final String message, final int optcode) {
optionCode = optcode;
diff --git a/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java b/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java
index d746cccc..f69c099e 100644
--- a/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java
@@ -24,7 +24,7 @@ public class SimpleOptionHandler extends TelnetOptionHandler {
/**
* Constructor for the SimpleOptionHandler. Initial and accept behavior flags are set to false
*
- * @param optcode - option code.
+ * @param optcode option code.
*/
public SimpleOptionHandler(final int optcode) {
super(optcode, false, false, false, false);
@@ -34,11 +34,11 @@ public class SimpleOptionHandler extends TelnetOptionHandler {
* Constructor for the SimpleOptionHandler. Allows defining desired initial setting for local/remote activation of this option and behavior in case a
* local/remote activation request for this option is received.
*
- * @param optcode - option code.
- * @param initlocal - if set to true, a WILL is sent upon connection.
- * @param initremote - if set to true, a DO is sent upon connection.
- * @param acceptlocal - if set to true, any DO request is accepted.
- * @param acceptremote - if set to true, any WILL request is accepted.
+ * @param optcode option code.
+ * @param initlocal if set to true, a WILL is sent upon connection.
+ * @param initremote if set to true, a DO is sent upon connection.
+ * @param acceptlocal if set to true, any DO request is accepted.
+ * @param acceptremote if set to true, any WILL request is accepted.
*/
public SimpleOptionHandler(final int optcode, final boolean initlocal, final boolean initremote, final boolean acceptlocal, final boolean acceptremote) {
super(optcode, initlocal, initremote, acceptlocal, acceptremote);
diff --git a/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java b/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java
index 35322fee..7e20fc42 100644
--- a/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java
@@ -32,10 +32,10 @@ public class SuppressGAOptionHandler extends TelnetOptionHandler {
* Constructor for the SuppressGAOptionHandler. Allows defining desired initial setting for local/remote activation of this option and behavior in case a
* local/remote activation request for this option is received.
*
- * @param initlocal - if set to true, a WILL is sent upon connection.
- * @param initremote - if set to true, a DO is sent upon connection.
- * @param acceptlocal - if set to true, any DO request is accepted.
- * @param acceptremote - if set to true, any WILL request is accepted.
+ * @param initlocal if set to true, a WILL is sent upon connection.
+ * @param initremote if set to true, a DO is sent upon connection.
+ * @param acceptlocal if set to true, any DO request is accepted.
+ * @param acceptremote if set to true, any WILL request is accepted.
*/
public SuppressGAOptionHandler(final boolean initlocal, final boolean initremote, final boolean acceptlocal, final boolean acceptremote) {
super(TelnetOption.SUPPRESS_GO_AHEAD, initlocal, initremote, acceptlocal, acceptremote);
diff --git a/src/main/java/org/apache/commons/net/telnet/Telnet.java b/src/main/java/org/apache/commons/net/telnet/Telnet.java
index f21c2e88..5041cb94 100644
--- a/src/main/java/org/apache/commons/net/telnet/Telnet.java
+++ b/src/main/java/org/apache/commons/net/telnet/Telnet.java
@@ -132,7 +132,7 @@ class Telnet extends SocketClient {
/**
* This constructor lets you specify the terminal type.
*
- * @param termtype - terminal type to be negotiated (ej. VT100)
+ * @param termtype terminal type to be negotiated (ej. VT100)
*/
Telnet(final String termtype) {
setDefaultPort(DEFAULT_PORT);
@@ -186,7 +186,7 @@ class Telnet extends SocketClient {
/**
* Registers an OutputStream for spying what's going on in the Telnet session.
*
- * @param spystream - OutputStream on which session activity will be echoed.
+ * @param spystream OutputStream on which session activity will be echoed.
*/
void _registerSpyStream(final OutputStream spystream) {
spyStream = spystream;
@@ -196,7 +196,7 @@ class Telnet extends SocketClient {
/**
* Sends an {@code Are You There (AYT)} sequence and waits for the result.
*
- * @param timeout - Time to wait for a response.
+ * @param timeout Time to wait for a response.
* @throws IOException - Exception in I/O.
* @throws IllegalArgumentException - Illegal argument
* @throws InterruptedException - Interrupted during wait.
@@ -225,7 +225,7 @@ class Telnet extends SocketClient {
/**
* Sends a command, automatically adds IAC prefix and flushes the output.
*
- * @param cmd - command data to be sent
+ * @param cmd command data to be sent
* @throws IOException - Exception in I/O.
* @since 3.0
*/
@@ -239,7 +239,7 @@ class Telnet extends SocketClient {
/**
* Manages subnegotiation for Terminal Type.
*
- * @param subn - subnegotiation data to be sent
+ * @param subn subnegotiation data to be sent
* @throws IOException - Exception in I/O.
**/
final synchronized void _sendSubnegotiation(final int[] subn) throws IOException {
@@ -278,7 +278,7 @@ class Telnet extends SocketClient {
/**
* Registers a new TelnetOptionHandler for this telnet to use.
*
- * @param opthand - option handler to be registered.
+ * @param opthand option handler to be registered.
* @throws InvalidTelnetOptionException - The option code is invalid.
* @throws IOException on error
**/
@@ -305,7 +305,7 @@ class Telnet extends SocketClient {
/**
* Unregisters a TelnetOptionHandler.
*
- * @param optcode - Code of the option to be unregistered.
+ * @param optcode Code of the option to be unregistered.
* @throws InvalidTelnetOptionException - The option code is invalid.
* @throws IOException on error
**/
@@ -346,7 +346,7 @@ class Telnet extends SocketClient {
/**
* Processes a COMMAND.
*
- * @param command - option code to be set.
+ * @param command option code to be set.
**/
void processCommand(final int command) {
if (debugoptions) {
@@ -361,7 +361,7 @@ class Telnet extends SocketClient {
/**
* Processes a {@code DO} request.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
* @throws IOException - Exception in I/O.
**/
void processDo(final int option) throws IOException {
@@ -427,7 +427,7 @@ class Telnet extends SocketClient {
/**
* Processes a {@code DONT} request.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
* @throws IOException - Exception in I/O.
**/
void processDont(final int option) throws IOException {
@@ -469,8 +469,8 @@ class Telnet extends SocketClient {
/**
* Processes a suboption negotiation.
*
- * @param suboption - subnegotiation data received
- * @param suboptionLength - length of data received
+ * @param suboption subnegotiation data received
+ * @param suboptionLength length of data received
* @throws IOException - Exception in I/O.
**/
void processSuboption(final int[] suboption, final int suboptionLength) throws IOException {
@@ -500,7 +500,7 @@ class Telnet extends SocketClient {
/**
* Processes a {@code WILL} request.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
* @throws IOException - Exception in I/O.
**/
void processWill(final int option) throws IOException {
@@ -551,7 +551,7 @@ class Telnet extends SocketClient {
/**
* Processes a {@code WONT} request.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
* @throws IOException - Exception in I/O.
**/
void processWont(final int option) throws IOException {
@@ -594,7 +594,7 @@ class Telnet extends SocketClient {
/**
* Registers a notification handler to which will be sent notifications of received telnet option negotiation commands.
*
- * @param notifhand - TelnetNotificationHandler to be registered
+ * @param notifhand TelnetNotificationHandler to be registered
*/
public void registerNotifHandler(final TelnetNotificationHandler notifhand) {
this.notifhand = notifhand;
@@ -603,7 +603,7 @@ class Telnet extends SocketClient {
/**
* Requests a DO.
*
- * @param option - Option code.
+ * @param option Option code.
* @throws IOException - Exception in I/O.
**/
final synchronized void requestDo(final int option) throws IOException {
@@ -618,7 +618,7 @@ class Telnet extends SocketClient {
/**
* Requests a {@code DONT}.
*
- * @param option - Option code.
+ * @param option Option code.
* @throws IOException - Exception in I/O.
**/
final synchronized void requestDont(final int option) throws IOException {
@@ -635,7 +635,7 @@ class Telnet extends SocketClient {
*
* @return returns true if a {@code DO} has been requested.
*
- * @param option - option code to be looked up.
+ * @param option option code to be looked up.
*/
boolean requestedDo(final int option) {
return (options[option] & REQUESTED_DO_MASK) != 0;
@@ -646,7 +646,7 @@ class Telnet extends SocketClient {
*
* @return returns true if a {@code DONT} has been requested
*
- * @param option - option code to be looked up.
+ * @param option option code to be looked up.
*/
boolean requestedDont(final int option) {
return !requestedDo(option);
@@ -657,7 +657,7 @@ class Telnet extends SocketClient {
*
* @return returns true if a {@code WILL} has been requested
*
- * @param option - option code to be looked up.
+ * @param option option code to be looked up.
*/
boolean requestedWill(final int option) {
return (options[option] & REQUESTED_WILL_MASK) != 0;
@@ -668,7 +668,7 @@ class Telnet extends SocketClient {
*
* @return returns true if a {@code WONT} has been requested
*
- * @param option - option code to be looked up.
+ * @param option option code to be looked up.
*/
boolean requestedWont(final int option) {
return !requestedWill(option);
@@ -677,7 +677,7 @@ class Telnet extends SocketClient {
/**
* Requests a {@code WILL}.
*
- * @param option - Option code.
+ * @param option Option code.
* @throws IOException - Exception in I/O.
**/
final synchronized void requestWill(final int option) throws IOException {
@@ -694,7 +694,7 @@ class Telnet extends SocketClient {
/**
* Requests a {@code WONT}.
*
- * @param option - Option code.
+ * @param option Option code.
* @throws IOException - Exception in I/O.
**/
final synchronized void requestWont(final int option) throws IOException {
@@ -709,7 +709,7 @@ class Telnet extends SocketClient {
/**
* Sends a byte.
*
- * @param b - byte to send
+ * @param b byte to send
* @throws IOException - Exception in I/O.
**/
final synchronized void sendByte(final int b) throws IOException {
@@ -724,7 +724,7 @@ class Telnet extends SocketClient {
/**
* Sends a {@code DO}.
*
- * @param option - Option code.
+ * @param option Option code.
* @throws IOException - Exception in I/O.
**/
final synchronized void sendDo(final int option) throws IOException {
@@ -742,7 +742,7 @@ class Telnet extends SocketClient {
/**
* Sends a {@code DONT}.
*
- * @param option - Option code.
+ * @param option Option code.
* @throws IOException - Exception in I/O.
**/
final synchronized void sendDont(final int option) throws IOException {
@@ -778,7 +778,7 @@ class Telnet extends SocketClient {
/**
* Sends a {@code WILL}.
*
- * @param option - Option code.
+ * @param option Option code.
* @throws IOException - Exception in I/O.
**/
final synchronized void sendWill(final int option) throws IOException {
@@ -796,7 +796,7 @@ class Telnet extends SocketClient {
/**
* Sends a {@code WONT}.
*
- * @param option - Option code.
+ * @param option Option code.
* @throws IOException - Exception in I/O.
**/
final synchronized void sendWont(final int option) throws IOException {
@@ -814,7 +814,7 @@ class Telnet extends SocketClient {
/**
* Sets the state of the option.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
* @throws IOException
*/
void setDo(final int option) throws IOException {
@@ -836,7 +836,7 @@ class Telnet extends SocketClient {
/**
* Sets the state of the option.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
*/
void setDont(final int option) {
options[option] &= ~DO_MASK;
@@ -851,7 +851,7 @@ class Telnet extends SocketClient {
/**
* Sets the state of the option.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
*/
void setWantDo(final int option) {
options[option] |= REQUESTED_DO_MASK;
@@ -860,7 +860,7 @@ class Telnet extends SocketClient {
/**
* Sets the state of the option.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
*/
void setWantDont(final int option) {
options[option] &= ~REQUESTED_DO_MASK;
@@ -869,7 +869,7 @@ class Telnet extends SocketClient {
/**
* Sets the state of the option.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
*/
void setWantWill(final int option) {
options[option] |= REQUESTED_WILL_MASK;
@@ -878,7 +878,7 @@ class Telnet extends SocketClient {
/**
* Sets the state of the option.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
*/
void setWantWont(final int option) {
options[option] &= ~REQUESTED_WILL_MASK;
@@ -887,7 +887,7 @@ class Telnet extends SocketClient {
/**
* Sets the state of the option.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
* @throws IOException
*/
void setWill(final int option) throws IOException {
@@ -911,7 +911,7 @@ class Telnet extends SocketClient {
/**
* Sets the state of the option.
*
- * @param option - option code to be set.
+ * @param option option code to be set.
*/
void setWont(final int option) {
options[option] &= ~WILL_MASK;
@@ -926,7 +926,7 @@ class Telnet extends SocketClient {
/**
* Sends a read char on the spy stream.
*
- * @param ch - character read from the session
+ * @param ch character read from the session
*/
void spyRead(final int ch) {
final OutputStream spy = spyStream;
@@ -949,7 +949,7 @@ class Telnet extends SocketClient {
/**
* Sends a written char on the spy stream.
*
- * @param ch - character written to the session
+ * @param ch character written to the session
*/
void spyWrite(final int ch) {
if (!(stateIsDo(TelnetOption.ECHO) && requestedDo(TelnetOption.ECHO))) {
@@ -971,7 +971,7 @@ class Telnet extends SocketClient {
*
* @return returns true if a {@code DO} has been acknowledged.
*
- * @param option - option code to be looked up.
+ * @param option option code to be looked up.
*/
boolean stateIsDo(final int option) {
return (options[option] & DO_MASK) != 0;
@@ -982,7 +982,7 @@ class Telnet extends SocketClient {
*
* @return returns true if a {@code DONT} has been acknowledged
*
- * @param option - option code to be looked up.
+ * @param option option code to be looked up.
*/
boolean stateIsDont(final int option) {
return !stateIsDo(option);
@@ -993,7 +993,7 @@ class Telnet extends SocketClient {
*
* @return returns true if a {@code WILL} has been acknowledged
*
- * @param option - option code to be looked up.
+ * @param option option code to be looked up.
*/
boolean stateIsWill(final int option) {
return (options[option] & WILL_MASK) != 0;
@@ -1004,7 +1004,7 @@ class Telnet extends SocketClient {
*
* @return returns true if a {@code WONT} has been acknowledged
*
- * @param option - option code to be looked up.
+ * @param option option code to be looked up.
*/
boolean stateIsWont(final int option) {
return !stateIsWill(option);
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 100556fb..e432d48c 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
@@ -107,7 +107,7 @@ public class TelnetClient extends Telnet {
/**
* Registers a new TelnetOptionHandler for this telnet client to use.
*
- * @param opthand - option handler to be registered.
+ * @param opthand option handler to be registered.
*
* @throws InvalidTelnetOptionException on error
* @throws IOException on error
@@ -132,7 +132,7 @@ public class TelnetClient extends Telnet {
/**
* Unregisters a TelnetOptionHandler.
*
- * @param optcode - Code of the option to be unregistered.
+ * @param optcode Code of the option to be unregistered.
*
* @throws InvalidTelnetOptionException on error
* @throws IOException on error
@@ -182,7 +182,7 @@ public class TelnetClient extends Telnet {
/**
* Returns the state of the option on the local side.
*
- * @param option - Option to be checked.
+ * @param option Option to be checked.
*
* @return The state of the option on the local side.
*/
@@ -216,7 +216,7 @@ public class TelnetClient extends Telnet {
/**
* Returns the state of the option on the remote side.
*
- * @param option - Option to be checked.
+ * @param option Option to be checked.
*
* @return The state of the option on the remote side.
*/
@@ -264,7 +264,7 @@ public class TelnetClient extends Telnet {
/**
* Registers a notification handler to which will be sent notifications of received telnet option negotiation commands.
*
- * @param notifhand - TelnetNotificationHandler to be registered
+ * @param notifhand TelnetNotificationHandler to be registered
*/
@Override
public void registerNotifHandler(final TelnetNotificationHandler notifhand) {
@@ -275,7 +275,7 @@ public class TelnetClient extends Telnet {
/**
* Registers an OutputStream for spying what's going on in the TelnetClient session.
*
- * @param spystream - OutputStream on which session activity will be echoed.
+ * @param spystream OutputStream on which session activity will be echoed.
*/
public void registerSpyStream(final OutputStream spystream) {
super._registerSpyStream(spystream);
@@ -284,7 +284,7 @@ public class TelnetClient extends Telnet {
/**
* Sends an {@code Are You There (AYT)} sequence and waits for the result.
*
- * @param timeout - Time to wait for a response.
+ * @param timeout Time to wait for a response.
*
* @return true if AYT received a response, false otherwise.
*
@@ -300,7 +300,7 @@ public class TelnetClient extends Telnet {
/**
* Sends an {@code Are You There (AYT)} sequence and waits for the result.
*
- * @param timeout - Time to wait for a response (millis.)
+ * @param timeout Time to wait for a response (millis.)
*
* @return true if AYT received a response, false otherwise
*
diff --git a/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java b/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
index 2506a452..6827b823 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
@@ -55,9 +55,9 @@ public interface TelnetNotificationHandler {
/**
* Callback method called when TelnetClient receives a command or option negotiation command
*
- * @param negotiation_code - type of (negotiation) command received (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT, RECEIVED_COMMAND)
+ * @param negotiation_code type of (negotiation) command received (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT, RECEIVED_COMMAND)
*
- * @param option_code - code of the option negotiated, or the command code itself (e.g. NOP).
+ * @param option_code code of the option negotiated, or the command code itself (e.g. NOP).
*/
void receivedNegotiation(int negotiation_code, int option_code);
}
diff --git a/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java b/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java
index 3648847e..13cb0227 100644
--- a/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java
@@ -63,11 +63,11 @@ public abstract class TelnetOptionHandler {
* Constructor for the TelnetOptionHandler. Allows defining desired initial setting for local/remote activation of this option and behavior in case a
* local/remote activation request for this option is received.
*
- * @param optcode - Option code.
- * @param initlocal - if set to true, a {@code WILL} is sent upon connection.
- * @param initremote - if set to true, a {@code DO} is sent upon connection.
- * @param acceptlocal - if set to true, any {@code DO} request is accepted.
- * @param acceptremote - if set to true, any {@code WILL} request is accepted.
+ * @param optcode Option code.
+ * @param initlocal if set to true, a {@code WILL} is sent upon connection.
+ * @param initremote if set to true, a {@code DO} is sent upon connection.
+ * @param acceptlocal if set to true, any {@code DO} request is accepted.
+ * @param acceptremote if set to true, any {@code WILL} request is accepted.
*/
public TelnetOptionHandler(final int optcode, final boolean initlocal, final boolean initremote, final boolean acceptlocal, final boolean acceptremote) {
optionCode = optcode;
@@ -84,8 +84,8 @@ public abstract class TelnetOptionHandler {
* request.
* </p>
*
- * @param suboptionData - the sequence received, without IAC SB & IAC SE
- * @param suboptionLength - the length of data in suboption_data
+ * @param suboptionData the sequence received, without IAC SB & IAC SE
+ * @param suboptionLength the length of data in suboption_data
* @return response to be sent to the subnegotiation sequence. TelnetClient will add IAC SB & IAC SE. null means no response
*/
public int[] answerSubnegotiation(final int suboptionData[], final int suboptionLength) {
@@ -158,7 +158,7 @@ public abstract class TelnetOptionHandler {
/**
* Sets behavior of the option for DO requests coming from the other end.
*
- * @param accept - if true, subsequent DO requests will be accepted.
+ * @param accept if true, subsequent DO requests will be accepted.
*/
public void setAcceptLocal(final boolean accept) {
acceptLocal = accept;
@@ -167,7 +167,7 @@ public abstract class TelnetOptionHandler {
/**
* Sets behavior of the option for {@code WILL} requests coming from the other end.
*
- * @param accept - if true, subsequent {@code WILL} requests will be accepted.
+ * @param accept if true, subsequent {@code WILL} requests will be accepted.
*/
public void setAcceptRemote(final boolean accept) {
acceptRemote = accept;
@@ -176,7 +176,7 @@ public abstract class TelnetOptionHandler {
/**
* Sets this option whether a {@code DO} request sent to the other side has been acknowledged (invoked by TelnetClient).
*
- * @param state - if true, a {@code DO} request has been acknowledged.
+ * @param state if true, a {@code DO} request has been acknowledged.
*/
void setDo(final boolean state) {
doFlag = state;
@@ -185,7 +185,7 @@ public abstract class TelnetOptionHandler {
/**
* Sets this option whether to send a {@code WILL} request upon connection.
*
- * @param init - if true, a {@code WILL} request will be sent upon subsequent connections.
+ * @param init if true, a {@code WILL} request will be sent upon subsequent connections.
*/
public void setInitLocal(final boolean init) {
initialLocal = init;
@@ -194,7 +194,7 @@ public abstract class TelnetOptionHandler {
/**
* Sets this option whether to send a {@code DO} request upon connection.
*
- * @param init - if true, a {@code DO} request will be sent upon subsequent connections.
+ * @param init if true, a {@code DO} request will be sent upon subsequent connections.
*/
public void setInitRemote(final boolean init) {
initialRemote = init;
@@ -203,7 +203,7 @@ public abstract class TelnetOptionHandler {
/**
* Sets this option whether a {@code WILL} request sent to the other side has been acknowledged (invoked by TelnetClient).
*
- * @param state - if true, a {@code WILL} request has been acknowledged.
+ * @param state if true, a {@code WILL} request has been acknowledged.
*/
void setWill(final boolean state) {
willFlag = state;
diff --git a/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java b/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
index 0a621aa8..88eccfb9 100644
--- a/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
@@ -44,7 +44,7 @@ public class TerminalTypeOptionHandler extends TelnetOptionHandler {
/**
* Constructor for the TerminalTypeOptionHandler. Initial and accept behavior flags are set to false
*
- * @param termtype - terminal type that will be negotiated.
+ * @param termtype terminal type that will be negotiated.
*/
public TerminalTypeOptionHandler(final String termtype) {
super(TelnetOption.TERMINAL_TYPE, false, false, false, false);
@@ -55,11 +55,11 @@ public class TerminalTypeOptionHandler extends TelnetOptionHandler {
* Constructor for the TerminalTypeOptionHandler. Allows defining desired initial setting for local/remote activation of this option and behavior in case a
* local/remote activation request for this option is received.
*
- * @param termtype - terminal type that will be negotiated.
- * @param initlocal - if set to true, a {@code WILL} is sent upon connection.
- * @param initremote - if set to true, a {@code DO} is sent upon connection.
- * @param acceptlocal - if set to true, any {@code DO} request is accepted.
- * @param acceptremote - if set to true, any {@code WILL} request is accepted.
+ * @param termtype terminal type that will be negotiated.
+ * @param initlocal if set to true, a {@code WILL} is sent upon connection.
+ * @param initremote if set to true, a {@code DO} is sent upon connection.
+ * @param acceptlocal if set to true, any {@code DO} request is accepted.
+ * @param acceptremote if set to true, any {@code WILL} request is accepted.
*/
public TerminalTypeOptionHandler(final String termtype, final boolean initlocal, final boolean initremote, final boolean acceptlocal,
final boolean acceptremote) {
@@ -70,8 +70,8 @@ public class TerminalTypeOptionHandler extends TelnetOptionHandler {
/**
* Implements the abstract method of TelnetOptionHandler.
*
- * @param suboptionData - the sequence received, without IAC SB & IAC SE
- * @param suboptionLength - the length of data in suboption_data
+ * @param suboptionData the sequence received, without IAC SB & IAC SE
+ * @param suboptionLength the length of data in suboption_data
* @return terminal type information
*/
@Override
diff --git a/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java b/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java
index 01fee31a..c4f80ae4 100644
--- a/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java
+++ b/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java
@@ -41,8 +41,8 @@ public class WindowSizeOptionHandler extends TelnetOptionHandler {
/**
* Constructor for the WindowSizeOptionHandler. Initial and accept behavior flags are set to false
*
- * @param nWidth - Window width.
- * @param nHeight - Window Height
+ * @param nWidth Window width.
+ * @param nHeight Window Height
*/
public WindowSizeOptionHandler(final int nWidth, final int nHeight) {
super(TelnetOption.WINDOW_SIZE, false, false, false, false);
@@ -55,12 +55,12 @@ public class WindowSizeOptionHandler extends TelnetOptionHandler {
* Constructor for the WindowSizeOptionHandler. Allows defining desired initial setting for local/remote activation of this option and behavior in case a
* local/remote activation request for this option is received.
*
- * @param nWidth - Window width.
- * @param nHeight - Window Height
- * @param initlocal - if set to true, a {@code WILL} is sent upon connection.
- * @param initremote - if set to true, a {@code DO} is sent upon connection.
- * @param acceptlocal - if set to true, any {@code DO} request is accepted.
- * @param acceptremote - if set to true, any {@code WILL} request is accepted.
+ * @param nWidth Window width.
+ * @param nHeight Window Height
+ * @param initlocal if set to true, a {@code WILL} is sent upon connection.
+ * @param initremote if set to true, a {@code DO} is sent upon connection.
+ * @param acceptlocal if set to true, any {@code DO} request is accepted.
+ * @param acceptremote if set to true, any {@code WILL} request is accepted.
*/
public WindowSizeOptionHandler(final int nWidth, final int nHeight, final boolean initlocal, final boolean initremote, final boolean acceptlocal,
final boolean acceptremote) {
diff --git a/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java b/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java
index 40c73704..cce975e2 100644
--- a/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java
+++ b/src/test/java/org/apache/commons/net/telnet/TelnetClientTest.java
@@ -102,9 +102,9 @@ public class TelnetClientTest extends TestCase implements TelnetNotificationHand
/*
* Callback method called when TelnetClient receives an option negotiation command. <p>
*
- * @param negotiation_code - type of negotiation command received (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT) <p>
+ * @param negotiation_code type of negotiation command received (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT) <p>
*
- * @param option_code - code of the option negotiated <p>
+ * @param option_code code of the option negotiated <p>
*/
@Override
public void receivedNegotiation(final int negotiation_code, final int option_code) {
diff --git a/src/test/java/org/apache/commons/net/telnet/TelnetTestResponder.java b/src/test/java/org/apache/commons/net/telnet/TelnetTestResponder.java
index 6cb605f1..d93a12a4 100644
--- a/src/test/java/org/apache/commons/net/telnet/TelnetTestResponder.java
+++ b/src/test/java/org/apache/commons/net/telnet/TelnetTestResponder.java
@@ -33,11 +33,11 @@ public class TelnetTestResponder implements Runnable {
* Constructs a new instance. Starts a new thread for the reader.
* <p>
*
- * @param is - InputStream on which to read.
- * @param os - OutputStream on which to answer.
- * @param inputs - Array of waited for Strings.
- * @param outputs - Array of answers.
- * @param timeout - milliseconds
+ * @param is InputStream on which to read.
+ * @param os OutputStream on which to answer.
+ * @param inputs Array of waited for Strings.
+ * @param outputs Array of answers.
+ * @param timeout milliseconds
*/
public TelnetTestResponder(final InputStream is, final OutputStream os, final String inputs[], final String outputs[], final long timeout) {
_is = is;
diff --git a/src/test/java/org/apache/commons/net/telnet/TelnetTestSimpleServer.java b/src/test/java/org/apache/commons/net/telnet/TelnetTestSimpleServer.java
index 1503add3..126c9393 100644
--- a/src/test/java/org/apache/commons/net/telnet/TelnetTestSimpleServer.java
+++ b/src/test/java/org/apache/commons/net/telnet/TelnetTestSimpleServer.java
@@ -33,7 +33,7 @@ public class TelnetTestSimpleServer implements Runnable {
/*
* test of client-driven subnegotiation. <p>
*
- * @param port - server port on which to listen.
+ * @param port server port on which to listen.
*
* @throws IOException on error
*/