A series of small fixes that Improve Documentation and Code Quality (SonarQube recommendations) (#424)

* Fixing Javadoc Errors
* SonarQube Fix: Performance - Method invokes inefficient Number constructor; use static valueOf instead
* SonarQube: Security - Array is stored directly
* Fixing null pointer issues with new clone method

Signed-off-by: James Sutton <james.sutton@uk.ibm.com>

Author: jpwsutton

org.eclipse.paho.client.mqttv3/src/main/java-templates/org/eclipse/paho/client/mqttv3/internal/ClientComms.java

@@ -203,12 +203,11 @@ public void sendNoWait(MqttWireMessage message, MqttToken token) throws MqttExce
 
 	/**
 	 * Removes the message corresponding to the token from the outbound queue and persistence.
-	 * @param token The {@link IMqttDeliveryMqttToken} to remove
+	 * @param token The {@link IMqttDeliveryToken} to remove
 	 * @return if the message is removed, then true, otherwise false
 	 * @throws MqttException if an error occurs sending the message
 	 */
 	public boolean removeMessage(IMqttDeliveryToken token) throws MqttException {
-		final String methodName = "removeMessage";
 		return this.clientState.removeMessage(token);
 	}
 
@@ -217,6 +216,7 @@ public boolean removeMessage(IMqttDeliveryToken token) throws MqttException {
 	 *
 	 * Call each main class and let it tidy up e.g. releasing the token
 	 * store which normally survives a disconnect.
+	 * @param force - whether to force the connection to close.
 	 * @throws MqttException  if not disconnected
 	 */
 	public void close(boolean force) throws MqttException {
@@ -293,7 +293,7 @@ public void connect(MqttConnectOptions options, MqttToken token) throws MqttExce
 			}
 			else {
 				// @TRACE 207=connect failed: not disconnected {0}
-				log.fine(CLASS_NAME,methodName,"207", new Object[] {new Byte(conState)});
+				log.fine(CLASS_NAME,methodName,"207", new Object[] {Byte.valueOf(conState)});
 				if (isClosed() || closePending) {
 					throw new MqttException(MqttException.REASON_CODE_CLIENT_CLOSED);
 				} else if (isConnecting()) {
@@ -322,7 +322,7 @@ public void connectComplete( MqttConnack cack, MqttException mex) throws MqttExc
 		}
 
 		// @TRACE 204=connect failed: rc={0}
-		log.fine(CLASS_NAME,methodName,"204", new Object[]{new Integer(rc)});
+		log.fine(CLASS_NAME,methodName,"204", new Object[]{Integer.valueOf(rc)});
 		throw mex;
 	}
 
@@ -426,7 +426,7 @@ public void shutdownConnection(MqttToken token, MqttException reason) {
 		// it now. This is done at the end to allow a new connect
 		// to be processed and now throw a currently disconnecting error.
 		// any outstanding tokens and unblock any waiters
-		if (endToken != null & callback != null) {
+		if (endToken != null && callback != null) {
 			callback.asyncOperationComplete(endToken);
 		}
 
@@ -627,7 +627,7 @@ public NetworkModule[] getNetworkModules() {
 		return networkModules;
 	}
 	public void setNetworkModules(NetworkModule[] networkModules) {
-		this.networkModules = networkModules;
+		this.networkModules = networkModules.clone();
 	}
 	public MqttDeliveryToken[] getPendingDeliveryTokens() {
 		return tokenStore.getOutstandingDelTokens();
@@ -659,7 +659,7 @@ public MqttConnectOptions getConOptions() {
 
 	public Properties getDebug() {
 		Properties props = new Properties();
-		props.put("conState", new Integer(conState));
+		props.put("conState", Integer.valueOf(conState));
 		props.put("serverURI", getClient().getServerURI());
 		props.put("callback", callback);
 		props.put("stoppingComms", new Boolean(stoppingComms));

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttAsyncClient.java

@@ -750,7 +750,7 @@ public IMqttToken connect(MqttConnectOptions options, Object userContext, IMqttA
 		// userName={3} password={4} will={5} userContext={6} callback={7}
 		log.fine(CLASS_NAME, methodName, "103",
 				new Object[] { Boolean.valueOf(options.isCleanSession()), new Integer(options.getConnectionTimeout()),
-						new Integer(options.getKeepAliveInterval()), options.getUserName(),
+						Integer.valueOf(options.getKeepAliveInterval()), options.getUserName(),
 						((null == options.getPassword()) ? "[null]" : "[notnull]"),
 						((null == options.getWillMessage()) ? "[null]" : "[notnull]"), userContext, callback });
 		comms.setNetworkModules(createNetworkModules(serverURI, options));
@@ -815,7 +815,7 @@ public IMqttToken disconnect(long quiesceTimeout, Object userContext, IMqttActio
 			throws MqttException {
 		final String methodName = "disconnect";
 		// @TRACE 104=> quiesceTimeout={0} userContext={1} callback={2}
-		log.fine(CLASS_NAME, methodName, "104", new Object[] { new Long(quiesceTimeout), userContext, callback });
+		log.fine(CLASS_NAME, methodName, "104", new Object[] { Long.valueOf(quiesceTimeout), userContext, callback });
 
 		MqttToken token = new MqttToken(getClientId());
 		token.setActionCallback(callback);
@@ -1427,7 +1427,7 @@ private void attemptReconnect() {
 	private void startReconnectCycle() {
 		String methodName = "startReconnectCycle";
 		// @Trace 503=Start reconnect timer for client: {0}, delay: {1}
-		log.fine(CLASS_NAME, methodName, "503", new Object[] { this.clientId, new Long(reconnectDelay) });
+		log.fine(CLASS_NAME, methodName, "503", new Object[] { this.clientId, Long.valueOf(reconnectDelay) });
 		reconnectTimer = new Timer("MQTT Reconnect: " + clientId);
 		reconnectTimer.schedule(new ReconnectTask(), reconnectDelay);
 	}

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttConnectOptions.java

@@ -78,7 +78,7 @@ public class MqttConnectOptions {
 	private boolean cleanSession = CLEAN_SESSION_DEFAULT;
 	private int connectionTimeout = CONNECTION_TIMEOUT_DEFAULT;
 	private String[] serverURIs = null;
-	private int MqttVersion = MQTT_VERSION_DEFAULT;
+	private int mqttVersion = MQTT_VERSION_DEFAULT;
 	private boolean automaticReconnect = false;
 
 	/**
@@ -97,6 +97,7 @@ public class MqttConnectOptions {
 	 * More information about these values can be found in the setter methods.
 	 */
 	public MqttConnectOptions() {
+		// Initialise Base MqttConnectOptions Object
 	}
 
 	/**
@@ -112,7 +113,7 @@ public char[] getPassword() {
 	 * @param password A Char Array of the password
 	 */
 	public void setPassword(char[] password) {
-		this.password = password;
+		this.password = password.clone();
 	}
 
 	/**
@@ -213,7 +214,7 @@ public int getKeepAliveInterval() {
 	 * @return the MQTT version.
 	 */
 	public int getMqttVersion() {
-		return MqttVersion;
+		return mqttVersion;
 	}
 
 	/**
@@ -515,7 +516,7 @@ public void setServerURIs(String[] array) {
 		for (int i = 0; i < array.length; i++) {
 			validateURI(array[i]);
 		}
-		this.serverURIs = array;
+		this.serverURIs = array.clone();
 	}
 
 	/**
@@ -563,16 +564,16 @@ else if ("local".equals(vURI.getScheme())) {
 	 * Version 3.1.1 or 3.1 can be selected specifically, with no fall back,
 	 * by using the MQTT_VERSION_3_1_1 or MQTT_VERSION_3_1 options respectively.
 	 *
-	 * @param MqttVersion the version of the MQTT protocol.
+	 * @param mqttVersion the version of the MQTT protocol.
 	 * @throws IllegalArgumentException If the MqttVersion supplied is invalid
 	 */
-	public void setMqttVersion(int MqttVersion)throws IllegalArgumentException {
-		if (MqttVersion != MQTT_VERSION_DEFAULT && 
-			MqttVersion != MQTT_VERSION_3_1 && 
-			MqttVersion != MQTT_VERSION_3_1_1) {
+	public void setMqttVersion(int mqttVersion)throws IllegalArgumentException {
+		if (mqttVersion != MQTT_VERSION_DEFAULT && 
+			mqttVersion != MQTT_VERSION_3_1 && 
+			mqttVersion != MQTT_VERSION_3_1_1) {
 			throw new IllegalArgumentException();
 		}
-		this.MqttVersion = MqttVersion;
+		this.mqttVersion = mqttVersion;
 	}
 
 	/**
@@ -608,10 +609,10 @@ public void setAutomaticReconnect(boolean automaticReconnect) {
 	public Properties getDebug() {
 		final String strNull="null";
 		Properties p = new Properties();
-		p.put("MqttVersion", new Integer(getMqttVersion()));
+		p.put("MqttVersion", Integer.valueOf(getMqttVersion()));
 		p.put("CleanSession", Boolean.valueOf(isCleanSession()));
-		p.put("ConTimeout", new Integer(getConnectionTimeout()));
-		p.put("KeepAliveInterval", new Integer(getKeepAliveInterval()));
+		p.put("ConTimeout", Integer.valueOf(getConnectionTimeout()));
+		p.put("KeepAliveInterval", Integer.valueOf(getKeepAliveInterval()));
 		p.put("UserName", (getUserName() == null) ? strNull : getUserName());
 		p.put("WillDestination", (getWillDestination() == null) ? strNull : getWillDestination());
 		if (getSocketFactory()==null) {

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttMessage.java

@@ -95,7 +95,7 @@ public void setPayload(byte[] payload) {
 		if (payload == null) {
 			throw new NullPointerException();
 		}
-		this.payload = payload;
+		this.payload = payload.clone();
 	}
 
 	/**

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttTopic.java

@@ -165,7 +165,7 @@ public static void validate(String topicString, boolean wildcardAllowed)
 		// NOT encode to more than 65535 bytes
 		if (topicLen < MIN_TOPIC_LEN || topicLen > MAX_TOPIC_LEN) {
 			throw new IllegalArgumentException(String.format("Invalid topic length, should be in range[%d, %d]!", 
-					new Object[] { new Integer(MIN_TOPIC_LEN), new Integer(MAX_TOPIC_LEN) }));
+					new Object[] { Integer.valueOf(MIN_TOPIC_LEN), Integer.valueOf(MAX_TOPIC_LEN) }));
 		}
 
 		// *******************************************************************************

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/ScheduledExecutorPingSender.java

@@ -25,7 +25,7 @@
 /**
  * Default ping sender implementation
  *
- * <p>This class implements the {@link IMqttPingSender} pinger interface
+ * <p>This class implements the {@link MqttPingSender} pinger interface
  * allowing applications to send ping packet to server every keep alive interval.
  * </p>
  *
@@ -84,7 +84,7 @@ public void run() {
 			String originalThreadName = Thread.currentThread().getName();
 			Thread.currentThread().setName("MQTT Ping: " + clientid);
 			//@Trace 660=Check schedule at {0}
-			log.fine(CLASS_NAME, methodName, "660", new Object[]{ new Long(System.currentTimeMillis()) });
+			log.fine(CLASS_NAME, methodName, "660", new Object[]{ Long.valueOf(System.currentTimeMillis()) });
 			comms.checkForActivity();
 			Thread.currentThread().setName(originalThreadName);
 		}

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/TimerPingSender.java

@@ -73,7 +73,7 @@ private class PingTask extends TimerTask {
 
 		public void run() {
 			//@Trace 660=Check schedule at {0}
-			log.fine(CLASS_NAME, methodName, "660", new Object[]{new Long(System.currentTimeMillis())});
+			log.fine(CLASS_NAME, methodName, "660", new Object[]{Long.valueOf(System.currentTimeMillis())});
 			comms.checkForActivity();			
 		}
 	}