[Minor changes] Javadoc, typos, function names, etc.

tatianaleon · tatianaleon · commit f5c2e836678c · 2015-06-19T19:33:08.000+02:00
Signed-off-by: Tatiana Leon &lt;tatiana.leon@digi.com&gt;
diff --git a/library/src/main/java/com/digi/xbee/api/exceptions/TransmitException.java b/library/src/main/java/com/digi/xbee/api/exceptions/TransmitException.java
@@ -104,7 +104,7 @@ public String getTransmitStatusMessage() {
 	@Override
 	public String getMessage() {
 		if (transmitStatus != null)
-			return super.getMessage() + " > " + transmitStatus.getDescription();
+			return super.getMessage() + " > " + transmitStatus.toString();
 		return super.getMessage();
 	}
 }
diff --git a/library/src/main/java/com/digi/xbee/api/models/HardwareVersion.java b/library/src/main/java/com/digi/xbee/api/models/HardwareVersion.java
@@ -71,9 +71,7 @@ public String getDescription() {
 	 * 
 	 * @param value Numeric value of the {@code HardwareVersion} retrieve.
 	 * 
-	 * @return The {@code HardwareVersion} associated to the given value, 
-	 *         {@code null} if there is not any {@code HardwareVersion} with 
-	 *         that value.
+	 * @return The {@code HardwareVersion} associated to the given value.
 	 */
 	public static HardwareVersion get(int value) {
 		HardwareVersionEnum hvEnum = HardwareVersionEnum.get(value);
@@ -90,8 +88,7 @@ public static HardwareVersion get(int value) {
 	 * @param description Description of the {@code HardwareVersion} retrieve.
 	 * 
 	 * @return The {@code HardwareVersion} associated to the given value and 
-	 *         description, {@code null} if there is not any 
-	 *         {@code HardwareVersion} associated to those values.
+	 *         description.
 	 * 
 	 * @throws IllegalArgumentException if {@code value < 0} or
 	 *                                  if {@code description.length() < 1}.
diff --git a/library/src/main/java/com/digi/xbee/api/models/HardwareVersionEnum.java b/library/src/main/java/com/digi/xbee/api/models/HardwareVersionEnum.java
@@ -134,6 +134,6 @@ public static HardwareVersionEnum get(int value) {
 	 */
 	@Override
 	public String toString() {
-		return HexUtils.byteToHexString((byte)value) + ": " + description;
+		return String.format("0x%02X: %s", value, description);
 	}
 }
diff --git a/library/src/main/java/com/digi/xbee/api/models/ModemStatusEvent.java b/library/src/main/java/com/digi/xbee/api/models/ModemStatusEvent.java
@@ -13,8 +13,6 @@
 
 import java.util.HashMap;
 
-import com.digi.xbee.api.utils.HexUtils;
-
 /**
  * Enumerates the different modem status events. This enumeration list is 
  * intended to be used within the 
@@ -106,6 +104,6 @@ public static ModemStatusEvent get(int id) {
 	 */
 	@Override
 	public String toString() {
-		return HexUtils.byteToHexString((byte)id) + ": " + description;
+		return String.format("0x%02X: %s", id, description);
 	}
 }
diff --git a/library/src/main/java/com/digi/xbee/api/models/XBeeDiscoveryStatus.java b/library/src/main/java/com/digi/xbee/api/models/XBeeDiscoveryStatus.java
@@ -55,9 +55,9 @@ private XBeeDiscoveryStatus(int id, String description) {
 	}
 	
 	/**
-	 * Returns the discovery status ID.
+	 * Returns the numeric value of the discovery status identifier.
 	 * 
-	 * @return The discovery status ID.
+	 * @return The discovery status identifier.
 	 */
 	public int getId() {
 		return id;
@@ -73,17 +73,24 @@ public String getDescription() {
 	}
 	
 	/**
-	 * Returns the {@code XBeeDiscoveryStatus} associated to the given ID.
+	 * Returns the {@code XBeeDiscoveryStatus} associated to the given 
+	 * identifier.
 	 * 
-	 * @param id ID of the {@code XBeeDiscoveryStatus} to retrieve.
+	 * Returns {@code DISCOVERY_STATUS_UNKNOWN} if the identifier is not in the 
+	 * enumeration.
 	 * 
-	 * @return The {@code XBeeDiscoveryStatus} associated with the given ID.
+	 * @param id Identifier of the {@code XBeeDiscoveryStatus} to retrieve.
+	 * 
+	 * @return The {@code XBeeDiscoveryStatus} associated with the given 
+	 *         identifier.
+	 *         {@code DISCOVERY_STATUS_UNKNOWN} if the identifier is not in the 
+	 *         enumeration.
 	 */
 	public static XBeeDiscoveryStatus get(int id) {
 		XBeeDiscoveryStatus status = lookupTable.get(id);
 		if (status != null)
 			return status;
-		return XBeeDiscoveryStatus.DISCOVERY_STATUS_UNKNOWN;
+		return DISCOVERY_STATUS_UNKNOWN;
 	}
 	
 	/*
@@ -92,6 +99,6 @@ public static XBeeDiscoveryStatus get(int id) {
 	 */
 	@Override
 	public String toString() {
-		return description;
+		return String.format("%s (0x%02X)", description, id);
 	}
 }
diff --git a/library/src/main/java/com/digi/xbee/api/packet/common/TransmitStatusPacket.java b/library/src/main/java/com/digi/xbee/api/packet/common/TransmitStatusPacket.java
@@ -239,9 +239,15 @@ public boolean isBroadcast() {
 	public LinkedHashMap<String, String> getAPIPacketParameters() {
 		LinkedHashMap<String, String> parameters = new LinkedHashMap<String, String>();
 		parameters.put("16-bit dest. address", HexUtils.prettyHexString(destAddress16.toString()));
-		parameters.put("Tx. retry count", HexUtils.prettyHexString(HexUtils.integerToHexString(tranmistRetryCount, 1)) + " (" + tranmistRetryCount + ")");
-		parameters.put("Delivery status", HexUtils.prettyHexString(HexUtils.integerToHexString(transmitStatus.getId(), 1)) + " (" + transmitStatus.getDescription() + ")");
-		parameters.put("Discovery status", HexUtils.prettyHexString(HexUtils.integerToHexString(discoveryStatus.getId(), 1)) + " (" + discoveryStatus.getDescription() + ")");
+		parameters.put("Tx. retry count", 
+				HexUtils.prettyHexString(HexUtils.integerToHexString(tranmistRetryCount, 1)) 
+				+ " (" + tranmistRetryCount + ")");
+		parameters.put("Delivery status", 
+				HexUtils.prettyHexString(HexUtils.integerToHexString(transmitStatus.getId(), 1)) 
+				+ " (" + transmitStatus.getDescription() + ")");
+		parameters.put("Discovery status", 
+				HexUtils.prettyHexString(HexUtils.integerToHexString(discoveryStatus.getId(), 1)) 
+				+ " (" + discoveryStatus.getDescription() + ")");
 		return parameters;
 	}
 }
diff --git a/library/src/main/java/com/digi/xbee/api/packet/raw/TXStatusPacket.java b/library/src/main/java/com/digi/xbee/api/packet/raw/TXStatusPacket.java
@@ -148,7 +148,9 @@ public boolean isBroadcast() {
 	@Override
 	public LinkedHashMap<String, String> getAPIPacketParameters() {
 		LinkedHashMap<String, String> parameters = new LinkedHashMap<String, String>();
-		parameters.put("Status", HexUtils.prettyHexString(HexUtils.integerToHexString(transmitStatus.getId(), 1)) + " (" + transmitStatus.getDescription() + ")");
+		parameters.put("Status", 
+				HexUtils.prettyHexString(HexUtils.integerToHexString(transmitStatus.getId(), 1)) 
+				+ " (" + transmitStatus.getDescription() + ")");
 		return parameters;
 	}
 }
diff --git a/library/src/test/java/com/digi/xbee/api/models/HardwareVersionEnumTest.java b/library/src/test/java/com/digi/xbee/api/models/HardwareVersionEnumTest.java
@@ -72,7 +72,7 @@ public void testHardwareVersionEnumDescriptions() {
 	 * <p>Verify that each HardwareVersionEnum entry can be retrieved statically using its ID.</p>
 	 */
 	@Test
-	public void testXBeeProtocolStaticAccess() {
+	public void testHardwareVersionEnumStaticAccess() {
 		for (HardwareVersionEnum hardwareVersionEnum:hardwareVersionValues)
 			assertEquals(hardwareVersionEnum, HardwareVersionEnum.get(hardwareVersionEnum.getValue()));
 	}
diff --git a/library/src/test/java/com/digi/xbee/api/models/HardwareVersionTest.java b/library/src/test/java/com/digi/xbee/api/models/HardwareVersionTest.java
@@ -160,7 +160,7 @@ public final void testEqualsWithNull() {
 	 * <p>Test the equals method with a non {@code HardwareVersion} value.</p>
 	 */
 	@Test
-	public final void testEqualsWithNonXBeePacket() {
+	public final void testEqualsWithNonHardwareVersion() {
 		// Setup the resources for the test.
 		HardwareVersion version = HardwareVersion.get(HardwareVersionEnum.XBP24B.getValue());
 		
@@ -177,7 +177,7 @@ public final void testEqualsWithNonXBeePacket() {
 	 * <p>Test the equals method with different {@code HardwareVersion}.</p>
 	 */
 	@Test
-	public final void testEqualsWithDifferentXBeePacket() {
+	public final void testEqualsWithDifferentHardwareVersion() {
 		// Setup the resources for the test.
 		HardwareVersion version1 = HardwareVersion.get(HardwareVersionEnum.XBP24B.getValue());
 		HardwareVersion version2 = HardwareVersion.get(HardwareVersionEnum.X09_001.getValue());
@@ -271,7 +271,7 @@ public final void testEqualsIsConsistent() {
 	 * Test method for {@link com.digi.xbee.api.models.HardwareVersion#hashCode()}.
 	 */
 	@Test
-	public final void testHashCodeWithEqualPackets() {
+	public final void testHashCodeWithEqualHardwareVersions() {
 		// Setup the resources for the test.
 		HardwareVersion version1 = HardwareVersion.get(HardwareVersionEnum.XBP24B.getValue());
 		HardwareVersion version2 = HardwareVersion.get(HardwareVersionEnum.XBP24B.getValue());
@@ -290,7 +290,7 @@ public final void testHashCodeWithEqualPackets() {
 	 * Test method for {@link com.digi.xbee.api.models.HardwareVersion#hashCode()}.
 	 */
 	@Test
-	public final void testHashCodeWithDifferentPackets() {
+	public final void testHashCodeWithDifferentHardwareVersions() {
 		// Setup the resources for the test.
 		HardwareVersion version1 = HardwareVersion.get(HardwareVersionEnum.XBP24B.getValue());
 		HardwareVersion version2 = HardwareVersion.get(HardwareVersionEnum.X09_001.getValue());;

Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ public String getTransmitStatusMessage() {`
`104`	`104`	`@Override`
`105`	`105`	`public String getMessage() {`
`106`	`106`	`if (transmitStatus != null)`
`107`		`- return super.getMessage() + " > " + transmitStatus.getDescription();`
	`107`	`+ return super.getMessage() + " > " + transmitStatus.toString();`
`108`	`108`	`return super.getMessage();`
`109`	`109`	`}`
`110`	`110`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,9 +71,7 @@ public String getDescription() {`
`71`	`71`	`*`
`72`	`72`	`* @param value Numeric value of the {@code HardwareVersion} retrieve.`
`73`	`73`	`*`
`74`		`- * @return The {@code HardwareVersion} associated to the given value,`
`75`		`- * {@code null} if there is not any {@code HardwareVersion} with`
`76`		`- * that value.`
	`74`	`+ * @return The {@code HardwareVersion} associated to the given value.`
`77`	`75`	`*/`
`78`	`76`	`public static HardwareVersion get(int value) {`
`79`	`77`	`HardwareVersionEnum hvEnum = HardwareVersionEnum.get(value);`
`@@ -90,8 +88,7 @@ public static HardwareVersion get(int value) {`
`90`	`88`	`* @param description Description of the {@code HardwareVersion} retrieve.`
`91`	`89`	`*`
`92`	`90`	`* @return The {@code HardwareVersion} associated to the given value and`
`93`		`- * description, {@code null} if there is not any`
`94`		`- * {@code HardwareVersion} associated to those values.`
	`91`	`+ * description.`
`95`	`92`	`*`
`96`	`93`	`* @throws IllegalArgumentException if {@code value < 0} or`
`97`	`94`	`* if {@code description.length() < 1}.`
Original file line number	Diff line number	Diff line change
`@@ -134,6 +134,6 @@ public static HardwareVersionEnum get(int value) {`
`134`	`134`	`*/`
`135`	`135`	`@Override`
`136`	`136`	`public String toString() {`
`137`		`- return HexUtils.byteToHexString((byte)value) + ": " + description;`
	`137`	`+ return String.format("0x%02X: %s", value, description);`
`138`	`138`	`}`
`139`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,6 @@`
`13`	`13`
`14`	`14`	`import java.util.HashMap;`
`15`	`15`
`16`		`-import com.digi.xbee.api.utils.HexUtils;`
`17`		`-`
`18`	`16`	`/**`
`19`	`17`	`* Enumerates the different modem status events. This enumeration list is`
`20`	`18`	`* intended to be used within the`
`@@ -106,6 +104,6 @@ public static ModemStatusEvent get(int id) {`
`106`	`104`	`*/`
`107`	`105`	`@Override`
`108`	`106`	`public String toString() {`
`109`		`- return HexUtils.byteToHexString((byte)id) + ": " + description;`
	`107`	`+ return String.format("0x%02X: %s", id, description);`
`110`	`108`	`}`
`111`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,9 +55,9 @@ private XBeeDiscoveryStatus(int id, String description) {`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`/**`
`58`		`- * Returns the discovery status ID.`
	`58`	`+ * Returns the numeric value of the discovery status identifier.`
`59`	`59`	`*`
`60`		`- * @return The discovery status ID.`
	`60`	`+ * @return The discovery status identifier.`
`61`	`61`	`*/`
`62`	`62`	`public int getId() {`
`63`	`63`	`return id;`
`@@ -73,17 +73,24 @@ public String getDescription() {`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`/**`
`76`		`- * Returns the {@code XBeeDiscoveryStatus} associated to the given ID.`
	`76`	`+ * Returns the {@code XBeeDiscoveryStatus} associated to the given`
	`77`	`+ * identifier.`
`77`	`78`	`*`
`78`		`- * @param id ID of the {@code XBeeDiscoveryStatus} to retrieve.`
	`79`	`+ * Returns {@code DISCOVERY_STATUS_UNKNOWN} if the identifier is not in the`
	`80`	`+ * enumeration.`
`79`	`81`	`*`
`80`		`- * @return The {@code XBeeDiscoveryStatus} associated with the given ID.`
	`82`	`+ * @param id Identifier of the {@code XBeeDiscoveryStatus} to retrieve.`
	`83`	`+ *`
	`84`	`+ * @return The {@code XBeeDiscoveryStatus} associated with the given`
	`85`	`+ * identifier.`
	`86`	`+ * {@code DISCOVERY_STATUS_UNKNOWN} if the identifier is not in the`
	`87`	`+ * enumeration.`
`81`	`88`	`*/`
`82`	`89`	`public static XBeeDiscoveryStatus get(int id) {`
`83`	`90`	`XBeeDiscoveryStatus status = lookupTable.get(id);`
`84`	`91`	`if (status != null)`
`85`	`92`	`return status;`
`86`		`- return XBeeDiscoveryStatus.DISCOVERY_STATUS_UNKNOWN;`
	`93`	`+ return DISCOVERY_STATUS_UNKNOWN;`
`87`	`94`	`}`
`88`	`95`
`89`	`96`	`/*`
`@@ -92,6 +99,6 @@ public static XBeeDiscoveryStatus get(int id) {`
`92`	`99`	`*/`
`93`	`100`	`@Override`
`94`	`101`	`public String toString() {`
`95`		`- return description;`
	`102`	`+ return String.format("%s (0x%02X)", description, id);`
`96`	`103`	`}`
`97`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,9 @@ public boolean isBroadcast() {`
`148`	`148`	`@Override`
`149`	`149`	`public LinkedHashMap<String, String> getAPIPacketParameters() {`
`150`	`150`	`LinkedHashMap<String, String> parameters = new LinkedHashMap<String, String>();`
`151`		`- parameters.put("Status", HexUtils.prettyHexString(HexUtils.integerToHexString(transmitStatus.getId(), 1)) + " (" + transmitStatus.getDescription() + ")");`
	`151`	`+ parameters.put("Status",`
	`152`	`+ HexUtils.prettyHexString(HexUtils.integerToHexString(transmitStatus.getId(), 1))`
	`153`	`+ + " (" + transmitStatus.getDescription() + ")");`
`152`	`154`	`return parameters;`
`153`	`155`	`}`
`154`	`156`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public void testHardwareVersionEnumDescriptions() {`
`72`	`72`	`* <p>Verify that each HardwareVersionEnum entry can be retrieved statically using its ID.</p>`
`73`	`73`	`*/`
`74`	`74`	`@Test`
`75`		`- public void testXBeeProtocolStaticAccess() {`
	`75`	`+ public void testHardwareVersionEnumStaticAccess() {`
`76`	`76`	`for (HardwareVersionEnum hardwareVersionEnum:hardwareVersionValues)`
`77`	`77`	`assertEquals(hardwareVersionEnum, HardwareVersionEnum.get(hardwareVersionEnum.getValue()));`
`78`	`78`	`}`