Added all backwards compatibility methods with documentation.feature/issue_137

8 files changed, 253 insertions, 53 deletions

diff --git a/sdl_android_lib/src/com/smartdevicelink/protocol/ProtocolFrameHeader.java b/sdl_android_lib/src/com/smartdevicelink/protocol/ProtocolFrameHeader.java
index d749b4b93..43df39b5b 100644
--- a/sdl_android_lib/src/com/smartdevicelink/protocol/ProtocolFrameHeader.java
+++ b/sdl_android_lib/src/com/smartdevicelink/protocol/ProtocolFrameHeader.java
@@ -54,9 +54,9 @@ public class ProtocolFrameHeader {
 		header <<= 1;

 		header |= (compressed ? 1 : 0);

 		header <<= 3;

-		header |= (frameType.getId() & 0x07);

+		header |= (frameType.getValue() & 0x07);

 		header <<= 8;

-		header |= (sessionType.getId() & 0xFF);

+		header |= (sessionType.getValue() & 0xFF);

 		header <<= 8;

 		header |= (frameData & 0xFF);

 		header <<= 8;

diff --git a/sdl_android_lib/src/com/smartdevicelink/protocol/ProtocolFrameHeaderFactory.java b/sdl_android_lib/src/com/smartdevicelink/protocol/ProtocolFrameHeaderFactory.java
index 0184467da..e52df52f1 100644
--- a/sdl_android_lib/src/com/smartdevicelink/protocol/ProtocolFrameHeaderFactory.java
+++ b/sdl_android_lib/src/com/smartdevicelink/protocol/ProtocolFrameHeaderFactory.java
@@ -12,7 +12,7 @@ public class ProtocolFrameHeaderFactory {
 		msg.setVersion(version);

 		msg.setFrameType(FrameType.CONTROL);

 		msg.setSessionType(serviceType);

-		msg.setFrameData(FrameDataControlFrameType.START_SESSION.getId());

+		msg.setFrameData(FrameDataControlFrameType.START_SESSION.getValue());

 		msg.setMessageID(messageID);

 		msg.setSessionID(sessionID);

 

@@ -38,7 +38,7 @@ public class ProtocolFrameHeaderFactory {
 	        msg.setFrameType(FrameType.CONTROL);

 	        msg.setSessionType(serviceType);

 	        msg.setSessionID(sessionID);

-	        msg.setFrameData(frameData.getId());

+	        msg.setFrameData(frameData.getValue());

 	        return msg;

 	}	

 	

@@ -48,7 +48,7 @@ public class ProtocolFrameHeaderFactory {
 		msg.setFrameType(FrameType.CONTROL);

 		msg.setSessionType(serviceType);

 		msg.setSessionID(sessionID);

-		msg.setFrameData(FrameDataControlFrameType.START_SESSION_ACK.getId());

+		msg.setFrameData(FrameDataControlFrameType.START_SESSION_ACK.getValue());

 		msg.setMessageID(messageID);

 

 		return msg;

@@ -60,7 +60,7 @@ public class ProtocolFrameHeaderFactory {
 		msg.setFrameType(FrameType.CONTROL);

 		msg.setSessionType(serviceType);

 		msg.setSessionID(sessionID);

-		msg.setFrameData(FrameDataControlFrameType.START_SESSION_NACK.getId());

+		msg.setFrameData(FrameDataControlFrameType.START_SESSION_NACK.getValue());

 		msg.setMessageID(messageID);

 

 		return msg;

@@ -72,7 +72,7 @@ public class ProtocolFrameHeaderFactory {
 		msg.setFrameType(FrameType.CONTROL);

 		msg.setSessionType(serviceType);

 		msg.setSessionID(sessionID);

-		msg.setFrameData(FrameDataControlFrameType.END_SESSION.getId());

+		msg.setFrameData(FrameDataControlFrameType.END_SESSION.getValue());

 		msg.setMessageID(messageID);

 

 		return msg;

@@ -84,7 +84,7 @@ public class ProtocolFrameHeaderFactory {
 		msg.setVersion(version);

 		msg.setFrameType(FrameType.SINGLE);

 		msg.setSessionType(serviceType);

-		msg.setFrameData(FrameData.SINGLE_FRAME.getId());

+		msg.setFrameData(FrameData.SINGLE_FRAME.getValue());

 		msg.setSessionID(sessionID);

 		msg.setDataSize(dataLength);

 		msg.setMessageID(messageID);

@@ -98,7 +98,7 @@ public class ProtocolFrameHeaderFactory {
 		msg.setVersion(version);

 		msg.setFrameType(FrameType.FIRST);

 		msg.setSessionType(serviceType);

-		msg.setFrameData(FrameData.FIRST_FRAME.getId());

+		msg.setFrameData(FrameData.FIRST_FRAME.getValue());

 		msg.setSessionID(sessionID);

 		msg.setDataSize(8);

 		msg.setMessageID(messageID);

@@ -126,7 +126,7 @@ public class ProtocolFrameHeaderFactory {
 		msg.setVersion(version);

 		msg.setFrameType(FrameType.CONSECUTIVE);

 		msg.setSessionType(serviceType);

-		msg.setFrameData(FrameData.CONSECUTIVE_FRAME.getId());

+		msg.setFrameData(FrameData.CONSECUTIVE_FRAME.getValue());

 		msg.setSessionID(sessionID);

 		msg.setDataSize(dataLength);

 		msg.setMessageID(messageID);

diff --git a/sdl_android_lib/src/com/smartdevicelink/protocol/WiProProtocol.java b/sdl_android_lib/src/com/smartdevicelink/protocol/WiProProtocol.java
index ceabc2b93..1ba5e744f 100644
--- a/sdl_android_lib/src/com/smartdevicelink/protocol/WiProProtocol.java
+++ b/sdl_android_lib/src/com/smartdevicelink/protocol/WiProProtocol.java
@@ -140,13 +140,13 @@ public class WiProProtocol extends AbstractProtocol {
 				for (int i = 0; i < frameCount; i++) {

 					if (i < (frameCount - 1)) {

 	                     ++frameSequenceNumber;

-	                        if (frameSequenceNumber == FrameData.CONSECUTIVE_FRAME.getId()) {

+	                        if (frameSequenceNumber == FrameData.CONSECUTIVE_FRAME.getValue()) {

 	                            // we can't use 0x00 as frameSequenceNumber, because

 	                            // it's reserved for the last frame

 	                            ++frameSequenceNumber;

 	                        }

 					} else {

-						frameSequenceNumber = FrameData.CONSECUTIVE_FRAME.getId();

+						frameSequenceNumber = FrameData.CONSECUTIVE_FRAME.getValue();

 					} // end-if

 					

 					int bytesToWrite = data.length - currentOffset;

@@ -397,7 +397,7 @@ public class WiProProtocol extends AbstractProtocol {
 		} // end-method

 		

 		protected void handleFrame(ProtocolFrameHeader header, byte[] data) {

-			if (header.getFrameType().equals(FrameType.CONTROL)) {

+			if (header.getFrameType() == FrameType.CONTROL) {

 				handleControlFrame(header, data);

 			} else {

 				// Must be a form of data frame (single, first, consecutive, etc.)

@@ -417,12 +417,12 @@ public class WiProProtocol extends AbstractProtocol {
         } // end-method		

 		

 		private void handleControlFrame(ProtocolFrameHeader header, byte[] data) {

-            if (header.getFrameData() == FrameDataControlFrameType.HEARTBEAT.getId()) {

+            if (header.getFrameData() == FrameDataControlFrameType.HEARTBEAT.getValue()) {

                 handleProtocolHeartbeatACK(header, data);

             }

-            else if (header.getFrameData() == FrameDataControlFrameType.START_SESSION.getId()) {

+            else if (header.getFrameData() == FrameDataControlFrameType.START_SESSION.getValue()) {

 				sendStartProtocolSessionACK(header.getSessionType(), header.getSessionID());

-			} else if (header.getFrameData() == FrameDataControlFrameType.START_SESSION_ACK.getId()) {

+			} else if (header.getFrameData() == FrameDataControlFrameType.START_SESSION_ACK.getValue()) {

 				// Use this sessionID to create a message lock

 				Object messageLock = _messageLocks.get(header.getSessionID());

 				if (messageLock == null) {

@@ -432,19 +432,19 @@ public class WiProProtocol extends AbstractProtocol {
 				//hashID = BitConverter.intFromByteArray(data, 0);

 				if (_version > 1) hashID = header.getMessageID();

 				handleProtocolSessionStarted(header.getSessionType(), header.getSessionID(), _version, "");				

-			} else if (header.getFrameData() == FrameDataControlFrameType.START_SESSION_NACK.getId()) {

-				if (header.getSessionType().equals(SessionType.NAV)) {

+			} else if (header.getFrameData() == FrameDataControlFrameType.START_SESSION_NACK.getValue()) {

+				if (header.getSessionType() == SessionType.NAV) {

 					handleProtocolSessionNACKed(header.getSessionType(), header.getSessionID(), _version, "");

 				} else {

 					handleProtocolError("Got StartSessionNACK for protocol sessionID=" + header.getSessionID(), null);

 				}

-			} else if (header.getFrameData() == FrameDataControlFrameType.END_SESSION.getId()) {

+			} else if (header.getFrameData() == FrameDataControlFrameType.END_SESSION.getValue()) {

 				//if (hashID == BitConverter.intFromByteArray(data, 0)) 

 				if (_version > 1) {

 					if (hashID == header.getMessageID())

 						handleProtocolSessionEnded(header.getSessionType(), header.getSessionID(), "");

 				} else handleProtocolSessionEnded(header.getSessionType(), header.getSessionID(), "");

-			} else if (header.getFrameData() == FrameDataControlFrameType.END_SESSION_ACK.getId()) {

+			} else if (header.getFrameData() == FrameDataControlFrameType.END_SESSION_ACK.getValue()) {

 				handleProtocolSessionEnded(header.getSessionType(), header.getSessionID(), "");

 			}

 		} // end-method

diff --git a/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameData.java b/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameData.java
index 046a83c08..59e7843d6 100644
--- a/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameData.java
+++ b/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameData.java
@@ -15,25 +15,75 @@ public enum FrameData {
 	START_SESSION_NACK ((byte) 0x03),
 	END_SESSION        ((byte) 0x04);
 	
-	private final byte id;
+	private final byte value;
 	
-	FrameData (byte id) {
-		this.id = id;
+	FrameData (byte value) {
+		this.value = value;
 	}
 	
-	public byte getId () {
-		return id;
+	public byte getValue () {
+		return value;
+	}
+	
+	/** Use enum .toString() method instead. */
+	@Deprecated
+	public String getName () {
+		return toString();
+	}
+	
+	/** Use == operator instead. */
+	@Deprecated
+	public boolean equals(FrameData other) {
+		return (this == other);
+	}
+	
+	/** Use == operator instead. */
+	@Deprecated
+	public boolean eq(FrameData other) {
+		return (this == other);
+	}
+	
+	/** Use .getValue() instead. */
+	@Deprecated
+	public byte value() {
+		return value;
 	}
 	
 	public static FrameData valueOf (byte key) {
-		for(FrameData value : FrameData.values()) {
-			if (value.getId() == key) {
+		return lookUp(FrameData.values(), key);
+	}
+	
+	/** Use .valueOf(byte) */
+	@Deprecated
+	public static FrameData get(Vector<FrameData> list, byte key) {
+		return lookUp(list.toArray(new FrameData[list.size()]), key);
+	}
+	
+	/** Use == operator instead. */
+	@Deprecated
+	public static FrameData get(Vector<FrameData> list, String key) {
+		return lookUp(list.toArray(new FrameData[list.size()]), key);
+	}
+	
+	private static FrameData lookUp (FrameData[] list, byte key) {
+		for(FrameData value : list) {
+			if (value.getValue() == key) {
+				return value;
+			}
+		}
+		return null;
+	}
+	
+	private static FrameData lookUp (FrameData[] list, String key) {
+		for(FrameData value : list) {
+			if (value.toString().equals(key)) {
 				return value;
 			}
 		}
 		return null;
 	}
 	
+	/** Use enum .values() method instead. */
 	@Deprecated
 	public Vector<FrameData> getList() {
 		return new Vector<FrameData>(Arrays.asList(values()));
diff --git a/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameDataControlFrameType.java b/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameDataControlFrameType.java
index a4e3762fe..0b0fdeca2 100644
--- a/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameDataControlFrameType.java
+++ b/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameDataControlFrameType.java
@@ -14,25 +14,75 @@ public enum FrameDataControlFrameType {
 	END_SESSION_NACK   ((byte) 0x06),

 	HEARTBEAT_ACK      ((byte) 0xFF);

 	

-	private final byte id;

+	private final byte value;

 	

-	FrameDataControlFrameType (byte id) {

-		this.id = id;

+	FrameDataControlFrameType (byte value) {

+		this.value = value;

 	}

 	

-	public byte getId () {

-		return id;

-	}	

+	public byte getValue () {

+		return value;

+	}

+	

+	/** Use enum .toString() method instead. */

+	@Deprecated

+	public String getName () {

+		return toString();

+	}

+	

+	/** Use == operator instead. */

+	@Deprecated

+	public boolean equals(FrameDataControlFrameType other) {

+		return (this == other);

+	}

+	

+	/** Use == operator instead. */

+	@Deprecated

+	public boolean eq(FrameDataControlFrameType other) {

+		return (this == other);

+	}

+	

+	/** Use .getValue() instead. */

+	@Deprecated

+	public byte value() {

+		return value;

+	}

 	

 	public static FrameDataControlFrameType valueOf (byte key) {

-		for(FrameDataControlFrameType value : FrameDataControlFrameType.values()) {

-			if (value.getId() == key) {

+		return lookUp(FrameDataControlFrameType.values(), key);

+	}

+	

+	/** Use .valueOf(byte) */

+	@Deprecated

+	public static FrameDataControlFrameType get(Vector<FrameType> list, byte key) {

+		return lookUp(list.toArray(new FrameDataControlFrameType[list.size()]), key);

+	}

+	

+	/** Use == operator instead. */

+	@Deprecated

+	public static FrameDataControlFrameType get(Vector<FrameDataControlFrameType> list, String key) {

+		return lookUp(list.toArray(new FrameDataControlFrameType[list.size()]), key);

+	}

+	

+	private static FrameDataControlFrameType lookUp (FrameDataControlFrameType[] list, byte key) {

+		for(FrameDataControlFrameType value : list) {

+			if (value.getValue() == key) {

+				return value;

+			}

+		}

+		return null;

+	}

+	

+	private static FrameDataControlFrameType lookUp (FrameDataControlFrameType[] list, String key) {

+		for(FrameDataControlFrameType value : list) {

+			if (value.toString().equals(key)) {

 				return value;

 			}

 		}

 		return null;

 	}

 	

+	/** Use enum .values() method instead. */

 	@Deprecated

 	public Vector<FrameDataControlFrameType> getList() {

 		return new Vector<FrameDataControlFrameType>(Arrays.asList(values()));

diff --git a/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameType.java b/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameType.java
index cdb0a7356..e1203cb60 100644
--- a/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameType.java
+++ b/sdl_android_lib/src/com/smartdevicelink/protocol/enums/FrameType.java
@@ -10,25 +10,75 @@ public enum FrameType {
 	FIRST       ((byte) 0x02),

 	CONSECUTIVE ((byte) 0x03);

 	

-	private final byte id;

+	private final byte value;

 	

-	FrameType (byte id) {

-		this.id = id;

+	FrameType (byte value) {

+		this.value = value;

 	}

 	

-	public byte getId () {

-		return id;

+	public byte getValue () {

+		return value;

+	}

+	

+	/** Use enum .toString() method instead. */

+	@Deprecated

+	public String getName () {

+		return toString();

+	}

+	

+	/** Use == operator instead. */

+	@Deprecated

+	public boolean equals(FrameType other) {

+		return (this == other);

+	}

+	

+	/** Use == operator instead. */

+	@Deprecated

+	public boolean eq(FrameType other) {

+		return (this == other);

+	}

+	

+	/** Use .getValue() instead. */

+	@Deprecated

+	public byte value() {

+		return value;

 	}

 	

 	public static FrameType valueOf (byte key) {

-		for(FrameType value : FrameType.values()) {

-			if (value.getId() == key) {

+		return lookUp(FrameType.values(), key);

+	}

+	

+	/** Use .valueOf(byte) */

+	@Deprecated

+	public static FrameType get(Vector<FrameType> list, byte key) {

+		return lookUp(list.toArray(new FrameType[list.size()]), key);

+	}

+	

+	/** Use == operator instead. */

+	@Deprecated

+	public static FrameType get(Vector<FrameType> list, String key) {

+		return lookUp(list.toArray(new FrameType[list.size()]), key);

+	}

+	

+	private static FrameType lookUp (FrameType[] list, byte key) {

+		for(FrameType value : list) {

+			if (value.getValue() == key) {

+				return value;

+			}

+		}

+		return null;

+	}

+	

+	private static FrameType lookUp (FrameType[] list, String key) {

+		for(FrameType value : list) {

+			if (value.toString().equals(key)) {

 				return value;

 			}

 		}

 		return null;

 	}

 	

+	/** Use enum .values() method instead. */

 	@Deprecated

 	public Vector<FrameType> getList() {

 		return new Vector<FrameType>(Arrays.asList(values()));

diff --git a/sdl_android_lib/src/com/smartdevicelink/protocol/enums/SessionType.java b/sdl_android_lib/src/com/smartdevicelink/protocol/enums/SessionType.java
index 6fe67030a..4fc19b9d4 100644
--- a/sdl_android_lib/src/com/smartdevicelink/protocol/enums/SessionType.java
+++ b/sdl_android_lib/src/com/smartdevicelink/protocol/enums/SessionType.java
@@ -11,25 +11,75 @@ public enum SessionType {
 	NAV       ((byte) 0x0B),

 	BULK_DATA ((byte) 0xF);

 	

-	private final byte id;

+	private final byte value;

 	

-	SessionType (byte id) {

-		this.id = id;

+	SessionType (byte value) {

+		this.value = value;

 	}

 	

-	public byte getId () {

-		return id;

+	public byte getValue () {

+		return value;

+	}

+	

+	/** Use enum .toString() method instead. */

+	@Deprecated

+	public String getName () {

+		return toString();

+	}

+	

+	/** Use == operator instead. */

+	@Deprecated

+	public boolean equals(SessionType other) {

+		return (this == other);

+	}

+	

+	/** Use == operator instead. */

+	@Deprecated

+	public boolean eq(SessionType other) {

+		return (this == other);

+	}

+	

+	/** Use .getValue() instead. */

+	@Deprecated

+	public byte value() {

+		return value;

 	}

 	

 	public static SessionType valueOf (byte key) {

-		for(SessionType value : SessionType.values()) {

-			if (value.getId() == key) {

+		return lookUp(SessionType.values(), key);

+	}

+	

+	/** Use .valueOf(byte) */

+	@Deprecated

+	public static SessionType get(Vector<SessionType> list, byte key) {

+		return lookUp(list.toArray(new SessionType[list.size()]), key);

+	}

+	

+	/** Use == operator instead. */

+	@Deprecated

+	public static SessionType get(Vector<SessionType> list, String key) {

+		return lookUp(list.toArray(new SessionType[list.size()]), key);

+	}

+	

+	private static SessionType lookUp (SessionType[] list, byte key) {

+		for(SessionType value : list) {

+			if (value.getValue() == key) {

+				return value;

+			}

+		}

+		return null;

+	}

+	

+	private static SessionType lookUp (SessionType[] list, String key) {

+		for(SessionType value : list) {

+			if (value.toString().equals(key)) {

 				return value;

 			}

 		}

 		return null;

 	}

 	

+	/** Use enum .values() method instead. */

 	@Deprecated

 	public Vector<SessionType> getList() {

 		return new Vector<SessionType>(Arrays.asList(values()));

diff --git a/sdl_android_lib/src/com/smartdevicelink/trace/SdlTrace.java b/sdl_android_lib/src/com/smartdevicelink/trace/SdlTrace.java
index dffeab828..d5a7f8d87 100644
--- a/sdl_android_lib/src/com/smartdevicelink/trace/SdlTrace.java
+++ b/sdl_android_lib/src/com/smartdevicelink/trace/SdlTrace.java
@@ -295,13 +295,13 @@ public class SdlTrace {
 		int frameData = hdr.getFrameData();

 		if (hdr.getFrameType() == FrameType.CONTROL) {

 			sb.append("<ca>");

-			if (frameData == FrameDataControlFrameType.START_SESSION.getId()) 

+			if (frameData == FrameDataControlFrameType.START_SESSION.getValue()) 

 				sb.append("StartSession");

-			else if (frameData == FrameDataControlFrameType.START_SESSION_ACK.getId())

+			else if (frameData == FrameDataControlFrameType.START_SESSION_ACK.getValue())

 				sb.append("StartSessionACK");

-			else if (frameData == FrameDataControlFrameType.START_SESSION_NACK.getId())

+			else if (frameData == FrameDataControlFrameType.START_SESSION_NACK.getValue())

 				sb.append("StartSessionNACK");

-			else if (frameData == FrameDataControlFrameType.END_SESSION.getId())

+			else if (frameData == FrameDataControlFrameType.END_SESSION.getValue())

 				sb.append("EndSession");

 			sb.append("</ca>");

 		} else if (hdr.getFrameType() == FrameType.CONSECUTIVE) {