Add javadoc to new & deprecated methodsfeature/fix_rpcs_mismatch

7 files changed, 96 insertions, 17 deletions

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMICapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMICapabilities.java
index fd5ae76d5..662c4529b 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMICapabilities.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMICapabilities.java
@@ -59,12 +59,19 @@ public class HMICapabilities extends RPCStruct{
 		 return (Boolean)available;
 	 }
 
+	/**
+	 * @deprecated use {@link #setNavigationAvailable(Boolean available)} instead.
+	 */
 	 @Deprecated
 	 public HMICapabilities setNavigationAvilable( Boolean available) {
-        setValue(KEY_NAVIGATION, available);
-        return this;
+        return setNavigationAvailable(available);
     }
 
+	/**
+	 * Sets the navigationAvailable.
+	 *
+	 * @param available Availability of driver Navigation capability. True: Available, False: Not Available
+	 */
 	public HMICapabilities setNavigationAvailable(Boolean available) {
 		setValue(KEY_NAVIGATION, available);
 		return this;
@@ -78,12 +85,19 @@ public class HMICapabilities extends RPCStruct{
 		 return (Boolean)available;
 	 }
 
+	/**
+	 * @deprecated use {@link #setPhoneCallAvailable(Boolean available)} instead.
+	 */
 	 @Deprecated
 	 public HMICapabilities setPhoneCallAvilable( Boolean available) {
-        setValue(KEY_PHONE_CALL, available);
-        return this;
+        return setPhoneCallAvailable(available);
     }
 
+	/**
+	 * Sets the PhoneCallAvailable.
+	 *
+	 * @param available Availability of PhoneCall capability. True: Available, False: Not Available
+	 */
 	public HMICapabilities setPhoneCallAvailable( Boolean available) {
 		setValue(KEY_PHONE_CALL, available);
 		return this;
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocationCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocationCapability.java
index 0a466a777..003e3095a 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocationCapability.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocationCapability.java
@@ -81,11 +81,12 @@ public class SeatLocationCapability extends RPCStruct {
     /**
      * Gets the seat locations of this capability
      * @return the seat locations
+     * @deprecated use {@link #getSeats()} instead.
      */
     @SuppressWarnings("unchecked")
     @Deprecated
     public List<SeatLocation> getSeatLocations() {
-        return (List<SeatLocation>) getObject(SeatLocation.class, KEY_SEATS);
+        return getSeats();
     }
 
     /**
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java
index 8170a8df8..b54d21491 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java
@@ -445,19 +445,34 @@ public class SubscribeVehicleDataResponse extends RPCResponse {
     public VehicleDataResult getEmergencyEvent() {

         return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EMERGENCY_EVENT);

     }

+

+    /**

+     * @deprecated use {@link #setClusterModes(VehicleDataResult clusterMode)} instead.

+     */

     @Deprecated

     public SubscribeVehicleDataResponse setClusterModeStatus( VehicleDataResult clusterModeStatus) {

-        setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);

-        return this;

+        return setClusterModes(clusterModeStatus);

     }

+    /**

+     * @deprecated use {@link #getClusterModes()} instead.

+     */

     @Deprecated

     public VehicleDataResult getClusterModeStatus() {

-        return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODE_STATUS);

+        return getClusterModes();

     }

+    /**

+     * Sets the status modes of the cluster

+     * @param clusterMode the status modes of the cluster

+     */

     public SubscribeVehicleDataResponse setClusterModes(VehicleDataResult clusterMode) {

         setParameters(KEY_CLUSTER_MODES, clusterMode);

         return this;

     }

+

+    /**

+     * Gets the status modes of the cluster

+     * @return The status modes of the cluster

+     */

     public VehicleDataResult getClusterModes() {

         return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODES);

     }

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java
index d5dcbf2e5..05b381191 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java
@@ -141,19 +141,34 @@ public class TireStatus extends RPCStruct {
 		setInnerRightRear(innerRightRear);

 	}

 

+    /**

+     * @deprecated use {@link #setPressureTelltale(WarningLightStatus pressureTellTale)} instead.

+     */

 	@Deprecated

     public TireStatus setPressureTellTale(@NonNull WarningLightStatus pressureTellTale) {

-        setValue(KEY_PRESSURE_TELL_TALE, pressureTellTale);

-        return this;

+        return setPressureTelltale(pressureTellTale);

     }

+    /**

+     * @deprecated use {@link #getPressureTelltale()} instead.

+     */

     @Deprecated

     public WarningLightStatus getPressureTellTale() {

-        return (WarningLightStatus) getObject(WarningLightStatus.class, KEY_PRESSURE_TELL_TALE);

+        return getPressureTelltale();

     }

+

+    /**

+     * Sets the status of the tire pressure Telltale.

+     * @param pressureTellTale the status of the tire pressure Telltale.

+     */

     public TireStatus setPressureTelltale(@NonNull WarningLightStatus pressureTellTale) {

         setValue(KEY_PRESSURE_TELL_TALE, pressureTellTale);

         return this;

     }

+

+    /**

+     * Gets the status of the tire pressure Telltale.

+     * @return the status of the tire pressure Telltale.

+     */

     public WarningLightStatus getPressureTelltale() {

         return (WarningLightStatus) getObject(WarningLightStatus.class, KEY_PRESSURE_TELL_TALE);

     }

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java
index 0829f53c5..075994cd9 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java
@@ -447,19 +447,32 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse {
     public VehicleDataResult getEmergencyEvent() {

         return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EMERGENCY_EVENT);

     }

+    /**

+     * @deprecated use {@link #setClusterModes(VehicleDataResult clusterMode)} instead.

+     */

     @Deprecated

     public UnsubscribeVehicleDataResponse setClusterModeStatus( VehicleDataResult clusterModeStatus) {

-        setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);

-        return this;

+        return setClusterModes(clusterModeStatus);

     }

+    /**

+     * @deprecated use {@link #getClusterModes()} instead.

+     */

     @Deprecated

     public VehicleDataResult getClusterModeStatus() {

-        return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODE_STATUS);

+        return getClusterModes();

     }

+    /**

+     * Sets the status modes of the cluster

+     * @param clusterMode the status modes of the cluster

+     */

     public UnsubscribeVehicleDataResponse setClusterModes(VehicleDataResult clusterMode) {

         setParameters(KEY_CLUSTER_MODES, clusterMode);

         return this;

     }

+    /**

+     * Gets the status modes of the cluster

+     * @return The status modes of the cluster

+     */

     public VehicleDataResult getClusterModes() {

         return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODES);

     }

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeWayPointsResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeWayPointsResponse.java
index 3df5e5c73..80c668821 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeWayPointsResponse.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeWayPointsResponse.java
@@ -62,11 +62,19 @@ public class UnsubscribeWayPointsResponse extends RPCResponse {
 		setResultCode(resultCode);
 	}
 
+	/**
+	 * Sets the way points location details
+	 * @param wayPoints the way points location details
+	 */
 	public UnsubscribeWayPointsResponse setWayPoints(List<LocationDetails> wayPoints) {
 		setParameters(KEY_WAY_POINTS, wayPoints);
 		return this;
 	}
 
+	/**
+	 * Gets the way points location details
+	 * @return the way points location details
+	 */
 	public List<LocationDetails> getWayPoints() {
 		return (List<LocationDetails>) getObject(LocationDetails.class, KEY_WAY_POINTS);
 	}
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java
index 7d97dfd1c..f6eaa6e5f 100644
--- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java
+++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java
@@ -92,21 +92,34 @@ public class VideoStreamingCapability extends RPCStruct {
 		return (List<VideoStreamingFormat>) getObject(VideoStreamingFormat.class, KEY_SUPPORTED_FORMATS);
 	}
 
+	/**
+	 * @deprecated use {@link #isHapticSpatialDataSupported()} instead.
+	 */
 	@Deprecated
 	public Boolean getIsHapticSpatialDataSupported() {
-		return getBoolean(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED);
+		return isHapticSpatialDataSupported();
 	}
 
+	/**
+	 * @deprecated use {@link #setHapticSpatialDataSupported(Boolean hapticSpatialDataSupported)} instead.
+	 */
 	@Deprecated
 	public VideoStreamingCapability setIsHapticSpatialDataSupported( Boolean hapticSpatialDataSupported) {
-        setValue(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED, hapticSpatialDataSupported);
-        return this;
+        return setHapticSpatialDataSupported(hapticSpatialDataSupported);
     }
 
+	/**
+	 * Gets whether the dead unit supports HapticSpatialData
+	 * @return True if the system can utilize the haptic spatial data from the source being streamed. If not included, it can be assumed the module doesn't support haptic spatial data.
+	 */
 	public Boolean isHapticSpatialDataSupported() {
 		return getBoolean(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED);
 	}
 
+	/**
+	 * Sets whether the dead unit supports HapticSpatialData
+	 * @param hapticSpatialDataSupported True if the system can utilize the haptic spatial data from the source being streamed. If not included, it can be assumed the module doesn't support haptic spatial data.
+	 */
 	public VideoStreamingCapability setHapticSpatialDataSupported( Boolean hapticSpatialDataSupported) {
 		setValue(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED, hapticSpatialDataSupported);
 		return this;