Skip to content

Commit 8d6261b

Browse files
bilal-alsharifibilal-alsharifi
committed
Add javadoc to new & deprecated methods
1 parent a62e035 commit 8d6261b

7 files changed

Lines changed: 96 additions & 17 deletions

File tree

‎base/src/main/java/com/smartdevicelink/proxy/rpc/HMICapabilities.java‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,19 @@ public boolean isNavigationAvailable(){
5959
return (Boolean)available;
6060
}
6161

62+
/**
63+
* @deprecated use {@link #setNavigationAvailable(Boolean available)} instead.
64+
*/
6265
@Deprecated
6366
public HMICapabilities setNavigationAvilable( Boolean available) {
64-
setValue(KEY_NAVIGATION, available);
65-
return this;
67+
return setNavigationAvailable(available);
6668
}
6769

70+
/**
71+
* Sets the navigationAvailable.
72+
*
73+
* @param available Availability of driver Navigation capability. True: Available, False: Not Available
74+
*/
6875
public HMICapabilities setNavigationAvailable(Boolean available) {
6976
setValue(KEY_NAVIGATION, available);
7077
return this;
@@ -78,12 +85,19 @@ public boolean isPhoneCallAvailable(){
7885
return (Boolean)available;
7986
}
8087

88+
/**
89+
* @deprecated use {@link #setPhoneCallAvailable(Boolean available)} instead.
90+
*/
8191
@Deprecated
8292
public HMICapabilities setPhoneCallAvilable( Boolean available) {
83-
setValue(KEY_PHONE_CALL, available);
84-
return this;
93+
return setPhoneCallAvailable(available);
8594
}
8695

96+
/**
97+
* Sets the PhoneCallAvailable.
98+
*
99+
* @param available Availability of PhoneCall capability. True: Available, False: Not Available
100+
*/
87101
public HMICapabilities setPhoneCallAvailable( Boolean available) {
88102
setValue(KEY_PHONE_CALL, available);
89103
return this;

‎base/src/main/java/com/smartdevicelink/proxy/rpc/SeatLocationCapability.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,12 @@ public SeatLocationCapability setSeats( List<SeatLocation> locations) {
8181
/**
8282
* Gets the seat locations of this capability
8383
* @return the seat locations
84+
* @deprecated use {@link #getSeats()} instead.
8485
*/
8586
@SuppressWarnings("unchecked")
8687
@Deprecated
8788
public List<SeatLocation> getSeatLocations() {
88-
return (List<SeatLocation>) getObject(SeatLocation.class, KEY_SEATS);
89+
return getSeats();
8990
}
9091

9192
/**

‎base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -445,19 +445,34 @@ public SubscribeVehicleDataResponse setEmergencyEvent( VehicleDataResult emergen
445445
public VehicleDataResult getEmergencyEvent() {
446446
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EMERGENCY_EVENT);
447447
}
448+
449+
/**
450+
* @deprecated use {@link #setClusterModes(VehicleDataResult clusterMode)} instead.
451+
*/
448452
@Deprecated
449453
public SubscribeVehicleDataResponse setClusterModeStatus( VehicleDataResult clusterModeStatus) {
450-
setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
451-
return this;
454+
return setClusterModes(clusterModeStatus);
452455
}
456+
/**
457+
* @deprecated use {@link #getClusterModes()} instead.
458+
*/
453459
@Deprecated
454460
public VehicleDataResult getClusterModeStatus() {
455-
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODE_STATUS);
461+
return getClusterModes();
456462
}
463+
/**
464+
* Sets the status modes of the cluster
465+
* @param clusterMode the status modes of the cluster
466+
*/
457467
public SubscribeVehicleDataResponse setClusterModes(VehicleDataResult clusterMode) {
458468
setParameters(KEY_CLUSTER_MODES, clusterMode);
459469
return this;
460470
}
471+
472+
/**
473+
* Gets the status modes of the cluster
474+
* @return The status modes of the cluster
475+
*/
461476
public VehicleDataResult getClusterModes() {
462477
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODES);
463478
}

‎base/src/main/java/com/smartdevicelink/proxy/rpc/TireStatus.java‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,19 +141,34 @@ public TireStatus(@NonNull WarningLightStatus pressureTellTale, @NonNull SingleT
141141
setInnerRightRear(innerRightRear);
142142
}
143143

144+
/**
145+
* @deprecated use {@link #setPressureTelltale(WarningLightStatus pressureTellTale)} instead.
146+
*/
144147
@Deprecated
145148
public TireStatus setPressureTellTale(@NonNull WarningLightStatus pressureTellTale) {
146-
setValue(KEY_PRESSURE_TELL_TALE, pressureTellTale);
147-
return this;
149+
return setPressureTelltale(pressureTellTale);
148150
}
151+
/**
152+
* @deprecated use {@link #getPressureTelltale()} instead.
153+
*/
149154
@Deprecated
150155
public WarningLightStatus getPressureTellTale() {
151-
return (WarningLightStatus) getObject(WarningLightStatus.class, KEY_PRESSURE_TELL_TALE);
156+
return getPressureTelltale();
152157
}
158+
159+
/**
160+
* Sets the status of the tire pressure Telltale.
161+
* @param pressureTellTale the status of the tire pressure Telltale.
162+
*/
153163
public TireStatus setPressureTelltale(@NonNull WarningLightStatus pressureTellTale) {
154164
setValue(KEY_PRESSURE_TELL_TALE, pressureTellTale);
155165
return this;
156166
}
167+
168+
/**
169+
* Gets the status of the tire pressure Telltale.
170+
* @return the status of the tire pressure Telltale.
171+
*/
157172
public WarningLightStatus getPressureTelltale() {
158173
return (WarningLightStatus) getObject(WarningLightStatus.class, KEY_PRESSURE_TELL_TALE);
159174
}

‎base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -447,19 +447,32 @@ public UnsubscribeVehicleDataResponse setEmergencyEvent( VehicleDataResult emerg
447447
public VehicleDataResult getEmergencyEvent() {
448448
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_EMERGENCY_EVENT);
449449
}
450+
/**
451+
* @deprecated use {@link #setClusterModes(VehicleDataResult clusterMode)} instead.
452+
*/
450453
@Deprecated
451454
public UnsubscribeVehicleDataResponse setClusterModeStatus( VehicleDataResult clusterModeStatus) {
452-
setParameters(KEY_CLUSTER_MODE_STATUS, clusterModeStatus);
453-
return this;
455+
return setClusterModes(clusterModeStatus);
454456
}
457+
/**
458+
* @deprecated use {@link #getClusterModes()} instead.
459+
*/
455460
@Deprecated
456461
public VehicleDataResult getClusterModeStatus() {
457-
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODE_STATUS);
462+
return getClusterModes();
458463
}
464+
/**
465+
* Sets the status modes of the cluster
466+
* @param clusterMode the status modes of the cluster
467+
*/
459468
public UnsubscribeVehicleDataResponse setClusterModes(VehicleDataResult clusterMode) {
460469
setParameters(KEY_CLUSTER_MODES, clusterMode);
461470
return this;
462471
}
472+
/**
473+
* Gets the status modes of the cluster
474+
* @return The status modes of the cluster
475+
*/
463476
public VehicleDataResult getClusterModes() {
464477
return (VehicleDataResult) getObject(VehicleDataResult.class, KEY_CLUSTER_MODES);
465478
}

‎base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeWayPointsResponse.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,19 @@ public UnsubscribeWayPointsResponse(@NonNull Boolean success, @NonNull Result re
6262
setResultCode(resultCode);
6363
}
6464

65+
/**
66+
* Sets the way points location details
67+
* @param wayPoints the way points location details
68+
*/
6569
public UnsubscribeWayPointsResponse setWayPoints(List<LocationDetails> wayPoints) {
6670
setParameters(KEY_WAY_POINTS, wayPoints);
6771
return this;
6872
}
6973

74+
/**
75+
* Gets the way points location details
76+
* @return the way points location details
77+
*/
7078
public List<LocationDetails> getWayPoints() {
7179
return (List<LocationDetails>) getObject(LocationDetails.class, KEY_WAY_POINTS);
7280
}

‎base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,34 @@ public List<VideoStreamingFormat> getSupportedFormats(){
9292
return (List<VideoStreamingFormat>) getObject(VideoStreamingFormat.class, KEY_SUPPORTED_FORMATS);
9393
}
9494

95+
/**
96+
* @deprecated use {@link #isHapticSpatialDataSupported()} instead.
97+
*/
9598
@Deprecated
9699
public Boolean getIsHapticSpatialDataSupported() {
97-
return getBoolean(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED);
100+
return isHapticSpatialDataSupported();
98101
}
99102

103+
/**
104+
* @deprecated use {@link #setHapticSpatialDataSupported(Boolean hapticSpatialDataSupported)} instead.
105+
*/
100106
@Deprecated
101107
public VideoStreamingCapability setIsHapticSpatialDataSupported( Boolean hapticSpatialDataSupported) {
102-
setValue(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED, hapticSpatialDataSupported);
103-
return this;
108+
return setHapticSpatialDataSupported(hapticSpatialDataSupported);
104109
}
105110

111+
/**
112+
* Gets whether the dead unit supports HapticSpatialData
113+
* @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.
114+
*/
106115
public Boolean isHapticSpatialDataSupported() {
107116
return getBoolean(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED);
108117
}
109118

119+
/**
120+
* Sets whether the dead unit supports HapticSpatialData
121+
* @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.
122+
*/
110123
public VideoStreamingCapability setHapticSpatialDataSupported( Boolean hapticSpatialDataSupported) {
111124
setValue(KEY_HAPTIC_SPATIAL_DATA_SUPPORTED, hapticSpatialDataSupported);
112125
return this;

0 commit comments

Comments
 (0)