diff options
| author | Noah Stanford <noah@livio.io> | 2022-01-11 17:58:27 -0500 |
|---|---|---|
| committer | Noah Stanford <noah@livio.io> | 2022-01-11 17:58:27 -0500 |
| commit | b232716fa7b03d60731c9c34f04b8f6d4a6b4b3d (patch) | |
| tree | 07ec47456334830edfaa19938aa1180cce0e1f48 | |
| parent | b2bf54232e955080e6a969d7ee5b770c86a1ee87 (diff) | |
| download | sdl_android-cleanup/proposal_sdl_0286_spacing.tar.gz | |
Revert out of scope changescleanup/proposal_sdl_0286_spacing
120 files changed, 4403 insertions, 4430 deletions
diff --git a/android/sdl_android/src/androidTest/java/com/smartdevicelink/transport/TransportBrokerTest.java b/android/sdl_android/src/androidTest/java/com/smartdevicelink/transport/TransportBrokerTest.java index b2e90c246..977bb3020 100644 --- a/android/sdl_android/src/androidTest/java/com/smartdevicelink/transport/TransportBrokerTest.java +++ b/android/sdl_android/src/androidTest/java/com/smartdevicelink/transport/TransportBrokerTest.java @@ -24,7 +24,7 @@ import static junit.framework.TestCase.assertTrue; @RunWith(AndroidJUnit4.class) public class TransportBrokerTest { //FIXME this test class needs to be fixed. At this point these tests are not helpful RouterServiceValidator rsvp; - // public TransportBrokerThread(Context context, String appId, ComponentName service){ + // public TransportBrokerThread(Context context, String appId, ComponentName service){ @Before public void setUp() throws Exception { diff --git a/android/sdl_android/src/main/java/com/smartdevicelink/transport/RouterServiceValidator.java b/android/sdl_android/src/main/java/com/smartdevicelink/transport/RouterServiceValidator.java index 81f91bd0f..e29ebf1d3 100644 --- a/android/sdl_android/src/main/java/com/smartdevicelink/transport/RouterServiceValidator.java +++ b/android/sdl_android/src/main/java/com/smartdevicelink/transport/RouterServiceValidator.java @@ -233,8 +233,8 @@ public class RouterServiceValidator { * @param context */ //private void retrieveBestRouterServiceName(Context context) { - // FindRouterTask task = new FindRouterTask(null); - // task.execute(context); + // FindRouterTask task = new FindRouterTask(null); + // task.execute(context); //} /** diff --git a/android/sdl_android/src/main/java/com/smartdevicelink/transport/SdlRouterService.java b/android/sdl_android/src/main/java/com/smartdevicelink/transport/SdlRouterService.java index 63defad61..70790e1b5 100644 --- a/android/sdl_android/src/main/java/com/smartdevicelink/transport/SdlRouterService.java +++ b/android/sdl_android/src/main/java/com/smartdevicelink/transport/SdlRouterService.java @@ -1692,9 +1692,9 @@ public class SdlRouterService extends Service { } /** - * 1. If the app has SDL shut off, shut down - * 2. if The app has an Alt Transport address or was started by one, stay open - * 3. If Bluetooth is off/NA shut down + * 1. If the app has SDL shut off, shut down + * 2. if The app has an Alt Transport address or was started by one, stay open + * 3. If Bluetooth is off/NA shut down * 4. Anything else */ public boolean shouldServiceRemainOpen(Intent intent) { diff --git a/base/src/main/java/com/smartdevicelink/managers/screen/PresentAlertOperation.java b/base/src/main/java/com/smartdevicelink/managers/screen/PresentAlertOperation.java index 29db76742..2b1f249cb 100644 --- a/base/src/main/java/com/smartdevicelink/managers/screen/PresentAlertOperation.java +++ b/base/src/main/java/com/smartdevicelink/managers/screen/PresentAlertOperation.java @@ -62,7 +62,7 @@ import java.util.Map; /** * Operation that handles uploading images and audio data needed by the alert and, once the data uploads are complete, sending the alert. - * + * * Created by Julian Kast on 12/10/20. */ public class PresentAlertOperation extends Task { diff --git a/base/src/main/java/com/smartdevicelink/protocol/SdlProtocolBase.java b/base/src/main/java/com/smartdevicelink/protocol/SdlProtocolBase.java index fcee5a80f..f7dd797d0 100644 --- a/base/src/main/java/com/smartdevicelink/protocol/SdlProtocolBase.java +++ b/base/src/main/java/com/smartdevicelink/protocol/SdlProtocolBase.java @@ -1566,7 +1566,7 @@ public class SdlProtocolBase { * This method will return copy of active transports * * @return a list of active transports - */ + * */ public List<TransportRecord> getActiveTransports() { List<TransportRecord> records = new ArrayList<>(); for (TransportRecord record : activeTransports.values()) { diff --git a/base/src/main/java/com/smartdevicelink/protocol/enums/MessageType.java b/base/src/main/java/com/smartdevicelink/protocol/enums/MessageType.java index f880e1e69..9e7defe79 100644 --- a/base/src/main/java/com/smartdevicelink/protocol/enums/MessageType.java +++ b/base/src/main/java/com/smartdevicelink/protocol/enums/MessageType.java @@ -33,10 +33,10 @@ package com.smartdevicelink.protocol.enums; public enum MessageType { - // START_SESSION, -// START_SESSION_ACK, -// START_SESSION_NACK, -// END_SESSION, + // START_SESSION, +// START_SESSION_ACK, +// START_SESSION_NACK, +// END_SESSION, UNDEFINED, BULK, RPC; diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java index d2a68ff74..3458e361a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java @@ -69,45 +69,45 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>cmdID</td>
- * <td> Integer</td>
- * <td>unique ID of the command to add</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>cmdID</td>
+ * <td> Integer</td>
+ * <td>unique ID of the command to add</td>
* <td>Y</td>
- * <td> minvalue:0; maxvalue:2000000000</td>
- * <td>SmartDeviceLink 1.0</td>
- * <tr>
- * <td>menuParams</td>
- * <td>ButtonName</td>
- * <td>Name of the button to unsubscribe.</td>
+ * <td> minvalue:0; maxvalue:2000000000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * <tr>
+ * <td>menuParams</td>
+ * <td>ButtonName</td>
+ * <td>Name of the button to unsubscribe.</td>
* <td>Y</td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>vrCommands</td>
- * <td>String</td>
- * <td><p>An array of strings to be used as VR synonyms for this command.</p> <p>If this array is provided, it may not be empty.</p></td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>vrCommands</td>
+ * <td>String</td>
+ * <td><p>An array of strings to be used as VR synonyms for this command.</p> <p>If this array is provided, it may not be empty.</p></td>
* <td>N</td>
- * <td>minsize:1; maxsize:100</td>
- * <td>SmartDeviceLink 1.0</td>
- * <tr>
- * <td>cmdIcon</td>
- * <td>Image</td>
- * <td><p>Image struct determining whether static or dynamic icon.</p><p>If omitted on supported displays, no (or the default if applicable) icon shall be displayed.</p></td>
+ * <td>minsize:1; maxsize:100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * <tr>
+ * <td>cmdIcon</td>
+ * <td>Image</td>
+ * <td><p>Image struct determining whether static or dynamic icon.</p><p>If omitted on supported displays, no (or the default if applicable) icon shall be displayed.</p></td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
* <td>secondaryImage</td>
* <td>Image</td>
* <td>Optional secondary image struct for menu cell</td>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java index abfd3a3d1..93c5f0719 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java @@ -50,62 +50,62 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>menuID</td>
- * <td>Integer</td>
- * <td>Unique ID that identifies this sub menu. This value is used in AddCommand to which SubMenu is the parent of the command being added.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>menuID</td>
+ * <td>Integer</td>
+ * <td>Unique ID that identifies this sub menu. This value is used in AddCommand to which SubMenu is the parent of the command being added.</td>
* <td>Y</td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>position</td>
- * <td>Integer</td>
- * <td>Position within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>position</td>
+ * <td>Integer</td>
+ * <td>Position within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.</td>
* <td>N</td>
- * <td>Min Value: 0 <p>Max Value: 1000</p> <p>If position is greater or equal than the number of items on top level, the sub menu will be appended by the end.</p><p>If this parameter is omitted, the entry will be added at the end of the list.</P></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>menuName</td>
- * <td>String</td>
- * <td>Text which is displayed representing this submenu item</td>
+ * <td>Min Value: 0 <p>Max Value: 1000</p> <p>If position is greater or equal than the number of items on top level, the sub menu will be appended by the end.</p><p>If this parameter is omitted, the entry will be added at the end of the list.</P></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuName</td>
+ * <td>String</td>
+ * <td>Text which is displayed representing this submenu item</td>
* <td>Y</td>
- * <td>maxlength:500</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>menuIcon</td>
- * <td>Image</td>
- * <td>Image to be be shown along with the submenu item</td>
+ * <td>maxlength:500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuIcon</td>
+ * <td>Image</td>
+ * <td>Image to be be shown along with the submenu item</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
- * <td>menuLayout</td>
- * <td>MenuLayout</td>
- * <td>Sets the layout of the submenu screen.</td>
- * <td></td>
- * <td></td>
- * <td>SmartDeviceLink 6.0</td>
- * </tr>
- * <tr>
- * <td>parentID</td>
- * <td>Integer</td>
- * <td>unique ID of the sub menu, the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu.</td>
- * <td>N</td>
- * <td>Min Value: 0 <p>Max Value: 2000000000</p> </td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuLayout</td>
+ * <td>MenuLayout</td>
+ * <td>Sets the layout of the submenu screen.</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 6.0</td>
+ * </tr>
+ * <tr>
+ * <td>parentID</td>
+ * <td>Integer</td>
+ * <td>unique ID of the sub menu, the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu.</td>
+ * <td>N</td>
+ * <td>Min Value: 0 <p>Max Value: 2000000000</p> </td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
* <tr>
* <td>secondaryText</td>
* <td>String</td>
@@ -332,7 +332,7 @@ public class AddSubMenu extends RPCRequest { * Sets the secondaryText.
*
* @param secondaryText Optional secondary text to display
- * {"string_min_length": 1, "string_max_length": 500}
+ * {"string_min_length": 1, "string_max_length": 500}
* @since SmartDeviceLink 7.1.0
*/
public AddSubMenu setSecondaryText(String secondaryText) {
@@ -355,7 +355,7 @@ public class AddSubMenu extends RPCRequest { * Sets the tertiaryText.
*
* @param tertiaryText Optional tertiary text to display
- * {"string_min_length": 1, "string_max_length": 500}
+ * {"string_min_length": 1, "string_max_length": 500}
* @since SmartDeviceLink 7.1.0
*/
public AddSubMenu setTertiaryText(String tertiaryText) {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java index 5f037bb3d..34930fe4d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java @@ -45,60 +45,60 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Version.</th>
- * </tr>
- * <tr>
- * <td>driverAirbagDeployed </td>
- * <td>VehicleDataEventStatus</td>
- * <td>Status of driver airbag.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>driverSideAirbagDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>Status of driver side airbag.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>driverCurtainAirbagDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>Status of driver curtain airbag.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>passengerAirbagDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>Status of passenger airbag.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>passengerCurtainAirbagDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>Status of passenger curtain airbag.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>driverKneeAirbagDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>Status of driver knee airbag.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>passengerSideAirbagDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>Status of passenger side airbag.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>passengerKneeAirbagDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>Status of passenger knee airbag</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Version.</th>
+ * </tr>
+ * <tr>
+ * <td>driverAirbagDeployed </td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of driver airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverSideAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of driver side airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverCurtainAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of driver curtain airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>passengerAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of passenger airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>passengerCurtainAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of passenger curtain airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverKneeAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of driver knee airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>passengerSideAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of passenger side airbag.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>passengerKneeAirbagDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>Status of passenger knee airbag</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
*
* </table>
*
@@ -106,7 +106,7 @@ import java.util.Hashtable; * If a resultCode of "SUCCESS" is returned, the request was accepted by SDL. By the time the corresponding response is received, the Alert will have completed.
*
* <p><b> Non-default Result Codes:</b></p>
- * <p>REJECTED</p><p> ABORTED</P>
+ * <p>REJECTED</p><p> ABORTED</P>
*
* @see Image
* @see SubscribeVehicleData
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java index 133ee678a..2dda0037c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java @@ -66,94 +66,94 @@ import java.util.List; * <b>If the app has been granted function group Notification the HMILevel can
* also be BACKGROUND</b>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>alertText1</td>
- * <td>String</td>
- * <td>Text to be displayed in the first field of the display during the Alert. </td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>alertText1</td>
+ * <td>String</td>
+ * <td>Text to be displayed in the first field of the display during the Alert. </td>
* <td>N</td>
- * <td>Length is limited to what is indicated in RegisterAppInterface response. If omitted, top display line will be cleared. Text is always centered</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>alertText2</td>
- * <td>String</td>
- * <td>Text to be displayed in the second field of the display during the Alert. </td>
+ * <td>Length is limited to what is indicated in RegisterAppInterface response. If omitted, top display line will be cleared. Text is always centered</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>alertText2</td>
+ * <td>String</td>
+ * <td>Text to be displayed in the second field of the display during the Alert. </td>
* <td>N</td>
- * <td>Only permitted if HMI supports a second display line. Length is limited to what is indicated in RegisterAppInterface response. If omitted, second display line will be cleared. </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>alertText3</td>
- * <td>String</td>
- * <td>Text to be displayed in the third field of the display during the Alert.</td>
+ * <td>Only permitted if HMI supports a second display line. Length is limited to what is indicated in RegisterAppInterface response. If omitted, second display line will be cleared. </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>alertText3</td>
+ * <td>String</td>
+ * <td>Text to be displayed in the third field of the display during the Alert.</td>
* <td>N</td>
- * <td>Array must have a least one element. </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>ttsChunks</td>
- * <td>TTSChunk[]</td>
- * <td>Array of type TTSChunk which, taken together, specify what is to be spoken to the user.</td>
+ * <td>Array must have a least one element. </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>ttsChunks</td>
+ * <td>TTSChunk[]</td>
+ * <td>Array of type TTSChunk which, taken together, specify what is to be spoken to the user.</td>
* <td>N</td>
- * <td>Array must have a least one element. </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>duration</td>
- * <td>Integer</td>
- * <td>The duration of the displayed portion of the alert, in milliseconds. After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.</td>
+ * <td>Array must have a least one element. </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>duration</td>
+ * <td>Integer</td>
+ * <td>The duration of the displayed portion of the alert, in milliseconds. After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.</td>
* <td>N</td>
- * <td>Min Value: 3000 Max Value: 10000. If omitted, the default is 5000 milliseconds</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>playTone</td>
- * <td>Boolean</td>
- * <td>Specifies whether the alert tone should be played before the TTS (if any) is spoken.</td>
+ * <td>Min Value: 3000 Max Value: 10000. If omitted, the default is 5000 milliseconds</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>playTone</td>
+ * <td>Boolean</td>
+ * <td>Specifies whether the alert tone should be played before the TTS (if any) is spoken.</td>
* <td>N</td>
- * <td>If omitted, default is true.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>softButtons</td>
- * <td>SoftButton[]</td>
- * <td>Specifies the soft buttons, the apps wants to use in this alert.</td>
+ * <td>If omitted, default is true.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>softButtons</td>
+ * <td>SoftButton[]</td>
+ * <td>Specifies the soft buttons, the apps wants to use in this alert.</td>
* <td>N</td>
- * <td>If omitted on supported displays, the alert will not have any SoftButton.ArrayMin: 0; ArrayMax: 4</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>progressIndicator</td>
- * <td>Boolean</td>
- * <td>If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.</td>
- * <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>cancelID</td>
- * <td>Integer</td>
- * <td>An ID for this specific alert to allow cancellation through the `CancelInteraction` RPC.</td>
+ * <td>If omitted on supported displays, the alert will not have any SoftButton.ArrayMin: 0; ArrayMax: 4</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>progressIndicator</td>
+ * <td>Boolean</td>
+ * <td>If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>cancelID</td>
+ * <td>Integer</td>
+ * <td>An ID for this specific alert to allow cancellation through the `CancelInteraction` RPC.</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 6.0</td>
- * </tr>
- * <tr>
- * <td>alertIcon</td>
- * <td>Image</td>
- * <td>Image struct determining whether the icon is static or dynamic. If omitted on supported displays, no (or the default if applicable) icon should be displayed.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 6.0</td>
+ * </tr>
+ * <tr>
+ * <td>alertIcon</td>
+ * <td>Image</td>
+ * <td>Image struct determining whether the icon is static or dynamic. If omitted on supported displays, no (or the default if applicable) icon should be displayed.</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 6.0.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 6.0.0</td>
+ * </tr>
* </table>
*
* @see GetVehicleData
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppCapability.java index 2190c9ffb..213a4a758 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AppCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AppCapability.java @@ -39,6 +39,7 @@ import com.smartdevicelink.proxy.rpc.enums.AppCapabilityType; import java.util.Hashtable; /** + * * <p><b>Parameter List</b></p> * * <table border="1" rules="all"> @@ -67,7 +68,6 @@ import java.util.Hashtable; * <td></td> * </tr> * </table> - * * @since SmartDeviceLink 7.1.0 */ public class AppCapability extends RPCStruct { @@ -77,8 +77,7 @@ public class AppCapability extends RPCStruct { /** * Constructs a new AppCapability object */ - public AppCapability() { - } + public AppCapability() { } /** * Constructs a new AppCapability object indicated by the Hashtable parameter @@ -93,7 +92,7 @@ public class AppCapability extends RPCStruct { * Constructs a new AppCapability object * * @param appCapabilityType Used as a descriptor of what data to expect in this struct. The corresponding param to - * this enum should be included and the only other param included. + * this enum should be included and the only other param included. */ public AppCapability(@NonNull AppCapabilityType appCapabilityType) { this(); @@ -104,7 +103,7 @@ public class AppCapability extends RPCStruct { * Sets the appCapabilityType. * * @param appCapabilityType Used as a descriptor of what data to expect in this struct. The corresponding param to - * this enum should be included and the only other param included. + * this enum should be included and the only other param included. */ public AppCapability setAppCapabilityType(@NonNull AppCapabilityType appCapabilityType) { setValue(KEY_APP_CAPABILITY_TYPE, appCapabilityType); diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java index 00d36f95a..701057d35 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java @@ -46,33 +46,33 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>samplingRate</td>
- * <td>SamplingRate</td>
- * <td>Describes the sampling rate for AudioPassThru
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>bitsPerSample</td>
- * <td>BitsPerSample</td>
- * <td>Describes the sample depth in bit for AudioPassThru
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>audioType</td>
- * <td>AudioType</td>
- * <td>Describes the audioType for AudioPassThru
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>samplingRate</td>
+ * <td>SamplingRate</td>
+ * <td>Describes the sampling rate for AudioPassThru
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>bitsPerSample</td>
+ * <td>BitsPerSample</td>
+ * <td>Describes the sample depth in bit for AudioPassThru
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>audioType</td>
+ * <td>AudioType</td>
+ * <td>Describes the audioType for AudioPassThru
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java index 5387645de..9c8060ea4 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java @@ -44,102 +44,102 @@ import java.util.Hashtable; * <p><b>Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Mandatory</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td>driverBeltDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The driver seat belt is deployed.</td>
- * </tr>
- * <tr>
- * <td>passengerBeltDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The passenger seat belt is deployed.</td>
- * </tr>
- * <tr>
- * <td>passengerBuckleBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The passenger seat belt is buckled.</td>
- * </tr>
- * <tr>
- * <td>driverBuckleBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The driver seat belt is buckled.</td>
- * </tr>
- * <tr>
- * <td>leftRow2BuckleBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The left seat belt of the 2nd row is buckled.</td>
- * </tr>
- * <tr>
- * <td>passengerChildDetected</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The child passenger is detected.</td>
- * </tr>
- * <tr>
- * <td>rightRow2BuckleBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The right seat belt of the 2nd row is buckled.</td>
- * </tr>
- * <tr>
- * <td>middleRow2BuckleBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The middle seat belt of the 2nd row is buckled.</td>
- * </tr>
- * <tr>
- * <td>middleRow3BuckleBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The middle seat belt of the 3rd row is buckled.</td>
- * </tr>
- * <tr>
- * <td>leftRow3BuckleBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The left seat belt of the 3rd row is buckled.</td>
- * </tr>
- * <tr>
- * <td>rightRow3BuckleBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The right seat belt of the 3rd row is buckled.</td>
- * </tr>
- * <tr>
- * <td>leftRearInflatableBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The left rear inflatable is belted.</td>
- * </tr>
- * <tr>
- * <td>rightRearInflatableBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The right rear inflatable is belted.</td>
- * </tr>
- * <tr>
- * <td>middleRow1BeltDeployed</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The seat belt of the middle row is deployed.</td>
- * </tr>
- * <tr>
- * <td>middleRow1BuckleBelted</td>
- * <td>VehicleDataEventStatus</td>
- * <td>false</td>
- * <td>The seat belt of the middle row is buckled.</td>
- * </tr>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>driverBeltDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The driver seat belt is deployed.</td>
+ * </tr>
+ * <tr>
+ * <td>passengerBeltDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The passenger seat belt is deployed.</td>
+ * </tr>
+ * <tr>
+ * <td>passengerBuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The passenger seat belt is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>driverBuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The driver seat belt is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>leftRow2BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The left seat belt of the 2nd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>passengerChildDetected</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The child passenger is detected.</td>
+ * </tr>
+ * <tr>
+ * <td>rightRow2BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The right seat belt of the 2nd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>middleRow2BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The middle seat belt of the 2nd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>middleRow3BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The middle seat belt of the 3rd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>leftRow3BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The left seat belt of the 3rd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>rightRow3BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The right seat belt of the 3rd row is buckled.</td>
+ * </tr>
+ * <tr>
+ * <td>leftRearInflatableBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The left rear inflatable is belted.</td>
+ * </tr>
+ * <tr>
+ * <td>rightRearInflatableBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The right rear inflatable is belted.</td>
+ * </tr>
+ * <tr>
+ * <td>middleRow1BeltDeployed</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The seat belt of the middle row is deployed.</td>
+ * </tr>
+ * <tr>
+ * <td>middleRow1BuckleBelted</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td>false</td>
+ * <td>The seat belt of the middle row is buckled.</td>
+ * </tr>
* </table>
*
* @see VehicleDataEventStatus
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java index 799bb6b78..62a006abe 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java @@ -47,111 +47,111 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Mandatory</th>
- * <th>Description</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>parkBrakeActive</td>
- * <td>Boolean</td>
- * <td>true</td>
- * <td>Describes, if the park break is active. The information about the park brake: - true, if active - false if not.</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>ignitionStableStatus</td>
- * <td>IgnitionStableStatus</td>
- * <td>true</td>
- * <td>Describes, if the ignition situation is considered stableThe information about stability of the ignition switch. See {@linkplain IgnitionStableStatus}</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>ignitionStatus</td>
- * <td>IgnitionStatus</td>
- * <td>true</td>
- * <td>The information about ignition status. See {@linkplain IgnitionStatus}</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>parkBrakeActive</td>
- * <td>Boolean</td>
- * <td>true</td>
- * <td>The information about the park brake: - true, if active - false if not.</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>driverDoorAjar</td>
- * <td>Boolean</td>
- * <td>true</td>
- * <td>The information about the park brake: - true, if active - false if not.</td>
- * <td>
- * @since SmartDeviceLink 2.0.0
- * @property-deprecated in SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>passengerDoorAjar</td>
- * <td>Boolean</td>
- * <td>true</td>
- * <td>The information about the park brake: - true, if active - false if not.</td>
- * <td>
- * @since SmartDeviceLink 2.0.0
- * @property-deprecated in SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>rearLeftDoorAjar</td>
- * <td>Boolean</td>
- * <td>true</td>
- * <td>The information about the park brake: - true, if active - false if not.</td>
- * <td>
- * @since SmartDeviceLink 2.0.0
- * @property-deprecated in SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>rearRightDoorAjar</td>
- * <td>Boolean</td>
- * <td>true</td>
- * <td>References signal "DrStatRr_B_Actl".</td>
- * <td>
- * @since SmartDeviceLink 2.0.0
- * @property-deprecated in SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>doorStatuses</td>
- * <td>List<DoorStatus></td>
- * <td>Provides status for doors if Ajar/Closed/Locked</td>
- * <td>N</td>
- * <td>{"array_min_size": 0, "array_max_size": 100}</td>
- * <td>
- * @since SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>gateStatuses</td>
- * <td>List<GateStatus></td>
- * <td>Provides status for trunk/hood/etc. if Ajar/Closed/Locked</td>
- * <td>N</td>
- * <td>{"array_min_size": 0, "array_max_size": 100}</td>
- * <td>
- * @since SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>roofStatuses</td>
- * <td>List<RoofStatus></td>
- * <td>Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removedetc.</td>
- * <td>N</td>
- * <td>{"array_min_size": 0, "array_max_size": 100}</td>
- * <td>
- * @since SmartDeviceLink 7.1.0
- * </td>
- * </tr>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>parkBrakeActive</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>Describes, if the park break is active. The information about the park brake: - true, if active - false if not.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>ignitionStableStatus</td>
+ * <td>IgnitionStableStatus</td>
+ * <td>true</td>
+ * <td>Describes, if the ignition situation is considered stableThe information about stability of the ignition switch. See {@linkplain IgnitionStableStatus}</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>ignitionStatus</td>
+ * <td>IgnitionStatus</td>
+ * <td>true</td>
+ * <td>The information about ignition status. See {@linkplain IgnitionStatus}</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>parkBrakeActive</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>The information about the park brake: - true, if active - false if not.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverDoorAjar</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>The information about the park brake: - true, if active - false if not.</td>
+ * <td>
+ * @since SmartDeviceLink 2.0.0
+ * @property-deprecated in SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>passengerDoorAjar</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>The information about the park brake: - true, if active - false if not.</td>
+ * <td>
+ * @since SmartDeviceLink 2.0.0
+ * @property-deprecated in SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>rearLeftDoorAjar</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>The information about the park brake: - true, if active - false if not.</td>
+ * <td>
+ * @since SmartDeviceLink 2.0.0
+ * @property-deprecated in SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>rearRightDoorAjar</td>
+ * <td>Boolean</td>
+ * <td>true</td>
+ * <td>References signal "DrStatRr_B_Actl".</td>
+ * <td>
+ * @since SmartDeviceLink 2.0.0
+ * @property-deprecated in SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>doorStatuses</td>
+ * <td>List<DoorStatus></td>
+ * <td>Provides status for doors if Ajar/Closed/Locked</td>
+ * <td>N</td>
+ * <td>{"array_min_size": 0, "array_max_size": 100}</td>
+ * <td>
+ * @since SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>gateStatuses</td>
+ * <td>List<GateStatus></td>
+ * <td>Provides status for trunk/hood/etc. if Ajar/Closed/Locked</td>
+ * <td>N</td>
+ * <td>{"array_min_size": 0, "array_max_size": 100}</td>
+ * <td>
+ * @since SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>roofStatuses</td>
+ * <td>List<RoofStatus></td>
+ * <td>Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removedetc.</td>
+ * <td>N</td>
+ * <td>{"array_min_size": 0, "array_max_size": 100}</td>
+ * <td>
+ * @since SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
* </table>
*
* @see SubscribeVehicleData
@@ -353,7 +353,7 @@ public class BodyInformation extends RPCStruct { * Sets the doorStatuses.
*
* @param doorStatuses Provides status for doors if Ajar/Closed/Locked
- * {"array_min_size": 0, "array_max_size": 100}
+ * {"array_min_size": 0, "array_max_size": 100}
* @since SmartDeviceLink 7.1.0
*/
public BodyInformation setDoorStatuses(List<DoorStatus> doorStatuses) {
@@ -377,7 +377,7 @@ public class BodyInformation extends RPCStruct { * Sets the gateStatuses.
*
* @param gateStatuses Provides status for trunk/hood/etc. if Ajar/Closed/Locked
- * {"array_min_size": 0, "array_max_size": 100}
+ * {"array_min_size": 0, "array_max_size": 100}
* @since SmartDeviceLink 7.1.0
*/
public BodyInformation setGateStatuses(List<GateStatus> gateStatuses) {
@@ -401,8 +401,8 @@ public class BodyInformation extends RPCStruct { * Sets the roofStatuses.
*
* @param roofStatuses Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removed
- * etc.
- * {"array_min_size": 0, "array_max_size": 100}
+ * etc.
+ * {"array_min_size": 0, "array_max_size": 100}
* @since SmartDeviceLink 7.1.0
*/
public BodyInformation setRoofStatuses(List<RoofStatus> roofStatuses) {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java index 77cedf2e3..8895528af 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java @@ -42,43 +42,43 @@ import java.util.Hashtable; * Provides information about the capabilities of a SDL HMI button.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>name</td>
- * <td>ButtonName</td>
- * <td>The name of theSDL HMI button.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>shortPressAvailable</td>
- * <td>Boolean</td>
- * <td>The button supports a SHORT press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>name</td>
+ * <td>ButtonName</td>
+ * <td>The name of theSDL HMI button.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>shortPressAvailable</td>
+ * <td>Boolean</td>
+ * <td>The button supports a SHORT press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* <tr>
- * <td>longPressAvailable</td>
- * <td>Boolean</td>
- * <td>The button supports a LONG press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>longPressAvailable</td>
+ * <td>Boolean</td>
+ * <td>The button supports a LONG press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* <tr>
- * <td>upDownAvailable</td>
- * <td>Boolean</td>
- * <td>The button supports "button down" and "button up". When the button is depressed, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONDOWN.
+ * <td>upDownAvailable</td>
+ * <td>Boolean</td>
+ * <td>The button supports "button down" and "button up". When the button is depressed, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONDOWN.
* <p> When the button is released, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONUP.</p></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*
* <p>Upon the request HMI must provide the list of the following information:</p>
- * <p>The names of all existing/supported hardware buttons.</p>
- * <p>The availability of LONG/SHORT press for each existing/supported hardware button correspondingly</p>
- * <p>The availability of UP/DOWN events for each existing/supported hardware button correspondingly.</p>
+ * <p>The names of all existing/supported hardware buttons.</p>
+ * <p>The availability of LONG/SHORT press for each existing/supported hardware button correspondingly</p>
+ * <p>The availability of UP/DOWN events for each existing/supported hardware button correspondingly.</p>
*
* @see ButtonName
* @see com.smartdevicelink.proxy.rpc.enums.ButtonEventMode
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java index b7f06c160..bccb69908 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java @@ -56,75 +56,75 @@ import java.util.List; * <p><b> Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>Language</td>
- * <td>Language</td>
- * <td>Requested SDL voice engine (VR+TTS) language registration.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>Language</td>
+ * <td>Language</td>
+ * <td>Requested SDL voice engine (VR+TTS) language registration.</td>
* <td>Y</td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>hmiDisplayLanguage</td>
- * <td>Language</td>
- * <td>Request display language registration.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>hmiDisplayLanguage</td>
+ * <td>Language</td>
+ * <td>Request display language registration.</td>
* <td>Y</td>
- * <td>Minvalue=0; Maxvalue=2000000000</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>Minvalue=0; Maxvalue=2000000000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
* <tr>
- * <td>appName</td>
- * <td>String</td>
- * <td>Request new app name registration</td>
+ * <td>appName</td>
+ * <td>String</td>
+ * <td>Request new app name registration</td>
* <td>N</td>
* <td>maxlength:100</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>ttsName</td>
- * <td>TTSChunk</td>
- * <td>Request new ttsName registration</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>ttsName</td>
+ * <td>TTSChunk</td>
+ * <td>Request new ttsName registration</td>
* <td>N</td>
* <td>minsize:1; maxsize:100</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* <tr>
- * <td>ngnMediaScreenAppName</td>
- * <td>String</td>
- * <td>Request new app short name registration</td>
+ * <td>ngnMediaScreenAppName</td>
+ * <td>String</td>
+ * <td>Request new app short name registration</td>
* <td>N</td>
* <td>maxlength: 100</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>vrSynonyms</td>
- * <td>String</td>
- * <td>Request new VR synonyms registration</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>vrSynonyms</td>
+ * <td>String</td>
+ * <td>Request new VR synonyms registration</td>
* <td>N</td>
* <td>maxlength: 40; minsize:1; maxsize:100</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* <p><b>Response </b></p>
*
* <p><b>Non-default Result Codes:</b></p>
- * <p>SUCCESS</p>
- * <p>INVALID_DATA</p>
- * <p>OUT_OF_MEMORY</p>
- * <p> TOO_MANY_PENDING_REQUESTS</p>
- * <p>APPLICATION_NOT_REGISTERED</p>
- * <p>GENERIC_ERROR</p>
- * <p>REJECTED</p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
* <p>DISALLOWED</p>
*
* @see RegisterAppInterface
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java index 2588719bc..30e00e663 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java @@ -45,42 +45,42 @@ import java.util.List; * For example, the application may request for the user`s choice among several suggested ones: Yes, No, Skip.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>choiceID</td>
- * <td>Integer</td>
- * <td>Application-scoped identifier that uniquely identifies this choice.
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>choiceID</td>
+ * <td>Integer</td>
+ * <td>Application-scoped identifier that uniquely identifies this choice.
* Min: 0;
- * Max: 65535
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>menuName</td>
- * <td>String</td>
- * <td>Text which appears in menu, representing this choice.
- * Min: 1;
- * Max: 100
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * Max: 65535
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuName</td>
+ * <td>String</td>
+ * <td>Text which appears in menu, representing this choice.
+ * Min: 1;
+ * Max: 100
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* <tr>
- * <td>vrCommands</td>
- * <td>String[]</td>
- * <td>An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>vrCommands</td>
+ * <td>String[]</td>
+ * <td>An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* <tr>
- * <td>image</td>
- * <td>Image</td>
- * <td>Either a static hex icon value or a binary image file name identifier (sent by PutFile).</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>image</td>
+ * <td>Image</td>
+ * <td>Either a static hex icon value or a binary image file name identifier (sent by PutFile).</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @see AddCommand
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateData.java index fc9302469..e44635163 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClimateData.java @@ -37,6 +37,7 @@ import com.smartdevicelink.util.SdlDataTypeConverter; import java.util.Hashtable; /** + * * <p><b>Parameter List</b></p> * * <table border="1" rules="all"> @@ -73,7 +74,6 @@ import java.util.Hashtable; * <td></td> * </tr> * </table> - * * @since SmartDeviceLink 7.1.0 */ public class ClimateData extends RPCStruct { @@ -84,8 +84,7 @@ public class ClimateData extends RPCStruct { /** * Constructs a new ClimateData object */ - public ClimateData() { - } + public ClimateData() { } /** * Constructs a new ClimateData object indicated by the Hashtable parameter @@ -138,7 +137,7 @@ public class ClimateData extends RPCStruct { * Sets the atmosphericPressure. * * @param atmosphericPressure Current atmospheric pressure in mBar - * {"num_min_value": 0.0, "num_max_value": 2000.0} + * {"num_min_value": 0.0, "num_max_value": 2000.0} */ public ClimateData setAtmosphericPressure(Float atmosphericPressure) { setValue(KEY_ATMOSPHERIC_PRESSURE, atmosphericPressure); diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java index 75a123a94..883c84153 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java @@ -46,36 +46,36 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Mandatory</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td>powerModeActive</td>
- * <td>Boolean</td>
- * <td></td>
- * <td>References signal "PowerMode_UB".</td>
- * </tr>
- * <tr>
- * <td>powerModeQualificationStatus</td>
- * <td>PowerModeQualificationStatus</td>
- * <td></td>
- * <td>References signal "PowerModeQF".</td>
- * </tr>
- * <tr>
- * <td>carModeStatus</td>
- * <td>CarModeStatus</td>
- * <td></td>
- * <td>Describes the car mode the vehicle is in.</td>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>powerModeActive</td>
+ * <td>Boolean</td>
+ * <td></td>
+ * <td>References signal "PowerMode_UB".</td>
+ * </tr>
+ * <tr>
+ * <td>powerModeQualificationStatus</td>
+ * <td>PowerModeQualificationStatus</td>
+ * <td></td>
+ * <td>References signal "PowerModeQF".</td>
+ * </tr>
+ * <tr>
+ * <td>carModeStatus</td>
+ * <td>CarModeStatus</td>
+ * <td></td>
+ * <td>Describes the car mode the vehicle is in.</td>
* </tr>
- * <tr>
- * <td>powerModeStatus</td>
- * <td>PowerModeStatus</td>
- * <td>true</td>
- * <td>Describes the different power modes</td>
- * </tr>
+ * <tr>
+ * <td>powerModeStatus</td>
+ * <td>PowerModeStatus</td>
+ * <td>true</td>
+ * <td>Describes the different power modes</td>
+ * </tr>
*
* </table>
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java index 1f60f3080..59790154d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java @@ -53,30 +53,30 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>interactionChoiceSetID</td>
- * <td>Integer</td>
- * <td>A unique ID that identifies the Choice Set</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>interactionChoiceSetID</td>
+ * <td>Integer</td>
+ * <td>A unique ID that identifies the Choice Set</td>
* <td>Y</td>
* <td>Min Value: 0; Max Value: 2000000000</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>choiceSet</td>
- * <td>Choice[]</td>
- * <td>Array of one or more elements.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>choiceSet</td>
+ * <td>Choice[]</td>
+ * <td>Array of one or more elements.</td>
* <td>Y</td>
* <td>Min Value: 1; Max Value: 100</td>
- * <td>SmartDeviceLink 1.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
* </table>
*
*
@@ -89,13 +89,13 @@ import java.util.List; * Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the Choice Set was created.
*
* <p><b>Non-default Result Codes:</b></p>
- * <p>SUCCESS</p>
- * <p>INVALID_DATA</p>
- * <p>OUT_OF_MEMORY</p>
- * <p>TOO_MANY_PENDING_REQUESTS</p>
- * <p>APPLICATION_NOT_REGISTERED</p>
- * <p>GENERIC_ERROR</p>
- * <p> REJECTED</p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p> REJECTED</p>
* <p> INVALID_ID</p>
* <p> DUPLICATE_NAME</p>
* <p>UNSUPPORTED_RESOURCE </p>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java index 271bd30be..a9d14e0b3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java @@ -43,35 +43,35 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Mandatory</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
* <th> Additional</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td>resultCode</td>
- * <td>VehicleDataResultCode</td>
- * <td>true</td>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>resultCode</td>
+ * <td>VehicleDataResultCode</td>
+ * <td>true</td>
* <td></td>
- * <td>Individual DID result code </td>
- * </tr>
- * <tr>
- * <td>didLocation</td>
- * <td>Integer</td>
- * <td>true</td>
+ * <td>Individual DID result code </td>
+ * </tr>
+ * <tr>
+ * <td>didLocation</td>
+ * <td>Integer</td>
+ * <td>true</td>
* <td>minvalue = 0 maxvalue = 65535 </td>
- * <td>The address of DID location from the ReadDID request.</td>
- * </tr>
+ * <td>The address of DID location from the ReadDID request.</td>
+ * </tr>
*
- * <tr>
- * <td>data</td>
- * <td>String</td>
- * <td>false</td>
+ * <tr>
+ * <td>data</td>
+ * <td>String</td>
+ * <td>false</td>
* <td>maxlength = 5000 </td>
- * <td>The DID data which is the hex byte string of however many bytes are stored at that location</td>
- * </tr>
+ * <td>The DID data which is the hex byte string of however many bytes are stored at that location</td>
+ * </tr>
* </table>
*
* @see VehicleDataResultCode
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java index 3c29542fc..8872f0649 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java @@ -39,22 +39,22 @@ import java.util.Hashtable; * String containing hexadecimal identifier as well as other common names.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>statusByte</td>
- * <td>String</td>
- * <td>Hexadecimal byte string
- * <ul>
- * <li>Maxlength = 500</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>statusByte</td>
+ * <td>String</td>
+ * <td>Hexadecimal byte string
+ * <ul>
+ * <li>Maxlength = 500</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java index 302ca0f66..aa28ade48 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java @@ -48,22 +48,22 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>cmdID</td>
- * <td>Integer</td>
- * <td>Unique ID that identifies the Command to be deleted from Command Menu</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>cmdID</td>
+ * <td>Integer</td>
+ * <td>Unique ID that identifies the Command to be deleted from Command Menu</td>
* <td>Y</td>
* <td>Min Value: 0;Max Value: 2000000000</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*
* <p><b> Response:</b></p>
@@ -71,13 +71,13 @@ import java.util.Hashtable; * Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code,this means a command was removed from the Command Menu successfully.
*
* <p><b> Non-default Result Codes:</b></p>
- * <p>SUCCESS</p>
- * <p>INVALID_DATA</p>
- * <p>OUT_OF_MEMORY</p>
- * <p>TOO_MANY_PENDING_REQUESTS</p>
- * <p>APPLICATION_NOT_REGISTERED</p>
- * <p> GENERIC_ERROR</p>
- * <p>REJECTED</p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p>REJECTED</p>
* <p> INVALID_ID</p>
* <p> IN_USER</p>
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java index 23b3daa8b..dc5ad1ea9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java @@ -44,34 +44,34 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>SmartDeviceLink 2.0</th>
- * </tr>
- * <tr>
- * <td>SDLFileName</td>
- * <td>String</td>
- * <td> File reference name.</td>
+ * <th>SmartDeviceLink 2.0</th>
+ * </tr>
+ * <tr>
+ * <td>SDLFileName</td>
+ * <td>String</td>
+ * <td> File reference name.</td>
* <td>Y</td>
* <td>maxlength:500</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* <p><b>Response </b></p>
*
* <p><b>Non-default Result Codes:</b></p>
- * <p> SUCCESS</p>
- * <p> INVALID_DATA</p>
- * <p> OUT_OF_MEMORY</p>
- * <p> TOO_MANY_PENDING_REQUESTS</p>
- * <p> APPLICATION_NOT_REGISTERED</p>
- * <p>GENERIC_ERROR</p>
- * <p>REJECTED</p>
+ * <p> SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
*
* @see PutFile
* @see ListFiles
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java index bc218c46c..eac6fc6f5 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java @@ -55,22 +55,22 @@ import java.util.Hashtable; * <p><b>Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>interactionChoiceSetID</td>
- * <td>Integer</td>
- * <td> A unique ID that identifies the Choice Set (specified in a previous call to CreateInteractionChoiceSet)</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>interactionChoiceSetID</td>
+ * <td>Integer</td>
+ * <td> A unique ID that identifies the Choice Set (specified in a previous call to CreateInteractionChoiceSet)</td>
* <td>Y</td>
* <td>Min Value: 0 ; Max Value: 2000000000</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*
* <p><b>Response </b></p>
@@ -78,13 +78,13 @@ import java.util.Hashtable; * If a resultCode of "SUCCESS" is returned, the requested choice set has been created and can now be referenced by the application using the value of interactionChoiceSetID provided by the application.
*
* <p><b>Non-default Result Codes:</b></p>
- * <p>SUCCESS</p>
- * <p>INVALID_DATA</p>
- * <p>OUT_OF_MEMORY</p>
- * <p>TOO_MANY_PENDING_REQUESTS</p>
- * <p>APPLICATION_NOT_REGISTERED</p>
- * <p>GENERIC_ERROR</p>
- * <p>REJECTED</p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>REJECTED</p>
* <p>INVALID_ID</p>
*
* @see CreateInteractionChoiceSet
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java index 563e8fc4c..078504bd0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java @@ -49,34 +49,34 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>menuID</td>
- * <td>Integer</td>
- * <td>Unique ID that identifies the SubMenu to be delete</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>menuID</td>
+ * <td>Integer</td>
+ * <td>Unique ID that identifies the SubMenu to be delete</td>
* <td>Y</td>
* <td>Min Value: 0; Max Value: 2000000000</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*
* <p> <b>Response </b></p>
*
* <p><b>Non-default Result Codes:</b></p>
* <p>SUCCESS</p>
- * <p> INVALID_DATA</p>
- * <p> OUT_OF_MEMORY</p>
- * <p> TOO_MANY_PENDING_REQUESTS</p>
- * <p> APPLICATION_NOT_REGISTERED</p>
- * <p> GENERIC_ERROR</p>
- * <p> REJECTED</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p> REJECTED</p>
* <p> INVALID_ID</p>
* <p> IN_USE </p>
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java index cce0d4225..9a98a997b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java @@ -43,62 +43,62 @@ import java.util.Hashtable; * <p><b>Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>hardware</td>
- * <td>String</td>
- * <td>Device model</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>hardware</td>
+ * <td>String</td>
+ * <td>Device model</td>
* <td>N</td>
* <td>Max Length: 500</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>firmwareRev</td>
- * <td>String</td>
- * <td>Device firmware revision</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>firmwareRev</td>
+ * <td>String</td>
+ * <td>Device firmware revision</td>
* <td>N</td>
* <td>Max Length: 500</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>os</td>
- * <td>String</td>
- * <td>Device OS version</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>os</td>
+ * <td>String</td>
+ * <td>Device OS version</td>
* <td>N</td>
* <td>Max Length: 500</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>osVersion</td>
- * <td>String</td>
- * <td>Device OS version</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>osVersion</td>
+ * <td>String</td>
+ * <td>Device OS version</td>
* <td>N</td>
* <td>Max Length: 500</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>carrier</td>
- * <td>String</td>
- * <td>Device mobile carrier (if applicable)</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>carrier</td>
+ * <td>String</td>
+ * <td>Device mobile carrier (if applicable)</td>
* <td>N</td>
* <td>Max Length: 500</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>maxNumberRFCOMMPorts</td>
- * <td>Integer</td>
- * <td>Omitted if connected not via BT.</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>maxNumberRFCOMMPorts</td>
+ * <td>Integer</td>
+ * <td>Omitted if connected not via BT.</td>
* <td>N</td>
* <td>Min Value: 0; Max Value: 100</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
* </table>
*/
public class DeviceInfo extends RPCStruct {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java index bfda4da9e..a857a50e9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java @@ -43,89 +43,89 @@ import java.util.Hashtable; * Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>voiceRecOn</td>
- * <td>Boolean</td>
- * <td>Voice recognition is on
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>btIconOn</td>
- * <td>Boolean</td>
- * <td>Bluetooth connection established
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>callActive</td>
- * <td>Boolean</td>
- * <td>A call is being active
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>phoneRoaming</td>
- * <td>Boolean</td>
- * <td>The phone is in roaming mode
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>textMsgAvailable</td>
- * <td>Boolean</td>
- * <td>A text message is available
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>battLevelStatus</td>
- * <td>DeviceLevelStatus</td>
- * <td>Battery level status
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>stereoAudioOutputMuted</td>
- * <td>Boolean</td>
- * <td>Status of the stereo audio output channel
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>monoAudioOutputMuted</td>
- * <td>Boolean</td>
- * <td>Status of the mono audio output channel
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>signalLevelStatus</td>
- * <td>DeviceLevelStatus</td>
- * <td>Signal level status
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>primaryAudioSource</td>
- * <td>PrimaryAudioSource</td>
- * <td>Reflects the current primary audio source of SDL (if selected).
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>eCallEventActive</td>
- * <td>Boolean</td>
- * <td>Reflects, if an eCall event is active
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>voiceRecOn</td>
+ * <td>Boolean</td>
+ * <td>Voice recognition is on
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>btIconOn</td>
+ * <td>Boolean</td>
+ * <td>Bluetooth connection established
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>callActive</td>
+ * <td>Boolean</td>
+ * <td>A call is being active
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>phoneRoaming</td>
+ * <td>Boolean</td>
+ * <td>The phone is in roaming mode
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>textMsgAvailable</td>
+ * <td>Boolean</td>
+ * <td>A text message is available
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>battLevelStatus</td>
+ * <td>DeviceLevelStatus</td>
+ * <td>Battery level status
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>stereoAudioOutputMuted</td>
+ * <td>Boolean</td>
+ * <td>Status of the stereo audio output channel
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>monoAudioOutputMuted</td>
+ * <td>Boolean</td>
+ * <td>Status of the mono audio output channel
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>signalLevelStatus</td>
+ * <td>DeviceLevelStatus</td>
+ * <td>Signal level status
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>primaryAudioSource</td>
+ * <td>PrimaryAudioSource</td>
+ * <td>Reflects the current primary audio source of SDL (if selected).
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>eCallEventActive</td>
+ * <td>Boolean</td>
+ * <td>Reflects, if an eCall event is active
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @see DeviceLevelStatus
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java index dcb79bc24..bceb32de3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java @@ -44,43 +44,43 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>targetID</td>
- * <td>Integer</td>
- * <td>Name of target ECU.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>targetID</td>
+ * <td>Integer</td>
+ * <td>Name of target ECU.</td>
* <td>Y</td>
* <td>Min Value: 0; Max Value: 65535</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>messageLength</td>
- * <td>Integer</td>
- * <td>Length of message (in bytes).</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>messageLength</td>
+ * <td>Integer</td>
+ * <td>Length of message (in bytes).</td>
* <td>Y</td>
* <td>Min Value: 0; Max Value:65535</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>messageData</td>
- * <td>Integer</td>
- * <td>Array of bytes comprising CAN message.</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>messageData</td>
+ * <td>Integer</td>
+ * <td>Array of bytes comprising CAN message.</td>
* <td>Y</td>
* <td>Min Value: 0; Max Value:255; Min Size:1; Max Size:65535</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
* </table>
* <p><b>HMI must:</b> </p>
*
- * <p>1. Check the requested data using provided information of targetID (name of ECU),messageLength and messageData.</p>
- * <p> 2. Respond with one of the appropriate result codes.And in case of SUCCESS return messageDataResult which is an array of bytes comprising CAN message result.</p>
+ * <p>1. Check the requested data using provided information of targetID (name of ECU),messageLength and messageData.</p>
+ * <p> 2. Respond with one of the appropriate result codes.And in case of SUCCESS return messageDataResult which is an array of bytes comprising CAN message result.</p>
*
* @since SmartDeviceLink 3.0
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java index 7ec2c1484..05a49adc0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java @@ -45,46 +45,46 @@ import java.util.List; * Contains information about the display for the SDL system to which the application is currently connected.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>@property-deprecated <s>displayType</s></td>
- * <td><s>DisplayType</s></td>
- * <td><s>The type of display</s>
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>displayName</td>
- * <td>String</td>
- * <td>The name of the display
- * </td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
- * <td>textField</td>
- * <td>TextField[]</td>
- * <td>An array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as <i>{@linkplain Show}</i>, <i>{@linkplain SetMediaClockTimer}</i>, etc.
- * This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ).
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>mediaClockFormats</td>
- * <td>MediaClockFormat[]</td>
- * <td>An array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>graphicSupported</td>
- * <td>Boolean</td>
- * <td>The display's persistent screen supports referencing a static or dynamic image.</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>@property-deprecated <s>displayType</s></td>
+ * <td><s>DisplayType</s></td>
+ * <td><s>The type of display</s>
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>displayName</td>
+ * <td>String</td>
+ * <td>The name of the display
+ * </td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
+ * <td>textField</td>
+ * <td>TextField[]</td>
+ * <td>An array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as <i>{@linkplain Show}</i>, <i>{@linkplain SetMediaClockTimer}</i>, etc.
+ * This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ).
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>mediaClockFormats</td>
+ * <td>MediaClockFormat[]</td>
+ * <td>An array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>graphicSupported</td>
+ * <td>Boolean</td>
+ * <td>The display's persistent screen supports referencing a static or dynamic image.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @see DisplayType
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DoorStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DoorStatus.java index 93e12a629..777542085 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DoorStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DoorStatus.java @@ -79,8 +79,7 @@ public class DoorStatus extends RPCStruct { /** * Constructs a new DoorStatus object */ - public DoorStatus() { - } + public DoorStatus() { } /** * Constructs a new DoorStatus object indicated by the Hashtable parameter diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java index a49794e69..1858748d6 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java @@ -44,38 +44,38 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>eCallNotificationStatus</td>
- * <td>VehicleDataNotificationStatus</td>
- * <td>References signal "eCallNotification_4A".</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>eCallNotificationStatus</td>
+ * <td>VehicleDataNotificationStatus</td>
+ * <td>References signal "eCallNotification_4A".</td>
* <td></td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>auxECallNotificationStatus</td>
- * <td>VehicleDataNotificationStatus</td>
- * <td>References signal "eCallNotification". This is an alternative signal available on some car lines replacing the eCallNotificationStatus, but showing the same values.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>auxECallNotificationStatus</td>
+ * <td>VehicleDataNotificationStatus</td>
+ * <td>References signal "eCallNotification". This is an alternative signal available on some car lines replacing the eCallNotificationStatus, but showing the same values.</td>
* <td></td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>eCallConfirmationStatus</td>
- * <td>ECallConfirmationStatus</td>
- * <td>References signal "eCallConfirmation"</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>eCallConfirmationStatus</td>
+ * <td>ECallConfirmationStatus</td>
+ * <td>References signal "eCallConfirmation"</td>
* <td></td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @see SubscribeVehicleData
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java index aaf829ba3..621cca031 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java @@ -45,56 +45,56 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Mandatory</th>
- * <th>Description</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>emergencyEventType</td>
- * <td>EmergencyEventType</td>
- * <td></td>
- * <td>References signal "VedsEvntType_D_Ltchd". See{@linkplain EmergencyEventType}</td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>fuelCutoffStatus</td>
- * <td>FuelCutoffStatus</td>
- * <td></td>
- * <td>References signal "RCM_FuelCutoff". See{@linkplain FuelCutoffStatus}</td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>rolloverEvent</td>
- * <td>VehicleDataEventStatus</td>
- * <td></td>
- * <td>References signal "VedsEvntRoll_D_Ltchd". See{@linkplain VehicleDataEventStatus}</td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>maximumChangeVelocity</td>
- * <td>Integer</td>
- * <td></td>
- * <td>References signal "VedsMaxDeltaV_D_Ltchd".</td>
- * <td>minvalue=0; maxvalue=255;<p> Additional reserved values:</p> <p>0x00 No event; 0xFE Not supported; 0xFF Fault</p> </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>emergencyEventType</td>
+ * <td>EmergencyEventType</td>
+ * <td></td>
+ * <td>References signal "VedsEvntType_D_Ltchd". See{@linkplain EmergencyEventType}</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelCutoffStatus</td>
+ * <td>FuelCutoffStatus</td>
+ * <td></td>
+ * <td>References signal "RCM_FuelCutoff". See{@linkplain FuelCutoffStatus}</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>rolloverEvent</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td></td>
+ * <td>References signal "VedsEvntRoll_D_Ltchd". See{@linkplain VehicleDataEventStatus}</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>maximumChangeVelocity</td>
+ * <td>Integer</td>
+ * <td></td>
+ * <td>References signal "VedsMaxDeltaV_D_Ltchd".</td>
+ * <td>minvalue=0; maxvalue=255;<p> Additional reserved values:</p> <p>0x00 No event; 0xFE Not supported; 0xFF Fault</p> </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
*
- * <tr>
- * <td>multipleEvents</td>
- * <td>VehicleDataEventStatus</td>
- * <td></td>
- * <td>References signal "VedsMultiEvnt_D_Ltchd". See{@linkplain VehicleDataEventStatus}</td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <td>multipleEvents</td>
+ * <td>VehicleDataEventStatus</td>
+ * <td></td>
+ * <td>References signal "VedsMultiEvnt_D_Ltchd". See{@linkplain VehicleDataEventStatus}</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @see Image
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java index 79bfdd187..d199be5e2 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java @@ -44,135 +44,135 @@ import java.util.Hashtable; * Describes the GPS data. Not all data will be available on all car lines.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>longitudeDegrees</td>
- * <td>Double</td>
- * <td>Minvalue: - 180
- * <b>Maxvalue: 180
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>latitudeDegrees</td>
- * <td>Double</td>
- * <td>Minvalue: - 90<b>Maxvalue: 90
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>utcYear</td>
- * <td>Integer</td>
- * <td>Minvalue: 2010<b>Maxvalue: 2100
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>utcMonth</td>
- * <td>Integer</td>
- * <td>Minvalue: 1<b>Maxvalue: 12
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>utcDay</td>
- * <td>Integer</td>
- * <td>Minvalue: 1<b>Maxvalue: 31
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>utcHours</td>
- * <td>Integer</td>
- * <td>Minvalue: 0<b>Maxvalue: 23
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>utcMinutes</td>
- * <td>Integer</td>
- * <td>Minvalue: 0<b>Maxvalue: 59
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>utcSeconds</td>
- * <td>Integer</td>
- * <td>Minvalue: 0<b>Maxvalue: 59
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>pdop</td>
- * <td>Integer</td>
- * <td>Positional Dilution of Precision. If undefined or unavailable, then value shall be set to 0.<b>Minvalue: 0<b>Maxvalue: 1000
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>hdop</td>
- * <td>Integer</td>
- * <td>Horizontal Dilution of Precision. If value is unknown, value shall be set to 0.<b>Minvalue: 0<b>Maxvalue: 1000
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>vdop</td>
- * <td>Integer</td>
- * <td>Vertical Dilution of Precision. If value is unknown, value shall be set to 0.<b>Minvalue: 0<b>Maxvalue: 1000
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>actual</td>
- * <td>Boolean</td>
- * <td>True, if coordinates are based on satellites.
- * False, if based on dead reckoning
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>satellites</td>
- * <td>Integer</td>
- * <td>Number of satellites in view
- * <b>Minvalue: 0
- * <b>Maxvalue: 31
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>altitude</td>
- * <td>Integer</td>
- * <td>Altitude in meters
- * <b>Minvalue: -10000</b>
- * <b>Maxvalue: 10000</b>
- * <b>Note:</b> SYNC uses Mean Sea Level for calculating GPS. </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>heading</td>
- * <td>Double</td>
- * <td>The heading. North is 0, East is 90, etc.
- * <b>Minvalue: 0
- * <b>Maxvalue: 359.99
- * <b>Resolution is 0.01
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>speed</td>
- * <td>Integer</td>
- * <td>The speed in KPH
- * <b>Minvalue: 0
- * <b>Maxvalue: 500
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>longitudeDegrees</td>
+ * <td>Double</td>
+ * <td>Minvalue: - 180
+ * <b>Maxvalue: 180
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>latitudeDegrees</td>
+ * <td>Double</td>
+ * <td>Minvalue: - 90<b>Maxvalue: 90
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>utcYear</td>
+ * <td>Integer</td>
+ * <td>Minvalue: 2010<b>Maxvalue: 2100
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>utcMonth</td>
+ * <td>Integer</td>
+ * <td>Minvalue: 1<b>Maxvalue: 12
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>utcDay</td>
+ * <td>Integer</td>
+ * <td>Minvalue: 1<b>Maxvalue: 31
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>utcHours</td>
+ * <td>Integer</td>
+ * <td>Minvalue: 0<b>Maxvalue: 23
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>utcMinutes</td>
+ * <td>Integer</td>
+ * <td>Minvalue: 0<b>Maxvalue: 59
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>utcSeconds</td>
+ * <td>Integer</td>
+ * <td>Minvalue: 0<b>Maxvalue: 59
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>pdop</td>
+ * <td>Integer</td>
+ * <td>Positional Dilution of Precision. If undefined or unavailable, then value shall be set to 0.<b>Minvalue: 0<b>Maxvalue: 1000
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>hdop</td>
+ * <td>Integer</td>
+ * <td>Horizontal Dilution of Precision. If value is unknown, value shall be set to 0.<b>Minvalue: 0<b>Maxvalue: 1000
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>vdop</td>
+ * <td>Integer</td>
+ * <td>Vertical Dilution of Precision. If value is unknown, value shall be set to 0.<b>Minvalue: 0<b>Maxvalue: 1000
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>actual</td>
+ * <td>Boolean</td>
+ * <td>True, if coordinates are based on satellites.
+ * False, if based on dead reckoning
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>satellites</td>
+ * <td>Integer</td>
+ * <td>Number of satellites in view
+ * <b>Minvalue: 0
+ * <b>Maxvalue: 31
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>altitude</td>
+ * <td>Integer</td>
+ * <td>Altitude in meters
+ * <b>Minvalue: -10000</b>
+ * <b>Maxvalue: 10000</b>
+ * <b>Note:</b> SYNC uses Mean Sea Level for calculating GPS. </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>heading</td>
+ * <td>Double</td>
+ * <td>The heading. North is 0, East is 90, etc.
+ * <b>Minvalue: 0
+ * <b>Maxvalue: 359.99
+ * <b>Resolution is 0.01
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>speed</td>
+ * <td>Integer</td>
+ * <td>The speed in KPH
+ * <b>Minvalue: 0
+ * <b>Maxvalue: 500
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GateStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GateStatus.java index 6c5275d38..df000ecbc 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GateStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GateStatus.java @@ -79,8 +79,7 @@ public class GateStatus extends RPCStruct { /** * Constructs a new GateStatus object */ - public GateStatus() { - } + public GateStatus() { } /** * Constructs a new GateStatus object indicated by the Hashtable parameter diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GenericResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GenericResponse.java index d4c0f36d8..0c3c70ee6 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GenericResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GenericResponse.java @@ -45,38 +45,38 @@ import java.util.Hashtable; * INVALID_DATA is used.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>success</td>
- * <td>Boolean</td>
- * <td>true, if successful; false, if failed</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>success</td>
+ * <td>Boolean</td>
+ * <td>true, if successful; false, if failed</td>
* <td></td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>resultCode</td>
- * <td>Result</td>
- * <td>Defines the possible result codes returned by SDL to the application in a Response to a requested operation</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>resultCode</td>
+ * <td>Result</td>
+ * <td>Defines the possible result codes returned by SDL to the application in a Response to a requested operation</td>
* <td></td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>info</td>
- * <td>String</td>
- * <td>Provides additional human readable info regarding the result.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>info</td>
+ * <td>String</td>
+ * <td>Provides additional human readable info regarding the result.</td>
* <td>N</td>
- * <td>maxlength=1000</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>maxlength=1000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
* @since SmartDeviceLink 1.0
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java index 0d7cc14b9..dc8b4828f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java @@ -48,30 +48,30 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>ecuName</td>
- * <td>Integer</td>
- * <td>Name of ECU.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>ecuName</td>
+ * <td>Integer</td>
+ * <td>Name of ECU.</td>
* <td>Y</td>
* <td>Min Value: 0; Max Value: 65535</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>dtcMask</td>
- * <td>Integer</td>
- * <td>DTC Mask Byte to be sent in diagnostic request to module.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>dtcMask</td>
+ * <td>Integer</td>
+ * <td>DTC Mask Byte to be sent in diagnostic request to module.</td>
* <td>N</td>
* <td>Min Value: 0; Max Value: 255</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
* </table>
* <p><b>Response</b></p>
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java index 8666de60f..b723f08b9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java @@ -41,90 +41,90 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>gps</td>
- * <td>Boolean</td>
- * <td>GPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData }for details</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData }for details</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>speed</td>
- * <td>Boolean</td>
- * <td>The vehicle speed in kilometers per hour</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>speed</td>
+ * <td>Boolean</td>
+ * <td>The vehicle speed in kilometers per hour</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>rpm</td>
- * <td>Boolean</td>
- * <td>The number of revolutions per minute of the engine</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Boolean</td>
+ * <td>The number of revolutions per minute of the engine</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>fuelLevel</td>
- * <td>Boolean</td>
- * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Boolean</td>
+ * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>fuelLevel_State</td>
- * <td>Boolean</td>
- * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>Boolean</td>
+ * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>fuelRange</td>
- * <td>Boolean</td>
- * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelRange</td>
+ * <td>Boolean</td>
+ * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 5.0.0</td>
- * </tr>
- * <tr>
- * <td>instantFuelConsumption</td>
- * <td>Boolean</td>
- * <td>The instantaneous fuel consumption in micro litres</td>
+ * <td>SmartDeviceLink 5.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Boolean</td>
+ * <td>The instantaneous fuel consumption in micro litres</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>externalTemperature</td>
- * <td>Boolean</td>
- * <td>The external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Boolean</td>
+ * <td>The external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>
- * @since SmartDeviceLink 2.0.0
- * @property-deprecated in SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>vin</td>
- * <td>Boolean</td>
- * <td>Vehicle identification number</td>
+ * <td>
+ * @since SmartDeviceLink 2.0.0
+ * @property-deprecated in SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>vin</td>
+ * <td>Boolean</td>
+ * <td>Vehicle identification number</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
* <tr>
* <td>gearStatus</td>
* <td>Boolean</td>
@@ -139,117 +139,117 @@ import java.util.Hashtable; * <td>N</td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
- * <tr>
- * <td>tirePressure</td>
- * <td>Boolean</td>
- * <td>Tire pressure status</td>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>Boolean</td>
+ * <td>Tire pressure status</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>odometer</td>
- * <td>Boolean</td>
- * <td>Odometer in km</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Boolean</td>
+ * <td>Odometer in km</td>
* <td>N</td>
* <td>Max Length: 500</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>beltStatus</td>
- * <td>Boolean</td>
- * <td>The status of the seat belts</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the seat belts</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>bodyInformation</td>
- * <td>Boolean</td>
- * <td>The body information including ignition status and internal temp</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>Boolean</td>
+ * <td>The body information including ignition status and internal temp</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>deviceStatus</td>
- * <td>Boolean</td>
- * <td>The device status including signal and battery strength</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>Boolean</td>
+ * <td>The device status including signal and battery strength</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>driverBraking</td>
- * <td>Boolean</td>
- * <td>The status of the brake pedal</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>Boolean</td>
+ * <td>The status of the brake pedal</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>wiperStatus</td>
- * <td>Boolean</td>
- * <td>The status of the wipers</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the wipers</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>headLampStatus</td>
- * <td>Boolean</td>
- * <td>Status of the head lamps</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>Boolean</td>
+ * <td>Status of the head lamps</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>engineTorque</td>
- * <td>Boolean</td>
- * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Boolean</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>engineOilLife</td>
- * <td>Boolean</td>
- * <td>The estimated percentage of remaining oil life of the engine</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>engineOilLife</td>
+ * <td>Boolean</td>
+ * <td>The estimated percentage of remaining oil life of the engine</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
- * <td>accPedalPosition</td>
- * <td>Boolean</td>
- * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Boolean</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>steeringWheelAngle</td>
- * <td>Boolean</td>
- * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Boolean</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>turnSignal</td>
- * <td>Boolean</td>
- * <td>@see TurnSignal</td>
- * <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
- * <td>cloudAppVehicleID</td>
- * <td>Boolean</td>
- * <td>ID for the vehicle when connecting to cloud applications</td>
- * <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 5.1 </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>turnSignal</td>
+ * <td>Boolean</td>
+ * <td>@see TurnSignal</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
+ * <td>cloudAppVehicleID</td>
+ * <td>Boolean</td>
+ * <td>ID for the vehicle when connecting to cloud applications</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 5.1 </td>
* <tr>
* <td>stabilityControlsStatus</td>
* <td>Boolean</td>
@@ -257,7 +257,7 @@ import java.util.Hashtable; * <td>N</td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
- * </tr>
+ * </tr>
* <tr>
* <td>handsOffSteering</td>
* <td>Boolean</td>
@@ -292,7 +292,7 @@ import java.util.Hashtable; * @since SmartDeviceLink 7.1.0
* </td>
* </tr>
- * </table>
+ * </table>
*
*
* <p><b>Response</b></p>
@@ -371,7 +371,6 @@ public class GetVehicleData extends RPCRequest { * @since SmartDeviceLink 7.1.0
*/
public static final String KEY_SEAT_OCCUPANCY = "seatOccupancy";
-
/**
* Constructs a new GetVehicleData object
*/
@@ -476,7 +475,7 @@ public class GetVehicleData extends RPCRequest { * Sets the externalTemperature.
*
* @param externalTemperature The external temperature in degrees celsius. This parameter is deprecated starting RPC
- * Spec 7.1.0, please see climateData.
+ * Spec 7.1.0, please see climateData.
* @since SmartDeviceLink 2.0.0
* @deprecated in SmartDeviceLink 7.1.0
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java index c0d718e8f..c7b429075 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleDataResponse.java @@ -224,8 +224,8 @@ public class GetVehicleDataResponse extends RPCResponse { * Sets the externalTemperature.
*
* @param externalTemperature The external temperature in degrees celsius. This parameter is deprecated starting RPC
- * Spec 7.1.0, please see climateData.
- * {"num_min_value": -40.0, "num_max_value": 100.0}
+ * Spec 7.1.0, please see climateData.
+ * {"num_min_value": -40.0, "num_max_value": 100.0}
* @since SmartDeviceLink 2.0.0
* @deprecated in SmartDeviceLink 7.1.0
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java index 1349bb783..8b88366df 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java @@ -43,34 +43,34 @@ import java.util.List; * Defining sets of HMI levels, which are permitted or prohibited for a given RPC.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>allowed</td>
- * <td>HMILevel</td>
- * <td>A set of all HMI levels that are permitted for this given RPC.
- * <ul>
- * <li>Min: 0</li>
- * <li>Max: 100</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>userDisallowed</td>
- * <td>HMILevel</td>
- * <td>A set of all HMI levels that are prohibited for this given RPC.
- * <ul>
- * <li>Min: 0</li>
- * <li>Max: 100</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>allowed</td>
+ * <td>HMILevel</td>
+ * <td>A set of all HMI levels that are permitted for this given RPC.
+ * <ul>
+ * <li>Min: 0</li>
+ * <li>Max: 100</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>userDisallowed</td>
+ * <td>HMILevel</td>
+ * <td>A set of all HMI levels that are prohibited for this given RPC.
+ * <ul>
+ * <li>Min: 0</li>
+ * <li>Max: 100</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java index 147b01d3b..dfa452e90 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java @@ -42,29 +42,29 @@ import java.util.Hashtable; * Specifies, which image shall be used, e.g. in Alerts or on SoftButtons provided the display supports it.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>value</td>
- * <td>String</td>
- * <td>Either the static hex icon value or the binary image file name identifier (sent by PutFile).
- * <ul>
- * <li>Min: 0</li>
- * <li>Max: 65535</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>imageType</td>
- * <td>ImageType</td>
- * <td>Describes, whether it is a static or dynamic image.</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>value</td>
+ * <td>String</td>
+ * <td>Either the static hex icon value or the binary image file name identifier (sent by PutFile).
+ * <ul>
+ * <li>Min: 0</li>
+ * <li>Max: 65535</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>imageType</td>
+ * <td>ImageType</td>
+ * <td>Describes, whether it is a static or dynamic image.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java index a1a19aefe..a7a79fa1b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java @@ -45,38 +45,38 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th> Version</th>
- * </tr>
- * <tr>
- * <td>name</td>
- * <td>ImageFieldName</td>
- * <td>The name that identifies the field.{@linkplain ImageFieldName}</td>
+ * <th> Version</th>
+ * </tr>
+ * <tr>
+ * <td>name</td>
+ * <td>ImageFieldName</td>
+ * <td>The name that identifies the field.{@linkplain ImageFieldName}</td>
* <td></td>
* <td></td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>imageTypeSupported</td>
- * <td>FileType</td>
- * <td>The image types that are supported in this field. {@linkplain FileType}</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>imageTypeSupported</td>
+ * <td>FileType</td>
+ * <td>The image types that are supported in this field. {@linkplain FileType}</td>
* <td></td>
* <td>maxlength: 100</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>imageResolution</td>
- * <td>ImageResolution</td>
- * <td>The image resolution of this field.</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>imageResolution</td>
+ * <td>ImageResolution</td>
+ * <td>The image resolution of this field.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
* </table>
*
* @see com.smartdevicelink.proxy.rpc.enums.ImageType
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java index 20533d910..b14e2ccba 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java @@ -43,30 +43,30 @@ import java.util.Hashtable; * <p><b>Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>resolutionWidth</td>
- * <td>Integer</td>
- * <td>The image resolution width.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>resolutionWidth</td>
+ * <td>Integer</td>
+ * <td>The image resolution width.</td>
* <td></td>
* <td>minvalue:1; maxvalue: 10000</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>resolutionHeight</td>
- * <td>Integer</td>
- * <td>The image resolution height.</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>resolutionHeight</td>
+ * <td>Integer</td>
+ * <td>The image resolution height.</td>
* <td></td>
* <td>minvalue:1; maxvalue: 10000</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
*
* </table>
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardCapabilities.java index fecc821ed..bc2fb4301 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardCapabilities.java @@ -37,6 +37,7 @@ import java.util.Hashtable; import java.util.List; /** + * * <p><b>Parameter List</b></p> * * <table border="1" rules="all"> @@ -65,7 +66,6 @@ import java.util.List; * <td></td> * </tr> * </table> - * * @since SmartDeviceLink 7.1.0 */ public class KeyboardCapabilities extends RPCStruct { @@ -76,8 +76,7 @@ public class KeyboardCapabilities extends RPCStruct { /** * Constructs a new KeyboardCapabilities object */ - public KeyboardCapabilities() { - } + public KeyboardCapabilities() { } /** * Constructs a new KeyboardCapabilities object indicated by the Hashtable parameter @@ -92,7 +91,7 @@ public class KeyboardCapabilities extends RPCStruct { * Sets the maskInputCharactersSupported. * * @param maskInputCharactersSupported Availability of capability to mask input characters using keyboard. True: Available, - * False: Not Available + * False: Not Available */ public KeyboardCapabilities setMaskInputCharactersSupported(Boolean maskInputCharactersSupported) { setValue(KEY_MASK_INPUT_CHARACTERS_SUPPORTED, maskInputCharactersSupported); @@ -113,7 +112,7 @@ public class KeyboardCapabilities extends RPCStruct { * Sets the supportedKeyboards. * * @param supportedKeyboards Capabilities of supported keyboard layouts by HMI. - * {"array_max_size": 1000, "array_min_size": 1} + * {"array_max_size": 1000, "array_min_size": 1} */ public KeyboardCapabilities setSupportedKeyboards(List<KeyboardLayoutCapability> supportedKeyboards) { setValue(KEY_SUPPORTED_KEYBOARDS, supportedKeyboards); diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardLayoutCapability.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardLayoutCapability.java index 7972a4522..cf3f13b9c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardLayoutCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardLayoutCapability.java @@ -79,8 +79,7 @@ public class KeyboardLayoutCapability extends RPCStruct { /** * Constructs a new KeyboardLayoutCapability object */ - public KeyboardLayoutCapability() { - } + public KeyboardLayoutCapability() { } /** * Constructs a new KeyboardLayoutCapability object indicated by the Hashtable parameter @@ -96,7 +95,7 @@ public class KeyboardLayoutCapability extends RPCStruct { * * @param keyboardLayout * @param numConfigurableKeys Number of keys available for special characters, App can customize as per their needs. - * {"num_max_value": 10, "num_min_value": 0} + * {"num_max_value": 10, "num_min_value": 0} */ public KeyboardLayoutCapability(@NonNull KeyboardLayout keyboardLayout, @NonNull Integer numConfigurableKeys) { this(); @@ -127,7 +126,7 @@ public class KeyboardLayoutCapability extends RPCStruct { * Sets the numConfigurableKeys. * * @param numConfigurableKeys Number of keys available for special characters, App can customize as per their needs. - * {"num_max_value": 10, "num_min_value": 0} + * {"num_max_value": 10, "num_min_value": 0} */ public KeyboardLayoutCapability setNumConfigurableKeys(@NonNull Integer numConfigurableKeys) { setValue(KEY_NUM_CONFIGURABLE_KEYS, numConfigurableKeys); diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java index 7c1b6d3d3..a59623720 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java @@ -45,84 +45,84 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Mandatory</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
* <th> Additional</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td>language</td>
- * <td>Language</td>
- * <td>false</td>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>language</td>
+ * <td>Language</td>
+ * <td>false</td>
* <td></td>
- * <td>The keyboard language. </td>
- * </tr>
- * <tr>
- * <td>keyboardLayout</td>
- * <td>KeyboardLayout</td>
- * <td>false</td>
+ * <td>The keyboard language. </td>
+ * </tr>
+ * <tr>
+ * <td>keyboardLayout</td>
+ * <td>KeyboardLayout</td>
+ * <td>false</td>
* <td></td>
- * <td>Desired keyboard layout.</td>
- * </tr>
- * <tr>
- * <td>sendDynamicEntry</td>
- * <td>Boolean</td>
- * <td>false</td>
+ * <td>Desired keyboard layout.</td>
+ * </tr>
+ * <tr>
+ * <td>sendDynamicEntry</td>
+ * <td>Boolean</td>
+ * <td>false</td>
* <td></td>
- * <td>In this mode, all key presses will be sent as they occur. If disabled, entire string of text will be returned only once submitted by user.If omitted, this value will be set to FALSE.</td>
- * </tr>
- * <tr>
- * <td>keypressMode</td>
- * <td>KeypressMode</td>
- * <td>False</td>
+ * <td>In this mode, all key presses will be sent as they occur. If disabled, entire string of text will be returned only once submitted by user.If omitted, this value will be set to FALSE.</td>
+ * </tr>
+ * <tr>
+ * <td>keypressMode</td>
+ * <td>KeypressMode</td>
+ * <td>False</td>
* <td></td>
- * <td>Desired keypress mode.If omitted, this value will be set to RESEND_CURRENT_ENTRY. </td>
- * </tr>
- * <tr>
- * <td>limitedCharacterList</td>
- * <td>String</td>
- * <td>false</td>
+ * <td>Desired keypress mode.If omitted, this value will be set to RESEND_CURRENT_ENTRY. </td>
+ * </tr>
+ * <tr>
+ * <td>limitedCharacterList</td>
+ * <td>String</td>
+ * <td>false</td>
* <td>Array = true maxLength = 1 minsize = 1 maxsize = 100</td>
- * <td>Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled.</td>
- * </tr>
+ * <td>Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled.</td>
+ * </tr>
*
- * <tr>
- * <td>autoCompleteText</td>
- * <td>String</td>
- * <td>false</td>
+ * <tr>
+ * <td>autoCompleteText</td>
+ * <td>String</td>
+ * <td>false</td>
* <td>maxlength = 1000 </td>
- * <td>Allows an app to prepopulate the text field with a suggested or completed entry as the user types.</td>
- * </tr>
- * <tr>
- * <td>autoCompleteList</td>
- * <td>String</td>
- * <td>false</td>
+ * <td>Allows an app to prepopulate the text field with a suggested or completed entry as the user types.</td>
+ * </tr>
+ * <tr>
+ * <td>autoCompleteList</td>
+ * <td>String</td>
+ * <td>false</td>
* <td>Array = true maxlength = 1000 minsize = 0 maxsize = 100</td>
- * <td>Allows an app to prepopulate the text field with a list of suggested or completed entry as the user types. Set to an empty array to remove the auto-complete list from the screen</td>
- * </tr>
- * <tr>
- * <td>maskInputCharacters</td>
- * <td>KeyboardInputMask</td>
- * <td>false</td>
- * <td>
- * @since SmartDeviceLink 7.1.0
- * </td>
- * <td>Allows an app to mask entered characters on HMI</td>
- * </tr>
- * <tr>
- * <td>customKeys</td>
- * <td>List<String></td>
- * <td>false</td>
- * <td>
- * @since SmartDeviceLink 7.1.0
- * </td>
- * <td>
- * Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters
- * {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
- * </td>
- * </tr>
+ * <td>Allows an app to prepopulate the text field with a list of suggested or completed entry as the user types. Set to an empty array to remove the auto-complete list from the screen</td>
+ * </tr>
+ * <tr>
+ * <td>maskInputCharacters</td>
+ * <td>KeyboardInputMask</td>
+ * <td>false</td>
+ * <td>
+ * @since SmartDeviceLink 7.1.0
+ * </td>
+ * <td>Allows an app to mask entered characters on HMI</td>
+ * </tr>
+ * <tr>
+ * <td>customKeys</td>
+ * <td>List<String></td>
+ * <td>false</td>
+ * <td>
+ * @since SmartDeviceLink 7.1.0
+ * </td>
+ * <td>
+ * Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters
+ * {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
+ * </td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 3.0
@@ -266,8 +266,8 @@ public class KeyboardProperties extends RPCStruct { * Sets the customKeys.
*
* @param customKeys Array of special characters to show in customizable keys. If omitted, keyboard will show
- * default special characters
- * {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
+ * default special characters
+ * {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1}
* @since SmartDeviceLink 7.1.0
*/
public KeyboardProperties setCustomKeys(List<String> customKeys) {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java index aeec18fb5..4801930f7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java @@ -41,49 +41,49 @@ import java.util.Hashtable; * Used when adding a sub menu to an application menu or existing sub menu.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>parentID</td>
- * <td>Integer</td>
- * <td>The unique ID of an existing submenu to which a command will be added.
- * If this element is not provided, the command will be added to the top level of the Command Menu.
- * <ul>
- * <li>Min: 0</li>
- * <li>Max: 2000000000</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>position</td>
- * <td>Integer</td>
- * <td>Position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
- * Position of any submenu will always be located before the return and exit options.
- * <ul>
- * <li>Min Value: 0</li>
- * <li>Max Value: 1000</li>
- * <li>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</li>
- * <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>parentID</td>
+ * <td>Integer</td>
+ * <td>The unique ID of an existing submenu to which a command will be added.
+ * If this element is not provided, the command will be added to the top level of the Command Menu.
+ * <ul>
+ * <li>Min: 0</li>
+ * <li>Max: 2000000000</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>position</td>
+ * <td>Integer</td>
+ * <td>Position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
+ * Position of any submenu will always be located before the return and exit options.
+ * <ul>
+ * <li>Min Value: 0</li>
+ * <li>Max Value: 1000</li>
+ * <li>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</li>
+ * <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* <tr>
- * <td>menuName</td>
- * <td>String</td>
- * <td>Text which appears in menu, representing this command.
- * <ul>
- * <li>Min: 1</li>
- * <li>Max: 100</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>menuName</td>
+ * <td>String</td>
+ * <td>Text which appears in menu, representing this command.
+ * <ul>
+ * <li>Min: 1</li>
+ * <li>Max: 100</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* <tr>
* <td>secondaryText</td>
* <td>String</td>
@@ -173,10 +173,10 @@ public class MenuParams extends RPCStruct { * Get the position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
* Position of any submenu will always be located before the return and exit options.
* <ul>
- * <li>Min Value: 0</li>
- * <li>Max Value: 1000</li>
- * <li>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</li>
- * <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
+ * <li>Min Value: 0</li>
+ * <li>Max Value: 1000</li>
+ * <li>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</li>
+ * <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
* </ul>
*
* @return the position within the items of the parent Command Menu
@@ -189,10 +189,10 @@ public class MenuParams extends RPCStruct { * Set the position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
* Position of any submenu will always be located before the return and exit options.
* <ul>
- * <li>Min Value: 0</li>
- * <li>Max Value: 1000</li>
- * <li>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</li>
- * <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
+ * <li>Min Value: 0</li>
+ * <li>Max Value: 1000</li>
+ * <li>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</li>
+ * <li>If this element is omitted, the entry will be added at the end of the parent menu.</li>
* </ul>
*
* @param position Mix: 0 Max: 1000
@@ -204,9 +204,9 @@ public class MenuParams extends RPCStruct { /**
* Get the text which appears in menu, representing this command.
- * <ul>
- * <li>Min: 1</li>
- * <li>Max: 100</li>
+ * <ul>
+ * <li>Min: 1</li>
+ * <li>Max: 100</li>
* </ul>
*
* @return menuName the menu name
@@ -218,9 +218,9 @@ public class MenuParams extends RPCStruct { /**
* Set text which appears in menu, representing this command.
- * <ul>
- * <li>Min: 1</li>
- * <li>Max: 100</li>
+ * <ul>
+ * <li>Min: 1</li>
+ * <li>Max: 100</li>
* </ul>
*
* @param menuName the menu name
@@ -236,7 +236,7 @@ public class MenuParams extends RPCStruct { * Sets the secondaryText.
*
* @param secondaryText Optional secondary text to display
- * {"string_min_length": 1, "string_max_length": 500}
+ * {"string_min_length": 1, "string_max_length": 500}
* @since SmartDeviceLink 7.1.0
*/
public MenuParams setSecondaryText(String secondaryText) {
@@ -259,7 +259,7 @@ public class MenuParams extends RPCStruct { * Sets the tertiaryText.
*
* @param tertiaryText Optional tertiary text to display
- * {"string_min_length": 1, "string_max_length": 500}
+ * {"string_min_length": 1, "string_max_length": 500}
* @since SmartDeviceLink 7.1.0
*/
public MenuParams setTertiaryText(String tertiaryText) {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java index e98030756..319dca3c7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java @@ -42,18 +42,18 @@ import java.util.Hashtable; * Information related to the MyKey feature.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Mandatory</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td>e911Override</td>
- * <td>VehicleDataStatus</td>
- * <td>true</td>
- * <td>Indicates whether e911 override is on.</td>
- * </tr>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Mandatory</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>e911Override</td>
+ * <td>VehicleDataStatus</td>
+ * <td>true</td>
+ * <td>Indicates whether e911 override is on.</td>
+ * </tr>
* </table>
*
* @see GetVehicleData
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java index df14be1ac..e095c2d3d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java @@ -44,22 +44,22 @@ import java.util.Hashtable; * <p></p>
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>hashID</td>
- * <td>String</td>
- * <td>Calculated hash ID to be referenced during RegisterAppInterface.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>hashID</td>
+ * <td>String</td>
+ * <td>Calculated hash ID to be referenced during RegisterAppInterface.</td>
* <td>Y</td>
* <td>maxlength: 100</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 3.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java index e155bedad..496b912be 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java @@ -44,30 +44,30 @@ import java.util.Hashtable; * <p></p>
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>event</td>
- * <td>KeyboardEvent</td>
- * <td>On-screen keyboard input data.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>event</td>
+ * <td>KeyboardEvent</td>
+ * <td>On-screen keyboard input data.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 3.0</td>
- * </tr>
- * <tr>
- * <td>data</td>
- * <td>String</td>
- * <td>On-screen keyboard input data.For dynamic keypress events, this will be the current compounded string of entry text.For entry cancelled and entry aborted events, this data param will be omitted.</td>
+ * <td>SmartDeviceLink 3.0</td>
+ * </tr>
+ * <tr>
+ * <td>data</td>
+ * <td>String</td>
+ * <td>On-screen keyboard input data.For dynamic keypress events, this will be the current compounded string of entry text.For entry cancelled and entry aborted events, this data param will be omitted.</td>
* <td></td>
* <td>Maxlength: 500</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
*
* </table>
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java index a2096ccf4..ebe24268a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java @@ -52,71 +52,71 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>requestType</td>
- * <td>RequestType</td>
- * <td>The type of system request.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>requestType</td>
+ * <td>RequestType</td>
+ * <td>The type of system request.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 2.3.2 </td>
- * </tr>
- * </tr>
- * <tr>
- * <td>requestSubType</td>
- * <td>String</td>
- * <td>This parameter is filled for supporting OEM proprietary data exchanges.</td>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
+ * </tr>
+ * <tr>
+ * <td>requestSubType</td>
+ * <td>String</td>
+ * <td>This parameter is filled for supporting OEM proprietary data exchanges.</td>
* <td>N</td>
* <td>Max Length: 255</td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
- * <td>url</td>
- * <td>Array of Strings</td>
- * <td>Optional URL for HTTP requests.If blank, the binary data shall be forwarded to the app.If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.</td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
+ * <td>url</td>
+ * <td>Array of Strings</td>
+ * <td>Optional URL for HTTP requests.If blank, the binary data shall be forwarded to the app.If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.</td>
* <td>N</td>
* <td>minsize:1;</td>
- * <td>SmartDeviceLink 2.3.2 </td>
- * </tr>
- * <tr>
- * <td>timeout</td>
- * <td>Integer</td>
- * <td>Optional timeout for HTTP requests;Required if a URL is provided</td>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
+ * <tr>
+ * <td>timeout</td>
+ * <td>Integer</td>
+ * <td>Optional timeout for HTTP requests;Required if a URL is provided</td>
* <td>N</td>
* <td>minvalue:0; maxvalue: 2000000000</td>
- * <td>SmartDeviceLink </td>
- * </tr>
- * <tr>
- * <td>fileType</td>
- * <td>FileType</td>
- * <td>Optional file type (meant for HTTP file requests).</td>
+ * <td>SmartDeviceLink </td>
+ * </tr>
+ * <tr>
+ * <td>fileType</td>
+ * <td>FileType</td>
+ * <td>Optional file type (meant for HTTP file requests).</td>
* <td>N</td>
* <td></td>
- * <td>SmartDeviceLink 2.3.2 </td>
- * </tr>
- * <tr>
- * <td>offset</td>
- * <td>Float</td>
- * <td>Optional offset in bytes for resuming partial data chunks</td>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
+ * <tr>
+ * <td>offset</td>
+ * <td>Float</td>
+ * <td>Optional offset in bytes for resuming partial data chunks</td>
* <td>N</td>
* <td>minvalue:0; maxvalue:100000000000</td>
- * <td>SmartDeviceLink 2.3.2 </td>
- * </tr>
- * <tr>
- * <td>length</td>
- * <td>Float</td>
- * <td>Optional length in bytes for resuming partial data chunks</td>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
+ * <tr>
+ * <td>length</td>
+ * <td>Float</td>
+ * <td>Optional length in bytes for resuming partial data chunks</td>
* <td>N</td>
* <td>minvalue: 0; maxvalue:100000000000</td>
- * <td>SmartDeviceLink 2.3.2 </td>
- * </tr>
+ * <td>SmartDeviceLink 2.3.2 </td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.3.2
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java index 509dee0e8..07bfa0393 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java @@ -45,30 +45,30 @@ import java.util.List; * <p><b>Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
+ * <th>Version</th>
+ * </tr>
* <tr>
- * <td>type</td>
- * <td>TouchType</td>
- * <td>The type of touch event.</td>
+ * <td>type</td>
+ * <td>TouchType</td>
+ * <td>The type of touch event.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>event</td>
- * <td>TouchEvent</td>
- * <td>List of all individual touches involved in this event.</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>event</td>
+ * <td>TouchEvent</td>
+ * <td>List of all individual touches involved in this event.</td>
* <td>Y</td>
* <td>minsize:1; maxsize:10</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
* </table>
*
* <p><b>Note:</b></p>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java index 32517dc31..8d87f6d30 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java @@ -59,86 +59,86 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>Gps</td>
- * <td>Boolean</td>
- * <td>GPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for details</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>Gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for details</td>
* <td>N</td>
- * <td>Subscribable </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>Speed</td>
- * <td>Float</td>
- * <td>The vehicle speed in kilometers per hour</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>Speed</td>
+ * <td>Float</td>
+ * <td>The vehicle speed in kilometers per hour</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>rpm</td>
- * <td>Integer</td>
- * <td>The number of revolutions per minute of the engine</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Integer</td>
+ * <td>The number of revolutions per minute of the engine</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>fuelLevel</td>
- * <td>Boolean</td>
- * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Boolean</td>
+ * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>fuelLevel_State</td>
- * <td>Boolean</td>
- * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>Boolean</td>
+ * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>fuelRange</td>
- * <td>Boolean</td>
- * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
- * <td>N</td>
- * <td>{"array_min_size": 0, "array_max_size": 100}</td>
- * <td>SmartDeviceLink 5.0.0</td>
- * </tr>
- * <tr>
- * <td>instantFuelConsumption</td>
- * <td>Float</td>
- * <td>The instantaneous fuel consumption in micro litres</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelRange</td>
+ * <td>Boolean</td>
+ * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
+ * <td>N</td>
+ * <td>{"array_min_size": 0, "array_max_size": 100}</td>
+ * <td>SmartDeviceLink 5.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Float</td>
+ * <td>The instantaneous fuel consumption in micro litres</td>
* <td>N</td>
- * <td>Subscribable </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>externalTemperature</td>
- * <td>Float</td>
- * <td>The external temperature in degrees celsius.</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Float</td>
+ * <td>The external temperature in degrees celsius.</td>
* <td>N</td>
- * <td>Subscribable </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>vin</td>
- * <td>String</td>
- * <td>Vehicle identification number.</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>vin</td>
+ * <td>String</td>
+ * <td>Vehicle identification number.</td>
* <td>N</td>
- * <td>Subscribable </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* <tr>
* <td>gearStatus</td>
* <td>GearStatus</td>
@@ -160,151 +160,151 @@ import java.util.List; * <td>N</td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
- * <tr>
- * <td>tirePressure</td>
- * <td>TireStatus</td>
- * <td>Tire pressure status</td>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>TireStatus</td>
+ * <td>Tire pressure status</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>odometer</td>
- * <td>Integer</td>
- * <td>Odometer in km</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Integer</td>
+ * <td>Odometer in km</td>
* <td>N</td>
- * <td>Subscribable </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>beltStatus</td>
- * <td>BeltStatus</td>
- * <td>The status of the seat belts.</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>BeltStatus</td>
+ * <td>The status of the seat belts.</td>
* <td>N</td>
- * <td>Subscribable </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>bodyInformation</td>
- * <td>BodyInformation</td>
- * <td>The body information including power modes.</td>
+ * <td>Subscribable </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>BodyInformation</td>
+ * <td>The body information including power modes.</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>deviceStatus</td>
- * <td>DeviceStatus</td>
- * <td>The connected mobile device status including signal and battery strength.</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>DeviceStatus</td>
+ * <td>The connected mobile device status including signal and battery strength.</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>eCallInfo</td>
- * <td>ECallInfo</td>
- * <td>Emergency Call notification and confirmation data.</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>eCallInfo</td>
+ * <td>ECallInfo</td>
+ * <td>Emergency Call notification and confirmation data.</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>airbagStatus</td>
- * <td>AirBagStatus</td>
- * <td>The status of the air bags.</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>airbagStatus</td>
+ * <td>AirBagStatus</td>
+ * <td>The status of the air bags.</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>emergencyEvent</td>
- * <td>EmergencyEvent</td>
- * <td>Information related to an emergency event (and if it occurred).</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>emergencyEvent</td>
+ * <td>EmergencyEvent</td>
+ * <td>Information related to an emergency event (and if it occurred).</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>clusterModeStatus</td>
- * <td>ClusterModeStatus</td>
- * <td>The status modes of the instrument panel cluster.</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>clusterModeStatus</td>
+ * <td>ClusterModeStatus</td>
+ * <td>The status modes of the instrument panel cluster.</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>myKey</td>
- * <td>MyKey</td>
- * <td>Information related to the MyKey feature.</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>myKey</td>
+ * <td>MyKey</td>
+ * <td>Information related to the MyKey feature.</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
- * <tr>
- * <td>driverBraking</td>
- * <td>vehicleDataEventStatus</td>
- * <td>The status of the brake pedal.</td>
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>vehicleDataEventStatus</td>
+ * <td>The status of the brake pedal.</td>
* <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>wiperStatus</td>
- * <td>WiperStatus</td>
- * <td>The status of the wipers</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>WiperStatus</td>
+ * <td>The status of the wipers</td>
* <td>N</td>
- * <td> </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>headLampStatus</td>
- * <td>headLampStatus</td>
- * <td>Status of the head lamps</td>
+ * <td> </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>headLampStatus</td>
+ * <td>Status of the head lamps</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>engineTorque</td>
- * <td>Float</td>
- * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Float</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
* <td>N</td>
- * <td>minvalue:-1000; maxvalue:2000</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>engineOilLife</td>
- * <td>Float</td>
- * <td>The estimated percentage of remaining oil life of the engine</td>
+ * <td>minvalue:-1000; maxvalue:2000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>engineOilLife</td>
+ * <td>Float</td>
+ * <td>The estimated percentage of remaining oil life of the engine</td>
* <td>N</td>
- * <td>minvalue:0; maxvalue:100</td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
- * <td>accPedalPosition</td>
- * <td>Float</td>
- * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>minvalue:0; maxvalue:100</td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Float</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
* <td>N</td>
- * <td>minvalue: 0; maxvalue:100</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>steeringWheelAngle</td>
- * <td>Float</td>
- * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>minvalue: 0; maxvalue:100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Float</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
* <td>N</td>
- * <td> minvalue: -2000; maxvalue:2000</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>cloudAppVehicleID</td>
- * <td>String</td>
- * <td>ID for the vehicle when connecting to cloud applications</td>
- * <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 5.1 </td>
- * </tr>
+ * <td> minvalue: -2000; maxvalue:2000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>cloudAppVehicleID</td>
+ * <td>String</td>
+ * <td>ID for the vehicle when connecting to cloud applications</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>SmartDeviceLink 5.1 </td>
+ * </tr>
* <tr>
* <td>handsOffSteering</td>
* <td>Boolean</td>
@@ -326,7 +326,7 @@ import java.util.List; * <td>N</td>
* <td></td>
* <td>
- * @since SmartDeviceLink 7.1.0
+ * @since SmartDeviceLink 7.1.0
* </td>
* </tr>
* <tr>
@@ -409,7 +409,6 @@ public class OnVehicleData extends RPCNotification { * @since SmartDeviceLink 7.1.0
*/
public static final String KEY_SEAT_OCCUPANCY = "seatOccupancy";
-
public OnVehicleData() {
super(FunctionID.ON_VEHICLE_DATA.toString());
}
@@ -495,8 +494,8 @@ public class OnVehicleData extends RPCNotification { * Sets the externalTemperature.
*
* @param externalTemperature The external temperature in degrees celsius. This parameter is deprecated starting RPC
- * Spec 7.1.0, please see climateData.
- * {"num_min_value": -40.0, "num_max_value": 100.0}
+ * Spec 7.1.0, please see climateData.
+ * {"num_min_value": -40.0, "num_max_value": 100.0}
* @since SmartDeviceLink 2.0.0
* @deprecated in SmartDeviceLink 7.1.0
*/
@@ -924,7 +923,6 @@ public class OnVehicleData extends RPCNotification { public ClimateData getClimateData() {
return (ClimateData) getObject(ClimateData.class, KEY_CLIMATE_DATA);
}
-
/**
* Sets the seatOccupancy.
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java index 26e80aa06..cd563bc64 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java @@ -42,36 +42,36 @@ import java.util.List; * Defining sets of parameters, which are permitted or prohibited for a given RPC.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>allowed</td>
- * <td>String</td>
- * <td>A set of all parameters that are permitted for this given RPC.
- * <ul>
- * <li>Min size: 0</li>
- * <li>Max size: 100</li>
- * <li>Max length: 100</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>userDisallowed</td>
- * <td>String</td>
- * <td>A set of all parameters that are prohibited for this given RPC.
- * <ul>
- * <li>Min size: 0</li>
- * <li>Max size: 100</li>
- * <li>Max length: 100</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>allowed</td>
+ * <td>String</td>
+ * <td>A set of all parameters that are permitted for this given RPC.
+ * <ul>
+ * <li>Min size: 0</li>
+ * <li>Max size: 100</li>
+ * <li>Max length: 100</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>userDisallowed</td>
+ * <td>String</td>
+ * <td>A set of all parameters that are prohibited for this given RPC.
+ * <ul>
+ * <li>Min size: 0</li>
+ * <li>Max size: 100</li>
+ * <li>Max length: 100</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java index dea5997d1..088ef5c8e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java @@ -52,70 +52,70 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th> Version</th>
- * </tr>
- * <tr>
- * <td>initialPrompt</td>
- * <td>TTSChunk[]</td>
- * <td>SDL will speak this prompt before opening the audio pass thru session. </td>
+ * <th> Version</th>
+ * </tr>
+ * <tr>
+ * <td>initialPrompt</td>
+ * <td>TTSChunk[]</td>
+ * <td>SDL will speak this prompt before opening the audio pass thru session. </td>
* <td>N</td>
* <td>This is an array of text chunks of type TTSChunk. The array must have at least one item If omitted, then no initial prompt is spoken: <p>Array Minsize: 1</p> Array Maxsize: 100</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>audioPassThruDisplayText1</td>
- * <td>String</td>
- * <td>First line of text displayed during audio capture.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>audioPassThruDisplayText1</td>
+ * <td>String</td>
+ * <td>First line of text displayed during audio capture.</td>
* <td>N</td>
* <td>Maxlength = 500</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>samplingRate</td>
- * <td>SamplingRate</td>
- * <td>This value shall is allowed to be 8 or 16 or 22 or 44 khz.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>samplingRate</td>
+ * <td>SamplingRate</td>
+ * <td>This value shall is allowed to be 8 or 16 or 22 or 44 khz.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>maxDuration</td>
- * <td>Integer</td>
- * <td>The maximum duration of audio recording in milliseconds.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>maxDuration</td>
+ * <td>Integer</td>
+ * <td>The maximum duration of audio recording in milliseconds.</td>
* <td>Y</td>
* <td>Minvalue: 1; Maxvalue: 1000000</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>bitsPerSample</td>
- * <td>BitsPerSample</td>
- * <td>Specifies the quality the audio is recorded - 8 bit or 16 bit.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>bitsPerSample</td>
+ * <td>BitsPerSample</td>
+ * <td>Specifies the quality the audio is recorded - 8 bit or 16 bit.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>audioType</td>
- * <td>AudioType</td>
- * <td>Specifies the type of audio data being requested.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>audioType</td>
+ * <td>AudioType</td>
+ * <td>Specifies the type of audio data being requested.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>muteAudio</td>
- * <td>Boolean</td>
- * <td>N</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>muteAudio</td>
+ * <td>Boolean</td>
+ * <td>N</td>
* <td>N</td>
* <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
*
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java index 1a1c254b4..adbb09e52 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java @@ -56,94 +56,94 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>initialText</td>
- * <td>String</td>
- * <td>Displayed when the interaction begins. This text may be overlaid by the "Listening" prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncated</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>initialText</td>
+ * <td>String</td>
+ * <td>Displayed when the interaction begins. This text may be overlaid by the "Listening" prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncated</td>
* <td>Y</td>
- * <td>maxlength:500</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>initialPrompt</td>
- * <td>TTSChunk</td>
- * <td>An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction.</td>
+ * <td>maxlength:500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>initialPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction.</td>
* <td>Y</td>
- * <td>minsize:1; maxsize:100</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>interactionMode</td>
- * <td>InteractionMode</td>
- * <td>Indicates how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH). </td>
+ * <td>minsize:1; maxsize:100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>interactionMode</td>
+ * <td>InteractionMode</td>
+ * <td>Indicates how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH). </td>
* <td>Y</td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>interactionChoiceSetIDList</td>
- * <td>Integer</td>
- * <td>Array of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>interactionChoiceSetIDList</td>
+ * <td>Integer</td>
+ * <td>Array of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets.</td>
* <td>Y</td>
- * <td>minsize:0; maxsize:100; minvalue:0; maxvalue:2000000000</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>helpPrompt</td>
- * <td>TTSChunk</td>
- * <td>An array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session. If this parameter is omitted, the help prompt will be constructed by SDL from the first vrCommand of each choice of all the Choice Sets specified in the interactionChoiceSetIDList parameter. </td>
+ * <td>minsize:0; maxsize:100; minvalue:0; maxvalue:2000000000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>helpPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>An array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session. If this parameter is omitted, the help prompt will be constructed by SDL from the first vrCommand of each choice of all the Choice Sets specified in the interactionChoiceSetIDList parameter. </td>
* <td>N</td>
- * <td>minsize:1; maxsize:100; The helpPrompt specified in SetGlobalProperties is not used by PerformInteraction.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>timeoutPrompt</td>
- * <td>TTSChunk</td>
- * <td>An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session. If this parameter is omitted, the timeout prompt will be the same as the help prompt (see helpPrompt parameter). </td>
+ * <td>minsize:1; maxsize:100; The helpPrompt specified in SetGlobalProperties is not used by PerformInteraction.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>timeoutPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session. If this parameter is omitted, the timeout prompt will be the same as the help prompt (see helpPrompt parameter). </td>
* <td>N</td>
- * <td>The timeoutPrompt specified in SetGlobalProperties is not used by PerformInteraction. minsize:1;maxsize:100</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>timeout</td>
- * <td>Integer</td>
- * <td>The amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu). If this time elapses without the user making a choice, the timeoutPrompt will be spoken. After this timeout value has been reached, the interaction will stop and a subsequent interaction will take place after SDL speaks the timeout prompt. If that times out as well, the interaction will end completely. If omitted, the default is 10000ms.</td>
+ * <td>The timeoutPrompt specified in SetGlobalProperties is not used by PerformInteraction. minsize:1;maxsize:100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>timeout</td>
+ * <td>Integer</td>
+ * <td>The amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu). If this time elapses without the user making a choice, the timeoutPrompt will be spoken. After this timeout value has been reached, the interaction will stop and a subsequent interaction will take place after SDL speaks the timeout prompt. If that times out as well, the interaction will end completely. If omitted, the default is 10000ms.</td>
* <td>N</td>
- * <td>minvalue:5000; maxvalue:100000; defvalue:10000</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>vrHelp</td>
- * <td>VrHelpItem</td>
- * <td>Ability to send suggested VR Help Items to display on-screen during Perform Interaction If omitted on supported displays, the default SDL generated list of suggested choices will be displayed.</td>
+ * <td>minvalue:5000; maxvalue:100000; defvalue:10000</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>vrHelp</td>
+ * <td>VrHelpItem</td>
+ * <td>Ability to send suggested VR Help Items to display on-screen during Perform Interaction If omitted on supported displays, the default SDL generated list of suggested choices will be displayed.</td>
* <td>N</td>
- * <td>Min = 1;Max = 100</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>interactionLayout</td>
- * <td>LayoutMode</td>
- * <td>See {@linkplain LayoutMode}</td>
+ * <td>Min = 1;Max = 100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>interactionLayout</td>
+ * <td>LayoutMode</td>
+ * <td>See {@linkplain LayoutMode}</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 3.0</td>
- * </tr>
- * <tr>
- * <td>cancelID</td>
- * <td>Integer</td>
- * <td>An ID for this specific perform interaction to allow cancellation through the `CancelInteraction` RPC.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 3.0</td>
+ * </tr>
+ * <tr>
+ * <td>cancelID</td>
+ * <td>Integer</td>
+ * <td>An ID for this specific perform interaction to allow cancellation through the `CancelInteraction` RPC.</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 6.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 6.0</td>
+ * </tr>
* </table>
*
* @see CreateInteractionChoiceSet
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java index 473cd409f..d7d902c5c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java @@ -43,39 +43,39 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>rpcName</td>
- * <td>String</td>
- * <td>Name of the individual RPC in the policy table.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>rpcName</td>
+ * <td>String</td>
+ * <td>Name of the individual RPC in the policy table.</td>
* <td></td>
- * <td>maxlength:100</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>hmiPermissions</td>
- * <td>HMIPermissions</td>
- * <td>Sets of parameters, which are permitted or prohibited for the given RPC.</td>
+ * <td>maxlength:100</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>hmiPermissions</td>
+ * <td>HMIPermissions</td>
+ * <td>Sets of parameters, which are permitted or prohibited for the given RPC.</td>
* <td></td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
- * <tr>
- * <td>parameterPermissions</td>
- * <td>ParameterPermissions</td>
- * <td>Sets of parameters, which are permitted or prohibited for the given RPC.</td>
+ * <tr>
+ * <td>parameterPermissions</td>
+ * <td>ParameterPermissions</td>
+ * <td>Sets of parameters, which are permitted or prohibited for the given RPC.</td>
* <td></td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java index 260cfb26a..1efdcc75f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java @@ -41,19 +41,19 @@ import java.util.Hashtable; * Contains information about on-screen preset capabilities.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>onScreenPresetsAvailable</td>
- * <td>Boolean</td>
- * <td>Defines, if Onscreen custom presets are available.
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>onScreenPresetsAvailable</td>
+ * <td>Boolean</td>
+ * <td>Defines, if Onscreen custom presets are available.
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java index 3041c9c06..0c37d25ea 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java @@ -47,70 +47,70 @@ import java.util.zip.CRC32; * <p><b> Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>FileName</td>
- * <td>String</td>
- * <td>File reference name.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>FileName</td>
+ * <td>String</td>
+ * <td>File reference name.</td>
* <td>Y</td>
- * <td>Maxlength=500</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>fileType</td>
- * <td>FileType</td>
- * <td>Selected file type.</td>
+ * <td>Maxlength=500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>fileType</td>
+ * <td>FileType</td>
+ * <td>Selected file type.</td>
* <td>Y</td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>persistentFile</td>
- * <td>Boolean</td>
- * <td>Indicates if the file is meant to persist between sessions / ignition cycles. If set to TRUE,then the system will aim to persist this file through session / cycles. While files with this designation will have priority over others,they are subject to deletion by the system at any time.In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. If omitted, the value will be set to false.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>persistentFile</td>
+ * <td>Boolean</td>
+ * <td>Indicates if the file is meant to persist between sessions / ignition cycles. If set to TRUE,then the system will aim to persist this file through session / cycles. While files with this designation will have priority over others,they are subject to deletion by the system at any time.In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. If omitted, the value will be set to false.</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>systemFile</td>
- * <td>Boolean</td>
- * <td>Indicates if the file is meant to be passed thru core to elsewhere on the system. If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core. If omitted, the value will be set to false.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>systemFile</td>
+ * <td>Boolean</td>
+ * <td>Indicates if the file is meant to be passed thru core to elsewhere on the system. If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core. If omitted, the value will be set to false.</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
- * <tr>
- * <td>offset</td>
- * <td>Float</td>
- * <td>Optional offset in bytes for resuming partial data chunks</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>offset</td>
+ * <td>Float</td>
+ * <td>Optional offset in bytes for resuming partial data chunks</td>
* <td>N</td>
- * <td>Minvalue=0; Maxvalue=100000000000</td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
- * <tr>
- * <td>length</td>
- * <td>Float</td>
- * <td>Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded</td>
+ * <td>Minvalue=0; Maxvalue=100000000000</td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>length</td>
+ * <td>Float</td>
+ * <td>Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded</td>
* <td>N</td>
- * <td>Minvalue=0; Maxvalue=100000000000</td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
- * <tr>
- * <td>crc</td>
- * <td>Long</td>
- * <td>Additional CRC32 checksum to protect data integrity up to 512 Mbits .</td>
+ * <td>Minvalue=0; Maxvalue=100000000000</td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>crc</td>
+ * <td>Long</td>
+ * <td>Additional CRC32 checksum to protect data integrity up to 512 Mbits .</td>
* <td>N</td>
- * <td>minvalue="0" maxvalue="4294967295"</td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
+ * <td>minvalue="0" maxvalue="4294967295"</td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
* </table>
* <p> <b>Note: </b></p>
* When using PutFiles you may want to check for memory
@@ -118,32 +118,32 @@ import java.util.zip.CRC32; * <p><b>Response</b> </p>
* Response is sent, when the file data was copied (success case). Or when an error occurred. Not supported on First generation SDL modules.
*
- * <p><b> Non-default Result Codes:</b></p>
- * <p> SUCCESS</p>
- * <p> INVALID_DATA</p>
- * <p> OUT_OF_MEMORY</p>
- * <p> TOO_MANY_PENDING_REQUESTS</p>
- * <p> APPLICATION_NOT_REGISTERED</p>
- * <p> GENERIC_ERROR</p>
- * <p>REJECTED</p>
+ * <p><b> Non-default Result Codes:</b></p>
+ * <p> SUCCESS</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR</p>
+ * <p>REJECTED</p>
*
* <p><table border="1" rules="all"></p>
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>spaceAvailable</td>
- * <td>Integer</td>
- * <td>Provides the total local space available on SDL for the registered app.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>spaceAvailable</td>
+ * <td>Integer</td>
+ * <td>Provides the total local space available on SDL for the registered app.</td>
* <td></td>
- * <td>Minvalue=0; Maxvalue=2000000000</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>Minvalue=0; Maxvalue=2000000000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
* </table>
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java index b09558d55..84393121a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java @@ -39,34 +39,34 @@ import java.util.Hashtable; * A color class that stores RGB values * <p><b> Parameter List</b></p> * <table border="1" rules="all"> - * <tr> - * <th>Name</th> - * <th>Type</th> - * <th>Reg.</th> - * <th>Notes</th> - * <th>Version Available</th> - * </tr> - * <tr> - * <td>red</td> - * <td>Integer</td> - * <td>Y</td> - * <td><ul><li>minvalue="0"</li><li>maxvalue="255"</li></ul></td> - * <td>SmartDeviceLink 5.0</td> - * </tr> - * <tr> - * <td>green</td> - * <td>Integer</td> - * <td>Y</td> - * <td><ul><li>minvalue="0"</li><li>maxvalue="255"</li></ul></td> - * <td>SmartDeviceLink 5.0</td> - * </tr> - * <tr> - * <td>blue</td> - * <td>Integer</td> - * <td>Y</td> - * <td><ul><li>minvalue="0"</li><li>maxvalue="255"</li></ul></td> - * <td>SmartDeviceLink 5.0</td> - * </tr> + * <tr> + * <th>Name</th> + * <th>Type</th> + * <th>Reg.</th> + * <th>Notes</th> + * <th>Version Available</th> + * </tr> + * <tr> + * <td>red</td> + * <td>Integer</td> + * <td>Y</td> + * <td><ul><li>minvalue="0"</li><li>maxvalue="255"</li></ul></td> + * <td>SmartDeviceLink 5.0</td> + * </tr> + * <tr> + * <td>green</td> + * <td>Integer</td> + * <td>Y</td> + * <td><ul><li>minvalue="0"</li><li>maxvalue="255"</li></ul></td> + * <td>SmartDeviceLink 5.0</td> + * </tr> + * <tr> + * <td>blue</td> + * <td>Integer</td> + * <td>Y</td> + * <td><ul><li>minvalue="0"</li><li>maxvalue="255"</li></ul></td> + * <td>SmartDeviceLink 5.0</td> + * </tr> * </table> * * @since SmartDeviceLink 5.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java index ad20efb1b..91d95c848 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java @@ -50,38 +50,38 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>ecuName</td>
- * <td>Integer</td>
- * <td>Name of ECU.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>ecuName</td>
+ * <td>Integer</td>
+ * <td>Name of ECU.</td>
* <td>Y</td>
- * <td>Minvalue: 0; Maxvalue: 65535</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>Minvalue: 0; Maxvalue: 65535</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
- * <tr>
- * <td>didLocation</td>
- * <td>Integer</td>
- * <td>Get raw data from vehicle data DID location(s).</td>
+ * <tr>
+ * <td>didLocation</td>
+ * <td>Integer</td>
+ * <td>Get raw data from vehicle data DID location(s).</td>
* <td>Y</td>
- * <td>Minvalue: 0; Maxvalue: 65535</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <td>appID</td>
- * <td>Integer</td>
- * <td>ID of the application that requested this RPC.</td>
+ * <td>Minvalue: 0; Maxvalue: 65535</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <td>appID</td>
+ * <td>Integer</td>
+ * <td>ID of the application that requested this RPC.</td>
* <td>Y</td>
- * <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* <p><b>Response</b></p>
@@ -128,8 +128,8 @@ public class ReadDID extends RPCRequest { * @param didLocation a List<Integer> value representing raw data from vehicle data DID location(s) <br>
* <b>Notes: </b>
* <ul>
- * <li>Minvalue:0; Maxvalue:65535</li>
- * <li>ArrayMin:0; ArrayMax:1000</li>
+ * <li>Minvalue:0; Maxvalue:65535</li>
+ * <li>ArrayMin:0; ArrayMax:1000</li>
* </ul>
*/
public ReadDID(@NonNull Integer ecuName, @NonNull List<Integer> didLocation) {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java index 5d7586d5c..311095cea 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java @@ -111,170 +111,170 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>MsgVersion</td>
- * <td>MsgVersion</td>
- * <td>Declares what version of the SDL interface the application expects to use with SDL</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>MsgVersion</td>
+ * <td>MsgVersion</td>
+ * <td>Declares what version of the SDL interface the application expects to use with SDL</td>
* <td>Y</td>
* <td>To be compatible, app msg major version number must be less than or equal to SDL major version number. <p>If msg versions are incompatible, app has 20 seconds to attempt successful RegisterAppInterface (w.r.t. msg version) on underlying protocol session, else will be terminated. Major version number is a compatibility declaration. Minor version number indicates minor functional variations (e.g. features, capabilities, bug fixes) when sent from SDL to app (in RegisterAppInterface response).</p>However, the minor version number sent from the app to SDL (in RegisterAppInterface request) is ignored by SDL.</td>
- * <td>SmartDeviceLink 1.0 </td>
- * </tr>
- * <tr>
- * <td>appName</td>
- * <td>String</td>
- * <td>The mobile application's name. This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SDL .</td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>appName</td>
+ * <td>String</td>
+ * <td>The mobile application's name. This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SDL .</td>
* <td>Y</td>
* <td><p> Must be 1-100 characters in length. Must consist of following characters: </p><p>May not be the same (by case insensitive comparison) as the name or any synonym of any currently registered application.</p> </td>
- * <td>SmartDeviceLink 1.0 </td>
- * </tr>
- * <tr>
- * <td>ttsName</td>
- * <td>TTSChunk</td>
- * <td>TTS string for VR recognition of the mobile application name. Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.</td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>ttsName</td>
+ * <td>TTSChunk</td>
+ * <td>TTS string for VR recognition of the mobile application name. Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.</td>
* <td>N</td>
* <td><p>Size must be 1-100 Needs to be unique over all applications. May not be empty.<p>May not start with a new line character.</p></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>ngnMediaScreenAppName</td>
- * <td>String</td>
- * <td>Provides an abbreviated version of the app name (if necessary) that will be displayed on the NGN media screen.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>ngnMediaScreenAppName</td>
+ * <td>String</td>
+ * <td>Provides an abbreviated version of the app name (if necessary) that will be displayed on the NGN media screen.</td>
* <td>N</td>
* <td>- Must be 1-5 characters. If not provided, value will be derived from appName truncated to 5 characters.</td>
- * <td>SmartDeviceLink 1.0 </td>
- * </tr>
- * <tr>
- * <td>vrSynonyms</td>
- * <td>String</td>
- * <td>An array of 1-100 elements, each element containing a voice-recognition synonym by which this app can be called when being addressed in the mobile applications menu.</td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>vrSynonyms</td>
+ * <td>String</td>
+ * <td>An array of 1-100 elements, each element containing a voice-recognition synonym by which this app can be called when being addressed in the mobile applications menu.</td>
* <td>N</td>
* <td>Each vr synonym is limited to 40 characters, and there can be 1-100 synonyms in array. May not be the same (by case insensitive comparison) as the name or any synonym of any currently-registered application.</td>
- * <td>SmartDeviceLink 1.0 </td>
- * </tr>
- * <tr>
- * <td>isMediaApplication</td>
- * <td>Boolean</td>
- * <td>Indicates that the application will be streaming audio to SDL (via A2DP) that is audible outside of the BT media source.</td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>isMediaApplication</td>
+ * <td>Boolean</td>
+ * <td>Indicates that the application will be streaming audio to SDL (via A2DP) that is audible outside of the BT media source.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 1.0 </td>
- * </tr>
- * <tr>
- * <td>languageDesired</td>
- * <td>Language</td>
- * <td>An enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR).</td>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>languageDesired</td>
+ * <td>Language</td>
+ * <td>An enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR).</td>
* <td>Y</td>
* <td>If the language indicated does not match the active language on SDL, the interface registration will be rejected.If the user changes the SDL language while this interface registration is active, the interface registration will be terminated. </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>hmiDisplayLanguageDesired</td>
- * <td>Language</td>
- * <td>An enumeration indicating what language the application intends to use for user interaction ( Display).</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>hmiDisplayLanguageDesired</td>
+ * <td>Language</td>
+ * <td>An enumeration indicating what language the application intends to use for user interaction ( Display).</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>appHMIType</td>
- * <td>AppHMIType</td>
- * <td>List of all applicable app types stating which classifications to be given to the app.e.g. for platforms , like GEN2, this will determine which "corner(s)" the app can populate</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>appHMIType</td>
+ * <td>AppHMIType</td>
+ * <td>List of all applicable app types stating which classifications to be given to the app.e.g. for platforms , like GEN2, this will determine which "corner(s)" the app can populate</td>
* <td>N</td>
* <td>Array Minsize: 1; Array Maxsize: 100</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>hashID</td>
- * <td>String</td>
- * <td>ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. If omitted, then the previous state of an app's commands, etc. will not be restored.When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). </td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>hashID</td>
+ * <td>String</td>
+ * <td>ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. If omitted, then the previous state of an app's commands, etc. will not be restored.When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). </td>
* <td>N</td>
* <td>maxLength:100</td>
- * <td>SmartDeviceLink 2.3.1 </td>
- * </tr>
- * <tr>
- * <td>appInfo</td>
- * <td>AppInfo</td>
- * <td>See AppInfo.</td>
+ * <td>SmartDeviceLink 2.3.1 </td>
+ * </tr>
+ * <tr>
+ * <td>appInfo</td>
+ * <td>AppInfo</td>
+ * <td>See AppInfo.</td>
* <td>N</td>
* <td></td>
- * <td>@since SmartDeviceLink 4.2.0 </td>
- * </tr>
- * <tr>
- * <td>deviceInfo</td>
- * <td>DeviceInfo</td>
- * <td>Various information about connecting device.</td>
+ * <td>@since SmartDeviceLink 4.2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceInfo</td>
+ * <td>DeviceInfo</td>
+ * <td>Various information about connecting device.</td>
* <td>N</td>
* <td></td>
- * <td>SmartDeviceLink 2.3.1 </td>
- * </tr>
- * <tr>
- * <td>appID</td>
- * <td>String</td>
- * <td>ID used to validate app with policy table entries</td>
+ * <td>SmartDeviceLink 2.3.1 </td>
+ * </tr>
+ * <tr>
+ * <td>appID</td>
+ * <td>String</td>
+ * <td>ID used to validate app with policy table entries</td>
* <td>Y</td>
* <td>maxLength: 100</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>fullAppID</td>
- * <td>String</td>
- * <td>ID used to validate app with policy table entries</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fullAppID</td>
+ * <td>String</td>
+ * <td>ID used to validate app with policy table entries</td>
* <td>N</td>
* <td>Maxlength: 100</td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
- * <td>hmiCapabilities</td>
- * <td>HMICapabilities</td>
- * <td>Specifies the HMI capabilities.</td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
+ * <td>hmiCapabilities</td>
+ * <td>HMICapabilities</td>
+ * <td>Specifies the HMI capabilities.</td>
* <td>N</td>
* <td></td>
- * <td>SmartDeviceLink 2.3.2.2 </td>
- * </tr>
+ * <td>SmartDeviceLink 2.3.2.2 </td>
+ * </tr>
*
- * <tr>
- * <td>sdlVersion</td>
- * <td>String</td>
- * <td>The SmartDeviceLink version.</td>
+ * <tr>
+ * <td>sdlVersion</td>
+ * <td>String</td>
+ * <td>The SmartDeviceLink version.</td>
* <td>N</td>
* <td>Maxlength: 100</td>
- * <td>SmartDeviceLink 2.3.2.2</td>
- * </tr>
+ * <td>SmartDeviceLink 2.3.2.2</td>
+ * </tr>
*
- * <tr>
- * <td>systemSoftwareVersion</td>
- * <td>String</td>
- * <td>The software version of the system that implements the SmartDeviceLink core.</td>
+ * <tr>
+ * <td>systemSoftwareVersion</td>
+ * <td>String</td>
+ * <td>The software version of the system that implements the SmartDeviceLink core.</td>
* <td>N</td>
* <td>Maxlength: 100</td>
- * <td>SmartDeviceLink 2.3.2.2</td>
- * </tr>
+ * <td>SmartDeviceLink 2.3.2.2</td>
+ * </tr>
*
- * <tr>
- * <td>dayColorScheme</td>
- * <td>TemplateColorScheme</td>
- * <td>The color scheme that is used for day.</td>
+ * <tr>
+ * <td>dayColorScheme</td>
+ * <td>TemplateColorScheme</td>
+ * <td>The color scheme that is used for day.</td>
* <td>N</td>
* <td></td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
*
- * <tr>
- * <td>nightColorScheme</td>
- * <td>TemplateColorScheme</td>
- * <td>The color scheme that is used for night.</td>
+ * <tr>
+ * <td>nightColorScheme</td>
+ * <td>TemplateColorScheme</td>
+ * <td>The color scheme that is used for night.</td>
* <td>N</td>
* <td></td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
* </table>
* <p></p>
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java index 6dbbbe9e8..d4ae5a706 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterfaceResponse.java @@ -384,9 +384,8 @@ public class RegisterAppInterfaceResponse extends RPCResponse { /**
* Gets getVehicleType set when application interface is registered.
- *
- * @return vehicleType
* @deprecated in SmartDeviceLink 7.1.0
+ * @return vehicleType
*/
@Deprecated
public VehicleType getVehicleType() {
@@ -395,9 +394,8 @@ public class RegisterAppInterfaceResponse extends RPCResponse { /**
* Sets vehicleType
- *
- * @param vehicleType
* @deprecated in SmartDeviceLink 7.1.0
+ * @param vehicleType
*/
@Deprecated
public RegisterAppInterfaceResponse setVehicleType(VehicleType vehicleType) {
@@ -474,7 +472,6 @@ public class RegisterAppInterfaceResponse extends RPCResponse { /**
* The software version of the connected device.
- *
* @param systemSoftwareVersion the version of software on the connected device
* @return RegisterAppInterface
* @deprecated in SmartDeviceLink 7.1.0
@@ -487,7 +484,6 @@ public class RegisterAppInterfaceResponse extends RPCResponse { /**
* The software version of the connected device.
- *
* @return String the version of software on the connected device
* @deprecated in SmartDeviceLink 7.1.0
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java index f845d4c03..ef84adc85 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java @@ -55,22 +55,22 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>properties</td>
- * <td>GlobalProperty</td>
- * <td>An array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>properties</td>
+ * <td>GlobalProperty</td>
+ * <td>An array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value.</td>
* <td>Y</td>
- * <td>Array must have at least one element.; minsize:1; maxsize:100</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>Array must have at least one element.; minsize:1; maxsize:100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
*
* </table>
* <p><b>Response</b></p>
@@ -79,14 +79,14 @@ import java.util.List; *
* <p><b>Non-default Result Codes:</b></p>
*
- * <p> SUCCESS</p>
- * <p>INVALID_DATA</p>
- * <p> OUT_OF_MEMORY</p>
- * <p> TOO_MANY_PENDING_REQUESTS</p>
- * <p> APPLICATION_NOT_REGISTERED</p>
- * <p> GENERIC_ERROR </p>
- * <p> REJECTED </p>
- * <p>DISALLOWED </p>
+ * <p> SUCCESS</p>
+ * <p>INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
+ * <p> TOO_MANY_PENDING_REQUESTS</p>
+ * <p> APPLICATION_NOT_REGISTERED</p>
+ * <p> GENERIC_ERROR </p>
+ * <p> REJECTED </p>
+ * <p>DISALLOWED </p>
*
* @see SetGlobalProperties
* @since SmartDeviceLink 1.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RoofStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RoofStatus.java index 8bf54ee13..1bc28d7cf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RoofStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RoofStatus.java @@ -89,8 +89,7 @@ public class RoofStatus extends RPCStruct { /** * Constructs a new RoofStatus object */ - public RoofStatus() { - } + public RoofStatus() { } /** * Constructs a new RoofStatus object indicated by the Hashtable parameter diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java index ef02964d4..5f1d049f0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java @@ -42,30 +42,30 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>resolution</td>
- * <td>ImageResolution</td>
- * <td>The resolution of the prescribed screen area.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>resolution</td>
+ * <td>ImageResolution</td>
+ * <td>The resolution of the prescribed screen area.</td>
* <td>Y</td>
- * <td></td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
- * <tr>
- * <td>touchEventAvailable</td>
- * <td>TouchEventCapabilities</td>
- * <td>Types of screen touch events available in screen area.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>touchEventAvailable</td>
+ * <td>TouchEventCapabilities</td>
+ * <td>Types of screen touch events available in screen area.</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
*
* </table>
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java index 644c1708b..019b3d55f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java @@ -51,60 +51,60 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>scrollableMessageBody</td>
- * <td>String</td>
- * <td>Body of text that can include newlines and tabs.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>scrollableMessageBody</td>
+ * <td>String</td>
+ * <td>Body of text that can include newlines and tabs.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDevice Link 1.0 </td>
- * </tr>
- * <tr>
- * <td>timeout</td>
- * <td>Integer</td>
- * <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</td>
+ * <td>SmartDevice Link 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>timeout</td>
+ * <td>Integer</td>
+ * <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).</td>
* <td>N</td>
* <td>minValue=1000; maxValue=65535; defValue=30000</td>
- * <td>SmartDevice Link 1.0 </td>
- * </tr>
- * <tr>
- * <td>softButtons</td>
- * <td>SoftButton</td>
- * <td>App defined SoftButtons. If omitted on supported displays, only the system defined "Close" SoftButton will be displayed.</td>
+ * <td>SmartDevice Link 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>softButtons</td>
+ * <td>SoftButton</td>
+ * <td>App defined SoftButtons. If omitted on supported displays, only the system defined "Close" SoftButton will be displayed.</td>
* <td>N</td>
* <td>minsize=0; maxsize=8</td>
- * <td>SmartDevice Link 1.0 </td>
- * </tr>
- * <tr>
- * <td>cancelID</td>
- * <td>Integer</td>
- * <td>An ID for this specific ScrollableMessage to allow cancellation through the `CancelInteraction` RPC.</td>
+ * <td>SmartDevice Link 1.0 </td>
+ * </tr>
+ * <tr>
+ * <td>cancelID</td>
+ * <td>Integer</td>
+ * <td>An ID for this specific ScrollableMessage to allow cancellation through the `CancelInteraction` RPC.</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 6.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 6.0</td>
+ * </tr>
* </table>
* <p> <b>Response</b></p>
* <b>Non-default Result Codes:</b>
- * <p>SUCCESS</p>
- * <p>INVALID_DATA </p>
- * <p>OUT_OF_MEMORY</p>
- * <p>CHAR_LIMIT_EXCEEDED</p>
- * <p>TOO_MANY_PENDING_REQUESTS</p>
- * <p>APPLICATION_NOT_REGISTERED</p>
- * <p>GENERIC_ERROR </p>
- * <p>DISALLOWED</p>
- * <p>UNSUPPORTED_RESOURCE</p>
- * <p>REJECTED </p>
- * <p>ABORTED</p>
+ * <p>SUCCESS</p>
+ * <p>INVALID_DATA </p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>CHAR_LIMIT_EXCEEDED</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR </p>
+ * <p>DISALLOWED</p>
+ * <p>UNSUPPORTED_RESOURCE</p>
+ * <p>REJECTED </p>
+ * <p>ABORTED</p>
* <p>
* @see com.smartdevicelink.proxy.rpc.SoftButton
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java index 3aa0773cf..f67d3caf0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java @@ -42,34 +42,34 @@ import java.util.Hashtable; * Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>majorVersion</td>
- * <td>Integer</td>
- * <td>
- * <ul>
- * <li>minvalue="1"</li>
- * <li>maxvalue="10"</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>minorVersion</td>
- * <td>Integer</td>
- * <td>
- * <ul>
- * <li>minvalue="0"</li>
- * <li>maxvalue="1000"</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>majorVersion</td>
+ * <td>Integer</td>
+ * <td>
+ * <ul>
+ * <li>minvalue="1"</li>
+ * <li>maxvalue="10"</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>minorVersion</td>
+ * <td>Integer</td>
+ * <td>
+ * <ul>
+ * <li>minvalue="0"</li>
+ * <li>maxvalue="1000"</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 1.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatOccupancy.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatOccupancy.java index 9aa329c8b..c54ae0ef0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatOccupancy.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatOccupancy.java @@ -37,6 +37,7 @@ import java.util.Hashtable; import java.util.List; /** + * * <p><b>Parameter List</b></p> * * <table border="1" rules="all"> @@ -65,7 +66,6 @@ import java.util.List; * <td></td> * </tr> * </table> - * * @since SmartDeviceLink 7.1.0 */ public class SeatOccupancy extends RPCStruct { @@ -75,8 +75,7 @@ public class SeatOccupancy extends RPCStruct { /** * Constructs a new SeatOccupancy object */ - public SeatOccupancy() { - } + public SeatOccupancy() { } /** * Constructs a new SeatOccupancy object indicated by the Hashtable parameter @@ -91,7 +90,7 @@ public class SeatOccupancy extends RPCStruct { * Sets the seatsOccupied. * * @param seatsOccupied Seat status array containing location and whether the seats are occupied. - * {"array_min_size": 0, "array_max_size": 100} + * {"array_min_size": 0, "array_max_size": 100} */ public SeatOccupancy setSeatsOccupied(List<SeatStatus> seatsOccupied) { setValue(KEY_SEATS_OCCUPIED, seatsOccupied); @@ -113,7 +112,7 @@ public class SeatOccupancy extends RPCStruct { * Sets the seatsBelted. * * @param seatsBelted Seat status array containing location and whether the seats are belted. - * {"array_min_size": 0, "array_max_size": 100} + * {"array_min_size": 0, "array_max_size": 100} */ public SeatOccupancy setSeatsBelted(List<SeatStatus> seatsBelted) { setValue(KEY_SEATS_BELTED, seatsBelted); diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatStatus.java index 57b7713bd..65f60c8ff 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeatStatus.java @@ -78,8 +78,7 @@ public class SeatStatus extends RPCStruct { /** * Constructs a new SeatStatus object */ - public SeatStatus() { - } + public SeatStatus() { } /** * Constructs a new SeatStatus object indicated by the Hashtable parameter diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeekStreamingIndicator.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeekStreamingIndicator.java index 8922e6334..576543a07 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SeekStreamingIndicator.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SeekStreamingIndicator.java @@ -79,8 +79,7 @@ public class SeekStreamingIndicator extends RPCStruct { /** * Constructs a new SeekStreamingIndicator object */ - public SeekStreamingIndicator() { - } + public SeekStreamingIndicator() { } /** * Constructs a new SeekStreamingIndicator object indicated by the Hashtable parameter @@ -124,9 +123,9 @@ public class SeekStreamingIndicator extends RPCStruct { * Sets the seekTime. * * @param seekTime If the type is TIME, this number of seconds may be present alongside the skip indicator. - * It will indicate the number of seconds that the currently playing media will skip forward - * or backward. - * {"num_min_value": 1, "num_max_value": 99} + * It will indicate the number of seconds that the currently playing media will skip forward + * or backward. + * {"num_min_value": 1, "num_max_value": 99} */ public SeekStreamingIndicator setSeekTime(Integer seekTime) { setValue(KEY_SEEK_TIME, seekTime); diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java index aad096b14..4b68de127 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java @@ -45,30 +45,30 @@ import java.util.Hashtable; * <p><b>Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>SDLFileName</td>
- * <td>String</td>
- * <td>File reference name.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>SDLFileName</td>
+ * <td>String</td>
+ * <td>File reference name.</td>
* <td>Y</td>
- * <td>Maxlength=500</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>Maxlength=500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
* </table>
*
* <p><b>Response </b></p>
* <p><b> Non-default Result Codes: </b></p>
* <p>SUCCESS</p>
- * <p> INVALID_DATA</p>
- * <p> OUT_OF_MEMORY</p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
* <p> TOO_MANY_PENDING_REQUESTS</p>
* <p> APPLICATION_NOT_REGISTERED</p>
* <p> GENERIC_ERROR</p>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java index 43dbc4f79..f444b9db3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java @@ -46,39 +46,39 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>displayLayout</td>
- * <td>string</td>
- * <td>Predefined or dynamically created screen layout.<p>Currently only predefined screen layouts are defined.</p> Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets. </td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>displayLayout</td>
+ * <td>string</td>
+ * <td>Predefined or dynamically created screen layout.<p>Currently only predefined screen layouts are defined.</p> Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets. </td>
* <td>Y</td>
- * <td>maxlength: 500</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>dayColorScheme</td>
- * <td>TemplateColorScheme</td>
- * <td>The color scheme that is used for day.</td>
+ * <td>maxlength: 500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>dayColorScheme</td>
+ * <td>TemplateColorScheme</td>
+ * <td>The color scheme that is used for day.</td>
* <td>N</td>
* <td></td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
*
- * <tr>
- * <td>nightColorScheme</td>
- * <td>TemplateColorScheme</td>
- * <td>The color scheme that is used for night.</td>
+ * <tr>
+ * <td>nightColorScheme</td>
+ * <td>TemplateColorScheme</td>
+ * <td>The color scheme that is used for night.</td>
* <td>N</td>
* <td></td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
*
* </table>
* <p><b>Response </b></p>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java index e05bd7111..9941542fa 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java @@ -54,78 +54,78 @@ import java.util.List; * <p><b>Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>helpPrompt</td>
- * <td>TTSChunk</td>
- * <td>The help prompt. An array of text chunks of type TTSChunk. See {@linkplain TTSChunk}.The array must have at least one item.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>helpPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>The help prompt. An array of text chunks of type TTSChunk. See {@linkplain TTSChunk}.The array must have at least one item.</td>
* <td>N</td>
- * <td>Array must have at least one element.<p>Only optional it timeoutPrompt has been specified.</p>minsize:1; maxsize: 100</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>timeoutPrompt</td>
- * <td>TTSChunk</td>
- * <td>Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.</td>
+ * <td>Array must have at least one element.<p>Only optional it timeoutPrompt has been specified.</p>minsize:1; maxsize: 100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>timeoutPrompt</td>
+ * <td>TTSChunk</td>
+ * <td>Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.</td>
* <td>N</td>
- * <td>Array must have at least one element. Only optional it helpPrompt has been specified <p>minsize: 1; maxsize: 100</p></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>vrHelpTitle</td>
- * <td>string</td>
- * <td>Text, which is shown as title of the VR help screen used in an interaction started by PTT.</td>
+ * <td>Array must have at least one element. Only optional it helpPrompt has been specified <p>minsize: 1; maxsize: 100</p></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>vrHelpTitle</td>
+ * <td>string</td>
+ * <td>Text, which is shown as title of the VR help screen used in an interaction started by PTT.</td>
* <td>N</td>
- * <td>If omitted on supported displays, the default SDL help title will be used. <p>If omitted and one or more vrHelp items are provided, the request will be rejected.</p>maxLength: 500</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>vrHelp</td>
- * <td>VrHelp</td>
- * <td>Items listed in the VR help screen used in an interaction started by PTT.</td>
+ * <td>If omitted on supported displays, the default SDL help title will be used. <p>If omitted and one or more vrHelp items are provided, the request will be rejected.</p>maxLength: 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>vrHelp</td>
+ * <td>VrHelp</td>
+ * <td>Items listed in the VR help screen used in an interaction started by PTT.</td>
* <td>N</td>
- * <td>If omitted on supported displays, the default SDL VR help / What Can I Say? screen will be used<p>If the list of VR Help Items contains non-sequential positions (e.g. [1,2,4]), the RPC will be rejected.</p><p>If omitted and a vrHelpTitle is provided, the request will be rejected.</p>minsize:1; maxsize: 100 </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>menuTitle</td>
- * <td></td>
- * <td>Optional text to label an app menu button (for certain touchscreen platforms).</td>
+ * <td>If omitted on supported displays, the default SDL VR help / What Can I Say? screen will be used<p>If the list of VR Help Items contains non-sequential positions (e.g. [1,2,4]), the RPC will be rejected.</p><p>If omitted and a vrHelpTitle is provided, the request will be rejected.</p>minsize:1; maxsize: 100 </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuTitle</td>
+ * <td></td>
+ * <td>Optional text to label an app menu button (for certain touchscreen platforms).</td>
* <td>N</td>
- * <td>maxlength: 500</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>menuIcon</td>
- * <td> Image</td>
- * <td>Optional icon to draw on an app menu button (for certain touchscreen platforms).</td>
+ * <td>maxlength: 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuIcon</td>
+ * <td> Image</td>
+ * <td>Optional icon to draw on an app menu button (for certain touchscreen platforms).</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>keyboardProperties</td>
- * <td>KeyboardProperties</td>
- * <td>On-screen keyboard configuration (if available).</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>keyboardProperties</td>
+ * <td>KeyboardProperties</td>
+ * <td>On-screen keyboard configuration (if available).</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>menuLayout</td>
- * <td>MenuLayout</td>
- * <td>Sets the layout of the main menu screen. If this is sent while a menu is already on-screen, the head unit will change the display to the new layout type.</td>
- * <td></td>
- * <td></td>
- * <td>SmartDeviceLink 6.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>menuLayout</td>
+ * <td>MenuLayout</td>
+ * <td>Sets the layout of the main menu screen. If this is sent while a menu is already on-screen, the head unit will change the display to the new layout type.</td>
+ * <td></td>
+ * <td></td>
+ * <td>SmartDeviceLink 6.0</td>
+ * </tr>
*
* </table>
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java index 2442c5f94..099224638 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java @@ -52,61 +52,61 @@ import java.util.Hashtable; * <p><b>Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>startTime</td>
- * <td>StartTime</td>
- * <td>StartTime struct specifying hour, minute, second values to which media clock timer is set.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>startTime</td>
+ * <td>StartTime</td>
+ * <td>StartTime struct specifying hour, minute, second values to which media clock timer is set.</td>
* <td>N</td>
- * <td> </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>endTime</td>
- * <td>StartTime</td>
- * <td> EndTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored)
+ * <td> </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>endTime</td>
+ * <td>StartTime</td>
+ * <td> EndTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored)
* If endTime is greater than startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA.
* endTime will be ignored for "RESUME", and "CLEAR"
* endTime can be sent for "PAUSE", in which case it will update the paused endTime</td>
* <td>N</td>
- * <td>Array must have at least one element.<p>Only optional it helpPrompt has been specified</p> minsize: 1; maxsize: 100</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>updateMode</td>
- * <td>UpdateMode</td>
- * <td>Specifies how the media clock/timer is to be updated (COUNTUP/COUNTDOWN/PAUSE/RESUME), based at the startTime.</td>
+ * <td>Array must have at least one element.<p>Only optional it helpPrompt has been specified</p> minsize: 1; maxsize: 100</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>updateMode</td>
+ * <td>UpdateMode</td>
+ * <td>Specifies how the media clock/timer is to be updated (COUNTUP/COUNTDOWN/PAUSE/RESUME), based at the startTime.</td>
* <td>Y</td>
- * <td>If "updateMode" is COUNTUP or COUNTDOWN, this parameter must be provided. Will be ignored for PAUSE,RESUME and CLEAR</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>audioStreamingIndicator</td>
- * <td>AudioStreamingIndicator</td>
- * <td></td>
+ * <td>If "updateMode" is COUNTUP or COUNTDOWN, this parameter must be provided. Will be ignored for PAUSE,RESUME and CLEAR</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>audioStreamingIndicator</td>
+ * <td>AudioStreamingIndicator</td>
+ * <td></td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
+ * <td></td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
* <td>countRate</td>
* <td>Float</td>
* <td>The value of this parameter is the amount that the media clock timer will advance per 1.0 seconds of real time. Values less than 1.0 will therefore advance the timer slower than real-time, while values greater than 1.0 will advance the timer faster than real-time.e.g. If this parameter is set to `0.5`, the timer will advance one second per two seconds real-time, or at 50% speed. If this parameter is set to `2.0`, the timer will advance two seconds per one second real-time, or at 200% speed.</td>
- *
+
* <td>N</td>
* <td>{"num_min_value": 0.1, "num_max_value": 100.0}</td>
* <td>
* @since SmartDeviceLink 7.1.0
* </td>
* </tr>
- * <tr>
+ * <tr>
* <td>forwardSeekIndicator</td>
* <td>SeekStreamingIndicator</td>
* <td>Used to control the forward seek button to either skip forward a set amount of time or to the next track.</td>
@@ -133,9 +133,9 @@ import java.util.Hashtable; *
* <p><b> Non-default Result Codes: </b></p>
*
- * <p> SUCCESS </p>
- * <p> INVALID_DATA</p>
- * <p> OUT_OF_MEMORY</p>
+ * <p> SUCCESS </p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY</p>
* <p> TOO_MANY_PENDING_REQUESTS</p>
* <p> APPLICATION_NOT_REGISTERED</p>
* <p> GENERIC_ERROR</p>
@@ -390,12 +390,12 @@ public class SetMediaClockTimer extends RPCRequest { * Sets the countRate.
*
* @param countRate The value of this parameter is the amount that the media clock timer will advance per 1.0
- * seconds of real time. Values less than 1.0 will therefore advance the timer slower than
- * real-time, while values greater than 1.0 will advance the timer faster than real-time.
- * e.g. If this parameter is set to `0.5`, the timer will advance one second per two seconds
- * real-time, or at 50% speed. If this parameter is set to `2.0`, the timer will advance two
- * seconds per one second real-time, or at 200% speed.
- * {"num_min_value": 0.1, "num_max_value": 100.0}
+ * seconds of real time. Values less than 1.0 will therefore advance the timer slower than
+ * real-time, while values greater than 1.0 will advance the timer faster than real-time.
+ * e.g. If this parameter is set to `0.5`, the timer will advance one second per two seconds
+ * real-time, or at 50% speed. If this parameter is set to `2.0`, the timer will advance two
+ * seconds per one second real-time, or at 200% speed.
+ * {"num_min_value": 0.1, "num_max_value": 100.0}
* @since SmartDeviceLink 7.1.0
*/
public SetMediaClockTimer setCountRate(Float countRate) {
@@ -424,7 +424,7 @@ public class SetMediaClockTimer extends RPCRequest { * Sets the forwardSeekIndicator.
*
* @param forwardSeekIndicator Used to control the forward seek button to either skip forward a set amount of time or to
- * the next track.
+ * the next track.
* @since SmartDeviceLink 7.1.0
*/
public SetMediaClockTimer setForwardSeekIndicator(SeekStreamingIndicator forwardSeekIndicator) {
@@ -447,7 +447,7 @@ public class SetMediaClockTimer extends RPCRequest { * Sets the backSeekIndicator.
*
* @param backSeekIndicator Used to control the forward seek button to either skip back a set amount of time or to the
- * previous track.
+ * previous track.
* @since SmartDeviceLink 7.1.0
*/
public SetMediaClockTimer setBackSeekIndicator(SeekStreamingIndicator backSeekIndicator) {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java index 5c9e2e54f..e9bdcd905 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java @@ -58,129 +58,129 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>mainField1</td>
- * <td>String</td>
- * <td>Text to be displayed in a single-line display, or in the upper display line in a two-line display.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>mainField1</td>
+ * <td>String</td>
+ * <td>Text to be displayed in a single-line display, or in the upper display line in a two-line display.</td>
* <td>N</td>
- * <td>If this parameter is omitted, the text of mainField1 does not change. If this parameter is an empty string, the field will be cleared. <p>Maxlength = 500</p></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>mainField2</td>
- * <td>String</td>
- * <td>Text to be displayed on the second display line of a two-line display.</td>
+ * <td>If this parameter is omitted, the text of mainField1 does not change. If this parameter is an empty string, the field will be cleared. <p>Maxlength = 500</p></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>mainField2</td>
+ * <td>String</td>
+ * <td>Text to be displayed on the second display line of a two-line display.</td>
* <td>N</td>
- * <td><p>If this parameter is omitted, the text of mainField2 does not change. </p> <p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p>Maxlength = 500</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>mainField3</td>
- * <td>String</td>
- * <td>Text to be displayed on the first display line of the second page.</td>
+ * <td><p>If this parameter is omitted, the text of mainField2 does not change. </p> <p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p>Maxlength = 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>mainField3</td>
+ * <td>String</td>
+ * <td>Text to be displayed on the first display line of the second page.</td>
* <td>N</td>
- * <td><p>If this parameter is omitted, the text of mainField3 does not change. </p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p> Maxlength = 500</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>mainField4</td>
- * <td>String</td>
- * <td>Text to be displayed on the second display line of the second page.</td>
+ * <td><p>If this parameter is omitted, the text of mainField3 does not change. </p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p> Maxlength = 500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>mainField4</td>
+ * <td>String</td>
+ * <td>Text to be displayed on the second display line of the second page.</td>
* <td>N</td>
- * <td><p>If this parameter is omitted, the text of mainField4 does not change. </p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p>Maxlength = 500</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>alignment</td>
- * <td>TextAlignment</td>
- * <td>Specifies how mainField1 and mainField2 text should be aligned on display.</td>
+ * <td><p>If this parameter is omitted, the text of mainField4 does not change. </p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display is a single-line display, the parameter is ignored.</p>Maxlength = 500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>alignment</td>
+ * <td>TextAlignment</td>
+ * <td>Specifies how mainField1 and mainField2 text should be aligned on display.</td>
* <td>N</td>
- * <td><p>Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display.</p><p>If this parameter is omitted, text in both mainField1 and mainField2 will be centered. </p>Has no effect with navigation display</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>statusBar</td>
- * <td>String</td>
- * <td>The text is placed in the status bar area.</td>
+ * <td><p>Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display.</p><p>If this parameter is omitted, text in both mainField1 and mainField2 will be centered. </p>Has no effect with navigation display</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>statusBar</td>
+ * <td>String</td>
+ * <td>The text is placed in the status bar area.</td>
* <td>N</td>
- * <td><p>Note: The status bar only exists on navigation displays</p><p>If this parameter is omitted, the status bar text will remain unchanged.</p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display has no status bar, this parameter is ignored.</p>Maxlength = 500</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>mediaClock</td>
- * <td>String</td>
- * <td>Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.</td>
+ * <td><p>Note: The status bar only exists on navigation displays</p><p>If this parameter is omitted, the status bar text will remain unchanged.</p><p>If this parameter is an empty string, the field will be cleared.</p><p>If provided and the display has no status bar, this parameter is ignored.</p>Maxlength = 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>mediaClock</td>
+ * <td>String</td>
+ * <td>Text value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.</td>
* <td>N</td>
- * <td>{"string_min_length": 0, "string_max_length": 500}</td>
- * <td>
- * @since SmartDeviceLink 1.0.0
- * @property-deprecated in SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>mediaTrack</td>
- * <td>String</td>
- * <td>Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.</td>
+ * <td>{"string_min_length": 0, "string_max_length": 500}</td>
+ * <td>
+ * @since SmartDeviceLink 1.0.0
+ * @property-deprecated in SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>mediaTrack</td>
+ * <td>String</td>
+ * <td>Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.</td>
* <td>N</td>
- * <td><p>If parameter is omitted, the track field remains unchanged.</p><p>If an empty string is provided, the field will be cleared.</p><p>This field is only valid for media applications on navigation displays.</p>Maxlength = 500</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>graphic</td>
- * <td>Image</td>
- * <td>Image to be shown on supported displays.</td>
+ * <td><p>If parameter is omitted, the track field remains unchanged.</p><p>If an empty string is provided, the field will be cleared.</p><p>This field is only valid for media applications on navigation displays.</p>Maxlength = 500</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>graphic</td>
+ * <td>Image</td>
+ * <td>Image to be shown on supported displays.</td>
* <td>N</td>
- * <td>If omitted on supported displays, the displayed graphic shall not change.</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>secondaryGraphic</td>
- * <td>Image</td>
- * <td> <p>Image struct determining whether static or dynamic secondary image to display in app.</p>If omitted on supported displays, the displayed secondary graphic shall not change.</td>
+ * <td>If omitted on supported displays, the displayed graphic shall not change.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>secondaryGraphic</td>
+ * <td>Image</td>
+ * <td> <p>Image struct determining whether static or dynamic secondary image to display in app.</p>If omitted on supported displays, the displayed secondary graphic shall not change.</td>
* <td>N</td>
- * <td> </td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
- * <tr>
- * <td>softButtons</td>
- * <td>SoftButton</td>
- * <td>Soft buttons as defined by the App</td>
+ * <td> </td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>softButtons</td>
+ * <td>SoftButton</td>
+ * <td>Soft buttons as defined by the App</td>
* <td>N</td>
- * <td><p>If omitted on supported displays, the currently displayed SoftButton values will not change.</p>Array Minsize: 0; Array Maxsize: 8</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>customPresets</td>
- * <td>String</td>
- * <td>Custom presets as defined by the App.</td>
+ * <td><p>If omitted on supported displays, the currently displayed SoftButton values will not change.</p>Array Minsize: 0; Array Maxsize: 8</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>customPresets</td>
+ * <td>String</td>
+ * <td>Custom presets as defined by the App.</td>
* <td>N</td>
- * <td><p>If omitted on supported displays, the presets will be shown as not defined.</p>Minsize: 0; Maxsize: 6</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>templateTitle</td>
- * <td>String</td>
- * <td>The title of the new template that will be displayed.</td>
- * <td><p>How this will be displayed is dependent on the OEM design and implementation of the template..</p>Minsize: 0; Maxsize: 100</td>
- * <td>N</td>
- * <td>SmartDeviceLink 6.0.0</td>
- * </tr>
+ * <td><p>If omitted on supported displays, the presets will be shown as not defined.</p>Minsize: 0; Maxsize: 6</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>templateTitle</td>
+ * <td>String</td>
+ * <td>The title of the new template that will be displayed.</td>
+ * <td><p>How this will be displayed is dependent on the OEM design and implementation of the template..</p>Minsize: 0; Maxsize: 100</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 6.0.0</td>
+ * </tr>
*
* </table>
* <p><b>Response </b></p>
*
* <p><b> Non-default Result Codes: </b></p>
- * <p>SUCCESS </p>
- * <p>INVALID_DATA</p>
- * <p>OUT_OF_MEMORY</p>
+ * <p>SUCCESS </p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
* <p> TOO_MANY_PENDING_REQUESTS</p>
* <p>APPLICATION_NOT_REGISTERED</p>
* <p> GENERIC_ERROR</p>
@@ -446,9 +446,9 @@ public class Show extends RPCRequest { * Sets the mediaClock.
*
* @param mediaClock Text value for MediaClock field. Has to be properly formatted by Mobile App according to
- * the module's capabilities. If this text is set, any automatic media clock updates
- * previously set with SetMediaClockTimer will be stopped.
- * {"string_min_length": 0, "string_max_length": 500}
+ * the module's capabilities. If this text is set, any automatic media clock updates
+ * previously set with SetMediaClockTimer will be stopped.
+ * {"string_min_length": 0, "string_max_length": 500}
* @since SmartDeviceLink 1.0.0
* @deprecated in SmartDeviceLink 7.1.0
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java index 68ebd7d31..22b85b5ff 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ShowConstantTbt.java @@ -206,7 +206,7 @@ public class ShowConstantTbt extends RPCRequest { * Sets the distanceToManeuver. * * @param distanceToManeuver Distance (in meters) until next maneuver. May be used to calculate progress bar. - * {"num_min_value": 0.0, "num_max_value": 1000000000.0} + * {"num_min_value": 0.0, "num_max_value": 1000000000.0} * @since SmartDeviceLink 2.0.0 */ public ShowConstantTbt setDistanceToManeuver(Double distanceToManeuver) { @@ -229,8 +229,8 @@ public class ShowConstantTbt extends RPCRequest { * Sets the distanceToManeuverScale. * * @param distanceToManeuverScale Distance (in meters) from previous maneuver to next maneuver. May be used to calculate - * progress bar. - * {"num_min_value": 0.0, "num_max_value": 1000000000.0} + * progress bar. + * {"num_min_value": 0.0, "num_max_value": 1000000000.0} * @since SmartDeviceLink 2.0.0 */ public ShowConstantTbt setDistanceToManeuverScale(Double distanceToManeuverScale) { diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java index f948c471a..d68abf738 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java @@ -43,34 +43,34 @@ import java.util.Hashtable; * Tire pressure status of a single tire.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>status</td>
- * <td>ComponentVolumeStatus</td>
- * <td>Describes the volume status of a single tire
- * See {@linkplain ComponentVolumeStatus}
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>tpms</td>
- * <td>TPMS</td>
- * <td>The status of TPMS according to the particular tire.
- * See {@linkplain com.smartdevicelink.proxy.rpc.enums.TPMS}
- * </td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
- * <td>pressure</td>
- * <td>Float</td>
- * <td>The pressure value of the particular tire in kilo pascal.</td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>status</td>
+ * <td>ComponentVolumeStatus</td>
+ * <td>Describes the volume status of a single tire
+ * See {@linkplain ComponentVolumeStatus}
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>tpms</td>
+ * <td>TPMS</td>
+ * <td>The status of TPMS according to the particular tire.
+ * See {@linkplain com.smartdevicelink.proxy.rpc.enums.TPMS}
+ * </td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
+ * <td>pressure</td>
+ * <td>Float</td>
+ * <td>The pressure value of the particular tire in kilo pascal.</td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java index 3eab5d9bb..fae2a8165 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java @@ -50,78 +50,78 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>numTicks</td>
- * <td>Integer</td>
- * <td>Number of selectable items on a horizontal axis.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>numTicks</td>
+ * <td>Integer</td>
+ * <td>Number of selectable items on a horizontal axis.</td>
* <td>Y</td>
- * <td>Minvalue=2; Maxvalue=26</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>Minvalue=2; Maxvalue=26</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
- * <tr>
- * <td>position</td>
- * <td>Integer</td>
- * <td>Initial position of slider control (cannot exceed numTicks),</td>
+ * <tr>
+ * <td>position</td>
+ * <td>Integer</td>
+ * <td>Initial position of slider control (cannot exceed numTicks),</td>
* <td>Y</td>
- * <td>Minvalue=1; Maxvalue=26</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>sliderHeader</td>
- * <td>String</td>
- * <td>Text header to display</td>
+ * <td>Minvalue=1; Maxvalue=26</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>sliderHeader</td>
+ * <td>String</td>
+ * <td>Text header to display</td>
* <td>N</td>
- * <td>Maxlength=500</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>sliderFooter</td>
- * <td>Integer</td>
- * <td><p>Text footer to display (meant to display min/max threshold descriptors).</p>For a static text footer, only one footer string shall be provided in the array. For a dynamic text footer, the number of footer text string in the array must match the numTicks value.For a dynamic text footer, text array string should correlate with potential slider position index.If omitted on supported displays, no footer text shall be displayed.</td>
+ * <td>Maxlength=500</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>sliderFooter</td>
+ * <td>Integer</td>
+ * <td><p>Text footer to display (meant to display min/max threshold descriptors).</p>For a static text footer, only one footer string shall be provided in the array. For a dynamic text footer, the number of footer text string in the array must match the numTicks value.For a dynamic text footer, text array string should correlate with potential slider position index.If omitted on supported displays, no footer text shall be displayed.</td>
* <td>N</td>
- * <td>Maxlength=500; Minvalue=1; Maxvalue=26</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>Maxlength=500; Minvalue=1; Maxvalue=26</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
- * <tr>
- * <td>timeout</td>
- * <td>String</td>
- * <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). If omitted, the value is set to 10000.</td>
+ * <tr>
+ * <td>timeout</td>
+ * <td>String</td>
+ * <td>App defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). If omitted, the value is set to 10000.</td>
* <td>N</td>
- * <td>Minvalue=0; Maxvalue=65535; Defvalue= 10000</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>cancelID</td>
- * <td>Integer</td>
- * <td>An ID for this specific slider to allow cancellation through the `CancelInteraction` RPC.</td>
+ * <td>Minvalue=0; Maxvalue=65535; Defvalue= 10000</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>cancelID</td>
+ * <td>Integer</td>
+ * <td>An ID for this specific slider to allow cancellation through the `CancelInteraction` RPC.</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 6.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 6.0</td>
+ * </tr>
* </table>
* <p><b>Response </b></p>
*
* <p><b>Non-default Result Codes:</b></p>
- * <p> SAVED </p>
- * <p> INVALID_DATA</p>
- * <p>OUT_OF_MEMORY</p>
- * <p>TOO_MANY_PENDING_REQUESTS</p>
- * <p>APPLICATION_NOT_REGISTERED</p>
- * <p>GENERIC_ERROR</p>
- * <p> DISALLOWED</p>
- * <p> UNSUPPORTED_RESOURCE </p>
- * <p> REJECTED </p>
- * <p>ABORTED </p>
+ * <p> SAVED </p>
+ * <p> INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p> DISALLOWED</p>
+ * <p> UNSUPPORTED_RESOURCE </p>
+ * <p> REJECTED </p>
+ * <p>ABORTED </p>
*
* @since SmartDeviceLink 2.0
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java index e537d2fc8..873522c69 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java @@ -44,62 +44,62 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>type</td>
- * <td>SoftButtonType</td>
- * <td>Describes, whether it is text, highlighted text, icon, or dynamic image. </td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>type</td>
+ * <td>SoftButtonType</td>
+ * <td>Describes, whether it is text, highlighted text, icon, or dynamic image. </td>
* <td></td>
* <td></td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>text</td>
- * <td>String</td>
- * <td>Optional text to display (if defined as TEXT or BOTH)</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>text</td>
+ * <td>String</td>
+ * <td>Optional text to display (if defined as TEXT or BOTH)</td>
* <td>N</td>
* <td>Min: 0; Maxlength: 500</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>image</td>
- * <td>Image</td>
- * <td>Optional image struct for SoftButton (if defined as IMAGE or BOTH).</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>image</td>
+ * <td>Image</td>
+ * <td>Optional image struct for SoftButton (if defined as IMAGE or BOTH).</td>
* <td></td>
* <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>isHighlighted</td>
- * <td>Boolean</td>
- * <td>True, if highlighted False, if not highlighted</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>isHighlighted</td>
+ * <td>Boolean</td>
+ * <td>True, if highlighted False, if not highlighted</td>
* <td>N</td>
* <td></td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>softButtonID</td>
- * <td>Integer</td>
- * <td>Value which is returned via OnButtonPress / OnButtonEvent</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>softButtonID</td>
+ * <td>Integer</td>
+ * <td>Value which is returned via OnButtonPress / OnButtonEvent</td>
* <td></td>
* <td>Min: 0; Max: 65535</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>systemAction</td>
- * <td>SystemAction</td>
- * <td>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>systemAction</td>
+ * <td>SystemAction</td>
+ * <td>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</td>
* <td>N</td>
* <td>defvalue: DEFAULT_ACTION</td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
*
* </table>
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java index ca5c0e6f0..c02ba15ed 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java @@ -42,43 +42,43 @@ import java.util.Hashtable; * <p>Contains information about a SoftButton's capabilities.</p>
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>shortPressAvailable</td>
- * <td>Boolean</td>
- * <td>The button supports a short press.
- * Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>longPressAvailable</td>
- * <td>Boolean</td>
- * <td>The button supports a LONG press.
- * Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>upDownAvailable</td>
- * <td>Boolean</td>
- * <td>The button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.
- * Whenever the button is released, onButtonEvent( UP) will be invoked. *
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>imageSupported</td>
- * <td>Boolean</td>
- * <td>The button supports referencing a static or dynamic image.
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>shortPressAvailable</td>
+ * <td>Boolean</td>
+ * <td>The button supports a short press.
+ * Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>longPressAvailable</td>
+ * <td>Boolean</td>
+ * <td>The button supports a LONG press.
+ * Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>upDownAvailable</td>
+ * <td>Boolean</td>
+ * <td>The button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.
+ * Whenever the button is released, onButtonEvent( UP) will be invoked. *
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>imageSupported</td>
+ * <td>Boolean</td>
+ * <td>The button supports referencing a static or dynamic image.
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java index 6cb97a34b..651cdb8bc 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java @@ -103,37 +103,37 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th> Ver. Available</th>
- * </tr>
- * <tr>
- * <td>ttsChunks</td>
- * <td>String</td>
- * <td>An array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken.</td>
- * <td>Y</td>
- * <td><p>The array must have 1-100 elements. </p><p>The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected. </p>Each chunk can be no more than 500 characters.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <th> Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>ttsChunks</td>
+ * <td>String</td>
+ * <td>An array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken.</td>
+ * <td>Y</td>
+ * <td><p>The array must have 1-100 elements. </p><p>The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected. </p>Each chunk can be no more than 500 characters.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
* <p><b>Response</b> </p>
* <p>This Response notifies the application of the completion, interruption, or failure of a Speak Request.</p>
*
* <p><b>Non-default Result Codes:</b> </p>
*
- * <p> SUCCESS </p>
- * <p> INVALID_DATA</p>
- * <p> OUT_OF_MEMORY </p>
- * <p>APPLICATION_NOT_REGISTERED </p>
- * <p>TOO_MANY_PENDING_REQUESTS </p>
- * <p> GENERIC_ERROR </p>
- * <p>REJECTED </p>
- * <p>DISALLOWED </p>
- * <p>ABORTED </p>
+ * <p> SUCCESS </p>
+ * <p> INVALID_DATA</p>
+ * <p> OUT_OF_MEMORY </p>
+ * <p>APPLICATION_NOT_REGISTERED </p>
+ * <p>TOO_MANY_PENDING_REQUESTS </p>
+ * <p> GENERIC_ERROR </p>
+ * <p>REJECTED </p>
+ * <p>DISALLOWED </p>
+ * <p>ABORTED </p>
*
* <p><b>Additional Notes:</b></p><ul>Total character limit depends on platform. Chunks are limited to 500 characters; however you can have multiple TTS chunks. On Gen 1.1 there is a total character limit of 500 characters across all chunks. This could vary according to the VCA.
*
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java index ae31614f9..e2cdd6be9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java @@ -41,32 +41,32 @@ import java.util.Hashtable; * Describes the hour, minute and second values used to set the media clock.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>hours</td>
- * <td>Integer</td>
- * <td>The hour. Minvalue="0", maxvalue="59"
- * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>minutes</td>
- * <td>Integer</td>
- * <td>The minute. Minvalue="0", maxvalue="59".</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>hours</td>
+ * <td>Integer</td>
+ * <td>The hour. Minvalue="0", maxvalue="59"
+ * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>minutes</td>
+ * <td>Integer</td>
+ * <td>The minute. Minvalue="0", maxvalue="59".</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* <tr>
- * <td>seconds</td>
- * <td>Integer</td>
- * <td>The second. Minvalue="0", maxvalue="59".</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td>seconds</td>
+ * <td>Integer</td>
+ * <td>The second. Minvalue="0", maxvalue="59".</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 1.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java index 306b07159..2c99a035a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java @@ -87,22 +87,22 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>buttonName</td>
- * <td>ButtonName</td>
- * <td>Name of the button to subscribe.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>buttonName</td>
+ * <td>ButtonName</td>
+ * <td>Name of the button to subscribe.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 1.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 1.0 </td>
+ * </tr>
* </table>
*
* @see UnsubscribeButton
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java index 15158a4b2..a779c7288 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java @@ -49,247 +49,247 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>SmartDeviceLink Version</th>
- * </tr>
- * <tr>
- * <td>gps</td>
- * <td>Boolean</td>
- * <td>GPS data. See {@linkplain GPSData}for details</td>
+ * <th>SmartDeviceLink Version</th>
+ * </tr>
+ * <tr>
+ * <td>gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain GPSData}for details</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>speed</td>
- * <td>Boolean</td>
- * <td>The vehicle speed in kilometers per hour</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>speed</td>
+ * <td>Boolean</td>
+ * <td>The vehicle speed in kilometers per hour</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>rpm</td>
- * <td>Boolean</td>
- * <td>The number of revolutions per minute of the engine</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Boolean</td>
+ * <td>The number of revolutions per minute of the engine</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>fuelLevel</td>
- * <td>Boolean</td>
- * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Boolean</td>
+ * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>fuelLevel_State</td>
- * <td>Boolean</td>
- * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>Boolean</td>
+ * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>fuelRange</td>
- * <td>Boolean</td>
- * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelRange</td>
+ * <td>Boolean</td>
+ * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 5.0.0</td>
- * </tr>
- * <tr>
- * <td>instantFuelConsumption</td>
- * <td>Boolean</td>
- * <td>The instantaneous fuel consumption in micro litres</td>
+ * <td>SmartDeviceLink 5.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Boolean</td>
+ * <td>The instantaneous fuel consumption in micro litres</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>externalTemperature</td>
- * <td>Boolean</td>
- * <td>The external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Boolean</td>
+ * <td>The external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>
- * @since SmartDeviceLink 2.0.0
- * @property-deprecated in SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>gearStatus</td>
- * <td>Boolean</td>
- * <td>See GearStatus</td>
- * <td>N</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>prndl</td>
- * <td>Boolean</td>
- * <td>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</td>
- * <td>N</td>
- * <td>SmartDeviceLink 7.0.0</td>
+ * <td>
+ * @since SmartDeviceLink 2.0.0
+ * @property-deprecated in SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>gearStatus</td>
+ * <td>Boolean</td>
+ * <td>See GearStatus</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>prndl</td>
+ * <td>Boolean</td>
+ * <td>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
* </tr>
- * <tr>
- * <td>tirePressure</td>
- * <td>Boolean</td>
- * <td>Tire pressure status</td>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>Boolean</td>
+ * <td>Tire pressure status</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>odometer</td>
- * <td>Boolean</td>
- * <td>Odometer in km</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Boolean</td>
+ * <td>Odometer in km</td>
* <td>N</td>
* <td>Max Length: 500</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>beltStatus</td>
- * <td>Boolean</td>
- * <td>The status of the seat belts</td>
- * <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>bodyInformation</td>
- * <td>Boolean</td>
- * <td>The body information including ignition status and internal temp</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the seat belts</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>deviceStatus</td>
- * <td>Boolean</td>
- * <td>The device status including signal and battery strength</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>Boolean</td>
+ * <td>The body information including ignition status and internal temp</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>driverBraking</td>
- * <td>Boolean</td>
- * <td>The status of the brake pedal</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>Boolean</td>
+ * <td>The device status including signal and battery strength</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>wiperStatus</td>
- * <td>Boolean</td>
- * <td>The status of the wipers</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>Boolean</td>
+ * <td>The status of the brake pedal</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>headLampStatus</td>
- * <td>Boolean</td>
- * <td>Status of the head lamps</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the wipers</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>engineTorque</td>
- * <td>Boolean</td>
- * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>Boolean</td>
+ * <td>Status of the head lamps</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>engineOilLife</td>
- * <td>Boolean</td>
- * <td>The estimated percentage of remaining oil life of the engine</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Boolean</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 5.0 </td>
- * </tr>
- * <tr>
- * <td>accPedalPosition</td>
- * <td>Boolean</td>
- * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>engineOilLife</td>
+ * <td>Boolean</td>
+ * <td>The estimated percentage of remaining oil life of the engine</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>steeringWheelAngle</td>
- * <td>Boolean</td>
- * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>SmartDeviceLink 5.0 </td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Boolean</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>eCallInfo</td>
- * <td>Boolean</td>
- * <td>Emergency Call notification and confirmation data.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Boolean</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>airbagStatus</td>
- * <td>Boolean</td>
- * <td>The status of the air bags.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>eCallInfo</td>
+ * <td>Boolean</td>
+ * <td>Emergency Call notification and confirmation data.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>emergencyEvent</td>
- * <td>Boolean</td>
- * <td>Information related to an emergency event (and if it occurred).</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>airbagStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the air bags.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>clusterModeStatus</td>
- * <td>Boolean</td>
- * <td>The status modes of the instrument panel cluster.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>emergencyEvent</td>
+ * <td>Boolean</td>
+ * <td>Information related to an emergency event (and if it occurred).</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>myKey</td>
- * <td>Boolean</td>
- * <td>Information related to the MyKey feature.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>clusterModeStatus</td>
+ * <td>Boolean</td>
+ * <td>The status modes of the instrument panel cluster.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>turnSignal</td>
- * <td>Boolean</td>
- * <td>@see TurnSignal</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>myKey</td>
+ * <td>Boolean</td>
+ * <td>Information related to the MyKey feature.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 5.0 </td>
- * </tr>
- * <tr>
- * <td>cloudAppVehicleID</td>
- * <td>Boolean</td>
- * <td>ID for the vehicle when connecting to cloud applications</td>
- * <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 5.1 </td>
- * </tr>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>turnSignal</td>
+ * <td>Boolean</td>
+ * <td>@see TurnSignal</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 5.0 </td>
+ * </tr>
+ * <tr>
+ * <td>cloudAppVehicleID</td>
+ * <td>Boolean</td>
+ * <td>ID for the vehicle when connecting to cloud applications</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 5.1 </td>
+ * </tr>
* <tr>
* <td>handsOffSteering</td>
* <td>Boolean</td>
@@ -304,13 +304,13 @@ import java.util.Hashtable; * <td>N</td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
- * <tr>
- * <td>stabilityControlsStatus</td>
- * <td>Boolean</td>
- * <td>See StabilityControlsStatus</td>
- * <td>N</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
+ * <tr>
+ * <td>stabilityControlsStatus</td>
+ * <td>Boolean</td>
+ * <td>See StabilityControlsStatus</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
* <tr>
* <td>climateData</td>
* <td>Boolean</td>
@@ -321,16 +321,16 @@ import java.util.Hashtable; * @since SmartDeviceLink 7.1.0
* </td>
* </tr>
- * <tr>
- * <td>seatOccupancy</td>
- * <td>Boolean</td>
- * <td>See SeatOccupancy</td>
- * <td>N</td>
- * <td></td>
- * <td>
- * @since SmartDeviceLink 7.1.0
- * </td>
- * </tr>
+ * <tr>
+ * <td>seatOccupancy</td>
+ * <td>Boolean</td>
+ * <td>See SeatOccupancy</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>
+ * @since SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
* </table>
*
* <p> <b>Response</b></p>
@@ -338,13 +338,13 @@ import java.util.Hashtable; * <p>SUCCESS</p>
* <p>WARNINGS </p>
* <p>INVALID_DATA</p>
- * <p>OUT_OF_MEMORY</p>
- * <p>TOO_MANY_PENDING_REQUESTS</p>
- * <p>APPLICATION_NOT_REGISTERED</p>
- * <p>GENERIC_ERROR</p>
- * <p>IGNORED </p>
- * <p>DISALLOWED</p>
- * <p>USER_DISALLOWED </p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>IGNORED </p>
+ * <p>DISALLOWED</p>
+ * <p>USER_DISALLOWED </p>
*
* @see UnsubscribeVehicleData
* @see GetVehicleData
@@ -554,7 +554,7 @@ public class SubscribeVehicleData extends RPCRequest { * Sets the externalTemperature.
*
* @param externalTemperature The external temperature in degrees celsius. This parameter is deprecated starting RPC
- * Spec 7.1.0, please see climateData.
+ * Spec 7.1.0, please see climateData.
* @since SmartDeviceLink 2.0.0
* @deprecated in SmartDeviceLink 7.1.0
*/
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 eb9780cbf..05753b8ab 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleDataResponse.java @@ -256,7 +256,7 @@ public class SubscribeVehicleDataResponse extends RPCResponse { * Sets the externalTemperature.
*
* @param externalTemperature The external temperature in degrees celsius. This parameter is deprecated starting RPC
- * Spec 7.1.0, please see climateData.
+ * Spec 7.1.0, please see climateData.
* @since SmartDeviceLink 2.0.0
* @deprecated in SmartDeviceLink 7.1.0
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java index b8137c7c0..8386c2c5a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java @@ -45,38 +45,38 @@ import java.util.List; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>requestType</td>
- * <td>RequestType</td>
- * <td>The type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>requestType</td>
+ * <td>RequestType</td>
+ * <td>The type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>requestSubType</td>
- * <td>String</td>
- * <td>This parameter is filled for supporting OEM proprietary data exchanges.</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>requestSubType</td>
+ * <td>String</td>
+ * <td>This parameter is filled for supporting OEM proprietary data exchanges.</td>
* <td>N</td>
* <td>Max Length: 255</td>
- * <td>SmartDeviceLink 5.0</td>
- * </tr>
- * <tr>
- * <td>fileName</td>
- * <td>String</td>
- * <td>Filename of HTTP data to store in predefined system staging area. Mandatory if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. </td>
+ * <td>SmartDeviceLink 5.0</td>
+ * </tr>
+ * <tr>
+ * <td>fileName</td>
+ * <td>String</td>
+ * <td>Filename of HTTP data to store in predefined system staging area. Mandatory if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. </td>
* <td>N</td>
* <td>Max Length: 255</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 3.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java index 702b4ca61..1333fa7bf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java @@ -49,24 +49,24 @@ import java.util.Hashtable; * <p>For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a></p>.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>text</td>
- * <td>String</td>
- * <td>Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field.</td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>type</td>
- * <td>SpeechCapabilities</td>
- * <td>Indicates the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>text</td>
+ * <td>String</td>
+ * <td>Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field.</td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>type</td>
+ * <td>SpeechCapabilities</td>
+ * <td>Indicates the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 1.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java index 3168972a4..e8b3c9acb 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java @@ -39,34 +39,34 @@ import java.util.Hashtable; * A color scheme for all display layout templates. * <p><b> Parameter List</b></p> * <table border="1" rules="all"> - * <tr> - * <th>Name</th> - * <th>Type</th> - * <th>Description</th> - * <th>Reg.</th> - * <th>Version Available</th> - * </tr> - * <tr> - * <td>primaryColor</td> - * <td>RGBColor</td> - * <td>The primary "accent" color</td> - * <td>N</td> - * <td>SmartDeviceLink 5.0</td> - * </tr> - * <tr> - * <td>secondaryColor</td> - * <td>RGBColor</td> - * <td>The secondary "accent" color</td> - * <td>N</td> - * <td>SmartDeviceLink 5.0</td> - * </tr> - * <tr> - * <td>backgroundColor</td> - * <td>RGBColor</td> - * <td>The color of the background</td> - * <td>N</td> - * <td>SmartDeviceLink 5.0</td> - * </tr> + * <tr> + * <th>Name</th> + * <th>Type</th> + * <th>Description</th> + * <th>Reg.</th> + * <th>Version Available</th> + * </tr> + * <tr> + * <td>primaryColor</td> + * <td>RGBColor</td> + * <td>The primary "accent" color</td> + * <td>N</td> + * <td>SmartDeviceLink 5.0</td> + * </tr> + * <tr> + * <td>secondaryColor</td> + * <td>RGBColor</td> + * <td>The secondary "accent" color</td> + * <td>N</td> + * <td>SmartDeviceLink 5.0</td> + * </tr> + * <tr> + * <td>backgroundColor</td> + * <td>RGBColor</td> + * <td>The color of the background</td> + * <td>N</td> + * <td>SmartDeviceLink 5.0</td> + * </tr> * </table> * * @since SmartDeviceLink 5.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java index e89069e67..4b0b8a94e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java @@ -43,46 +43,46 @@ import java.util.Hashtable; * Struct defining the characteristics of a displayed field on the HMI.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>name</td>
- * <td>TextFieldName</td>
- * <td>Enumeration identifying the field. </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>characterSet</td>
- * <td>CharacterSet</td>
- * <td>The set of characters that are supported by this text field. All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8. All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set. </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>width</td>
- * <td>Integer</td>
- * <td>The number of characters in one row of this field.
- * <ul>
- * <li>Minvalue="1"</li>
- * <li>maxvalue="500"</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>rows</td>
- * <td>Integer</td>
- * <td>The number of rows for this text field.
- * <ul>
- * <li>Minvalue="1"</li>
- * <li>maxvalue="3"</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>name</td>
+ * <td>TextFieldName</td>
+ * <td>Enumeration identifying the field. </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>characterSet</td>
+ * <td>CharacterSet</td>
+ * <td>The set of characters that are supported by this text field. All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8. All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set. </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>width</td>
+ * <td>Integer</td>
+ * <td>The number of characters in one row of this field.
+ * <ul>
+ * <li>Minvalue="1"</li>
+ * <li>maxvalue="500"</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>rows</td>
+ * <td>Integer</td>
+ * <td>The number of rows for this text field.
+ * <ul>
+ * <li>Minvalue="1"</li>
+ * <li>maxvalue="3"</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*
* @see TextFieldName
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java index 8cd212326..979adc303 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java @@ -44,30 +44,30 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th> Version</th>
- * </tr>
- * <tr>
- * <td>x</td>
- * <td>Integer</td>
- * <td>The x coordinate of the touch.</td>
+ * <th> Version</th>
+ * </tr>
+ * <tr>
+ * <td>x</td>
+ * <td>Integer</td>
+ * <td>The x coordinate of the touch.</td>
* <td>Y</td>
* <td>minvalue = 0; maxvalue = 10000</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>y</td>
- * <td>Integer</td>
- * <td>The y coordinate of the touch.</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>y</td>
+ * <td>Integer</td>
+ * <td>The y coordinate of the touch.</td>
* <td>Y</td>
* <td>minvalue = 0; maxvalue = 10000</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
* </table>
*
* @see SoftButtonCapabilities
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java index ad94a26d2..cfa91a20b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java @@ -45,40 +45,40 @@ import java.util.List; * <p><b>Parameter List</b></p>
*
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>id</td>
- * <td>Integer</td>
- * <td> A touch's unique identifier. The application can track the current touch events by id. If a touch event has type begin, the id should be added to the set of touches. If a touch event has type end, the id should be removed from the set of touches.</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>id</td>
+ * <td>Integer</td>
+ * <td> A touch's unique identifier. The application can track the current touch events by id. If a touch event has type begin, the id should be added to the set of touches. If a touch event has type end, the id should be removed from the set of touches.</td>
* <td>N</td>
* <td>Min Value: 0; Max Value: 9</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>ts</td>
- * <td>Float</td>
- * <td>The time that the touch was recorded. <p> This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>ts</td>
+ * <td>Float</td>
+ * <td>The time that the touch was recorded. <p> This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p>
* <p>The timestamp is used to determined the rate of change of position of a touch.</p><p>The application also uses the time to verify whether two touches,with different ids, are part of a single action by the user.</p>
- * <p>If there is only a single timestamp in this array,</p> it is the same for every coordinate in the coordinates array.</td>
+ * <p>If there is only a single timestamp in this array,</p> it is the same for every coordinate in the coordinates array.</td>
* <td>Y</td>
* <td>minvalue="0" maxvalue="5000000000" minsize="1" maxsize="1000"</td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>c</td>
- * <td>Integer</td>
- * <td>The coordinates of the screen area where the touch event occurred.</td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>c</td>
+ * <td>Integer</td>
+ * <td>The coordinates of the screen area where the touch event occurred.</td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 3.0</td>
- * </tr>
+ * <td>SmartDeviceLink 3.0</td>
+ * </tr>
* </table>
* <p>
* @since SmartDeviceLink 3.0
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java index 736e5d7cf..c2e5ec216 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java @@ -42,38 +42,38 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>SmartDeviceLink Version</th>
- * </tr>
- * <tr>
- * <td>pressAvailable</td>
- * <td>Boolean</td>
- * <td></td>
+ * <th>SmartDeviceLink Version</th>
+ * </tr>
+ * <tr>
+ * <td>pressAvailable</td>
+ * <td>Boolean</td>
+ * <td></td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
* <tr>
- * <td>multiTouchAvailable</td>
- * <td>Boolean</td>
- * <td></td>
+ * <td>multiTouchAvailable</td>
+ * <td>Boolean</td>
+ * <td></td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
- * <tr>
- * <td>doublePressAvailable</td>
- * <td>Boolean</td>
- * <td></td>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
+ * <tr>
+ * <td>doublePressAvailable</td>
+ * <td>Boolean</td>
+ * <td></td>
* <td>Y</td>
* <td></td>
- * <td>SmartDeviceLink 3.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 3.0 </td>
+ * </tr>
* </table>
*/
public class TouchEventCapabilities extends RPCStruct {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java index d139769ac..e689689ca 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java @@ -50,22 +50,22 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>buttonName</td>
- * <td>ButtonName</td>
- * <td>Name of the button to unsubscribe.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>buttonName</td>
+ * <td>ButtonName</td>
+ * <td>Name of the button to unsubscribe.</td>
* <td>Y</td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*
* <p> <b>Response</b></p>
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java index fca15f57e..3f3dff1bf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java @@ -44,239 +44,239 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
- * <th>Version</th>
- * </tr>
- * <tr>
- * <td>gps</td>
- * <td>Boolean</td>
- * <td>GPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for details</td>
+ * <th>Version</th>
+ * </tr>
+ * <tr>
+ * <td>gps</td>
+ * <td>Boolean</td>
+ * <td>GPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for details</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>speed</td>
- * <td>Boolean</td>
- * <td>The vehicle speed in kilometers per hour</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>speed</td>
+ * <td>Boolean</td>
+ * <td>The vehicle speed in kilometers per hour</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>rpm</td>
- * <td>Boolean</td>
- * <td>The number of revolutions per minute of the engine</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>rpm</td>
+ * <td>Boolean</td>
+ * <td>The number of revolutions per minute of the engine</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>fuelLevel</td>
- * <td>Boolean</td>
- * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel</td>
+ * <td>Boolean</td>
+ * <td>The fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>fuelLevel_State</td>
- * <td>Boolean</td>
- * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelLevel_State</td>
+ * <td>Boolean</td>
+ * <td>The fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>fuelRange</td>
- * <td>Boolean</td>
- * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>fuelRange</td>
+ * <td>Boolean</td>
+ * <td>The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 5.0.0</td>
- * </tr>
- * <tr>
- * <td>instantFuelConsumption</td>
- * <td>Boolean</td>
- * <td>The instantaneous fuel consumption in micro litres</td>
+ * <td>SmartDeviceLink 5.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>instantFuelConsumption</td>
+ * <td>Boolean</td>
+ * <td>The instantaneous fuel consumption in micro litres</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>externalTemperature</td>
- * <td>Boolean</td>
- * <td>The external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>externalTemperature</td>
+ * <td>Boolean</td>
+ * <td>The external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>
- * @since SmartDeviceLink 2.0.0
- * @property-deprecated in SmartDeviceLink 7.1.0
- * </td>
- * </tr>
- * <tr>
- * <td>gearStatus</td>
- * <td>Boolean</td>
- * <td>See GearStatus</td>
- * <td>N</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>prndl</td>
- * <td>Boolean</td>
- * <td>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</td>
- * <td>N</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
- * <tr>
- * <td>tirePressure</td>
- * <td>Boolean</td>
- * <td>Tire pressure status</td>
+ * <td>
+ * @since SmartDeviceLink 2.0.0
+ * @property-deprecated in SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>gearStatus</td>
+ * <td>Boolean</td>
+ * <td>See GearStatus</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>prndl</td>
+ * <td>Boolean</td>
+ * <td>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
+ * <tr>
+ * <td>tirePressure</td>
+ * <td>Boolean</td>
+ * <td>Tire pressure status</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>odometer</td>
- * <td>Boolean</td>
- * <td>Odometer in km</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>odometer</td>
+ * <td>Boolean</td>
+ * <td>Odometer in km</td>
* <td>N</td>
* <td>Max Length: 500</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>beltStatus</td>
- * <td>Boolean</td>
- * <td>The status of the seat belts</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>beltStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the seat belts</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>bodyInformation</td>
- * <td>Boolean</td>
- * <td>The body information including ignition status and internal temp</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>bodyInformation</td>
+ * <td>Boolean</td>
+ * <td>The body information including ignition status and internal temp</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>deviceStatus</td>
- * <td>Boolean</td>
- * <td>The device status including signal and battery strength</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>deviceStatus</td>
+ * <td>Boolean</td>
+ * <td>The device status including signal and battery strength</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>driverBraking</td>
- * <td>Boolean</td>
- * <td>The status of the brake pedal</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>driverBraking</td>
+ * <td>Boolean</td>
+ * <td>The status of the brake pedal</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>wiperStatus</td>
- * <td>Boolean</td>
- * <td>The status of the wipers</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>wiperStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the wipers</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>headLampStatus</td>
- * <td>Boolean</td>
- * <td>Status of the head lamps</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>headLampStatus</td>
+ * <td>Boolean</td>
+ * <td>Status of the head lamps</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>engineTorque</td>
- * <td>Boolean</td>
- * <td>Torque value for engine (in Nm) on non-diesel variants</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>engineTorque</td>
+ * <td>Boolean</td>
+ * <td>Torque value for engine (in Nm) on non-diesel variants</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>engineOilLife</td>
- * <td>Boolean</td>
- * <td>The estimated percentage of remaining oil life of the engine</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>engineOilLife</td>
+ * <td>Boolean</td>
+ * <td>The estimated percentage of remaining oil life of the engine</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 5.0 </td>
- * </tr>
- * <tr>
- * <td>accPedalPosition</td>
- * <td>Boolean</td>
- * <td>Accelerator pedal position (percentage depressed)</td>
+ * <td>SmartDeviceLink 5.0 </td>
+ * </tr>
+ * <tr>
+ * <td>accPedalPosition</td>
+ * <td>Boolean</td>
+ * <td>Accelerator pedal position (percentage depressed)</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>steeringWheelAngle</td>
- * <td>Boolean</td>
- * <td>Current angle of the steering wheel (in deg)</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>steeringWheelAngle</td>
+ * <td>Boolean</td>
+ * <td>Current angle of the steering wheel (in deg)</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>eCallInfo</td>
- * <td>Boolean</td>
- * <td>Emergency Call notification and confirmation data.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>eCallInfo</td>
+ * <td>Boolean</td>
+ * <td>Emergency Call notification and confirmation data.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>airbagStatus</td>
- * <td>Boolean</td>
- * <td>The status of the air bags.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>airbagStatus</td>
+ * <td>Boolean</td>
+ * <td>The status of the air bags.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>emergencyEvent</td>
- * <td>Boolean</td>
- * <td>Information related to an emergency event (and if it occurred).</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>emergencyEvent</td>
+ * <td>Boolean</td>
+ * <td>Information related to an emergency event (and if it occurred).</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>clusterModeStatus</td>
- * <td>Boolean</td>
- * <td>The status modes of the instrument panel cluster.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>clusterModeStatus</td>
+ * <td>Boolean</td>
+ * <td>The status modes of the instrument panel cluster.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>myKey</td>
- * <td>Boolean</td>
- * <td>Information related to the MyKey feature.</td>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>myKey</td>
+ * <td>Boolean</td>
+ * <td>Information related to the MyKey feature.</td>
* <td>N</td>
* <td>Subscribable</td>
- * <td>SmartDeviceLink 2.0 </td>
- * </tr>
- * <tr>
- * <td>turnSignal</td>
- * <td>Boolean</td>
- * <td>@see TurnSignal</td>
- * <td>N</td>
- * <td>Subscribable</td>
- * <td>SmartDeviceLink 5.0 </td>
- * </tr>
+ * <td>SmartDeviceLink 2.0 </td>
+ * </tr>
+ * <tr>
+ * <td>turnSignal</td>
+ * <td>Boolean</td>
+ * <td>@see TurnSignal</td>
+ * <td>N</td>
+ * <td>Subscribable</td>
+ * <td>SmartDeviceLink 5.0 </td>
+ * </tr>
* <tr>
* <td>handsOffSteering</td>
* <td>Boolean</td>
@@ -291,13 +291,13 @@ import java.util.Hashtable; * <td>N</td>
* <td>SmartDeviceLink 7.0.0</td>
* </tr>
- * <tr>
- * <td>stabilityControlsStatus</td>
- * <td>Boolean</td>
- * <td>See StabilityControlsStatus</td>
- * <td>N</td>
- * <td>SmartDeviceLink 7.0.0</td>
- * </tr>
+ * <tr>
+ * <td>stabilityControlsStatus</td>
+ * <td>Boolean</td>
+ * <td>See StabilityControlsStatus</td>
+ * <td>N</td>
+ * <td>SmartDeviceLink 7.0.0</td>
+ * </tr>
* <tr>
* <td>climateData</td>
* <td>Boolean</td>
@@ -308,30 +308,30 @@ import java.util.Hashtable; * @since SmartDeviceLink 7.1.0
* </td>
* </tr>
- * <tr>
- * <td>seatOccupancy</td>
- * <td>Boolean</td>
- * <td>See SeatOccupancy</td>
- * <td>N</td>
- * <td></td>
- * <td>
- * @since SmartDeviceLink 7.1.0
- * </td>
- * </tr>
+ * <tr>
+ * <td>seatOccupancy</td>
+ * <td>Boolean</td>
+ * <td>See SeatOccupancy</td>
+ * <td>N</td>
+ * <td></td>
+ * <td>
+ * @since SmartDeviceLink 7.1.0
+ * </td>
+ * </tr>
*
*
* </table>
* <p><b> Response</b></p>
* <p><b>Non-default Result Codes:</b></p>
- * <p>SUCCESS</p>
- * <p>WARNINGS</p>
- * <p>INVALID_DATA</p>
- * <p>OUT_OF_MEMORY</p>
- * <p>TOO_MANY_PENDING_REQUESTS</p>
- * <p>APPLICATION_NOT_REGISTERED</p>
- * <p>GENERIC_ERROR</p>
- * <p>IGNORED</p>
- * <p>DISALLOWED</p>
+ * <p>SUCCESS</p>
+ * <p>WARNINGS</p>
+ * <p>INVALID_DATA</p>
+ * <p>OUT_OF_MEMORY</p>
+ * <p>TOO_MANY_PENDING_REQUESTS</p>
+ * <p>APPLICATION_NOT_REGISTERED</p>
+ * <p>GENERIC_ERROR</p>
+ * <p>IGNORED</p>
+ * <p>DISALLOWED</p>
*
* @see SubscribeVehicleData
* @see GetVehicleData
@@ -544,7 +544,7 @@ public class UnsubscribeVehicleData extends RPCRequest { * Sets the externalTemperature.
*
* @param externalTemperature The external temperature in degrees celsius. This parameter is deprecated starting RPC
- * Spec 7.1.0, please see climateData.
+ * Spec 7.1.0, please see climateData.
* @since SmartDeviceLink 2.0.0
* @deprecated in SmartDeviceLink 7.1.0
*/
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 372c6fc51..9cb5421a8 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleDataResponse.java @@ -257,7 +257,7 @@ public class UnsubscribeVehicleDataResponse extends RPCResponse { * Sets the externalTemperature.
*
* @param externalTemperature The external temperature in degrees celsius. This parameter is deprecated starting RPC
- * Spec 7.1.0, please see climateData.
+ * Spec 7.1.0, please see climateData.
* @since SmartDeviceLink 2.0.0
* @deprecated in SmartDeviceLink 7.1.0
*/
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java index 5ca1256d9..7ca14a25f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java @@ -44,30 +44,30 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>dataType</td>
- * <td>VehicleDataType</td>
- * <td>Defined published data element type.</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>dataType</td>
+ * <td>VehicleDataType</td>
+ * <td>Defined published data element type.</td>
* <td></td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
- * <tr>
- * <td>resultCode</td>
- * <td>VehicleDataResultCode</td>
- * <td>Published data result code.</td>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
+ * <tr>
+ * <td>resultCode</td>
+ * <td>VehicleDataResultCode</td>
+ * <td>Published data result code.</td>
* <td></td>
- * <td></td>
- * <td>SmartDeviceLink 1.0</td>
- * </tr>
+ * <td></td>
+ * <td>SmartDeviceLink 1.0</td>
+ * </tr>
* </table>
*/
public class VehicleDataResult extends RPCStruct {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java index 822114c3c..8841126c3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java @@ -40,52 +40,52 @@ import java.util.Hashtable; * Describes the type of vehicle the mobile phone is connected with.
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Name</th>
- * <th>Type</th>
- * <th>Description</th>
- * <th>SmartDeviceLink Ver. Available</th>
- * </tr>
- * <tr>
- * <td>make</td>
- * <td>String</td>
- * <td>Make of the vehicle
- * <ul>
- * <li>Maxlength = 500</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>Model</td>
- * <td>String</td>
- * <td>Model of the vehicle, e.g. Fiesta
- * <ul>
- * <li>Maxlength = 500</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>modelYear</td>
- * <td>String</td>
- * <td>Model Year of the vehicle, e.g. 2013
- * <ul>
- * <li>Maxlength = 500</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
- * <tr>
- * <td>trim</td>
- * <td>String</td>
- * <td>Trim of the vehicle, e.g. SE
- * <ul>
- * <li>Maxlength = 500</li>
- * </ul>
- * </td>
- * <td>SmartDeviceLink 2.0</td>
- * </tr>
+ * <tr>
+ * <th>Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
+ * <th>SmartDeviceLink Ver. Available</th>
+ * </tr>
+ * <tr>
+ * <td>make</td>
+ * <td>String</td>
+ * <td>Make of the vehicle
+ * <ul>
+ * <li>Maxlength = 500</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>Model</td>
+ * <td>String</td>
+ * <td>Model of the vehicle, e.g. Fiesta
+ * <ul>
+ * <li>Maxlength = 500</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>modelYear</td>
+ * <td>String</td>
+ * <td>Model Year of the vehicle, e.g. 2013
+ * <ul>
+ * <li>Maxlength = 500</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
+ * <tr>
+ * <td>trim</td>
+ * <td>String</td>
+ * <td>Trim of the vehicle, e.g. SE
+ * <ul>
+ * <li>Maxlength = 500</li>
+ * </ul>
+ * </td>
+ * <td>SmartDeviceLink 2.0</td>
+ * </tr>
* </table>
*
* @since SmartDeviceLink 2.0
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 2b63ef2a0..bc879f89b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VideoStreamingCapability.java @@ -204,7 +204,8 @@ public class VideoStreamingCapability extends RPCStruct { /** * Sets the additionalVideoStreamingCapabilities. * - * @param additionalVideoStreamingCapabilities {"array_min_size": 1, "array_max_size": 100} + * @param additionalVideoStreamingCapabilities + * {"array_min_size": 1, "array_max_size": 100} * @since SmartDeviceLink 7.1.0 */ public VideoStreamingCapability setAdditionalVideoStreamingCapabilities(List<VideoStreamingCapability> additionalVideoStreamingCapabilities) { diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java index 8f6d29bf9..6139f66f7 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java @@ -42,38 +42,38 @@ import java.util.Hashtable; *
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
- * <tr>
- * <th>Param Name</th>
- * <th>Type</th>
- * <th>Description</th>
+ * <tr>
+ * <th>Param Name</th>
+ * <th>Type</th>
+ * <th>Description</th>
* <th> Req.</th>
- * <th>Notes</th>
- * <th>Version Available</th>
- * </tr>
- * <tr>
- * <td>text</td>
- * <td>String</td>
- * <td>Text to display for VR Help item</td>
+ * <th>Notes</th>
+ * <th>Version Available</th>
+ * </tr>
+ * <tr>
+ * <td>text</td>
+ * <td>String</td>
+ * <td>Text to display for VR Help item</td>
* <td>Y</td>
- * <td>maxlength: 500</td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
- * <tr>
- * <td>image</td>
- * <td>Image</td>
- * <td>Image struct for VR Help item</td>
+ * <td>maxlength: 500</td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>image</td>
+ * <td>Image</td>
+ * <td>Image struct for VR Help item</td>
* <td>N</td>
- * <td></td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
- * <tr>
- * <td>position</td>
- * <td>Integer</td>
- * <td>Position to display item in VR Help list</td>
+ * <td></td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
+ * <tr>
+ * <td>position</td>
+ * <td>Integer</td>
+ * <td>Position to display item in VR Help list</td>
* <td>N</td>
- * <td> minvalue=1; maxvalue=100</td>
- * <td>SmartDeviceLink 2.3.2</td>
- * </tr>
+ * <td> minvalue=1; maxvalue=100</td>
+ * <td>SmartDeviceLink 2.3.2</td>
+ * </tr>
* </table>
*/
public class VrHelpItem extends RPCStruct {
diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/AppCapabilityType.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/AppCapabilityType.java index 1cbd997e5..7b76d3e5f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/AppCapabilityType.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/AppCapabilityType.java @@ -42,7 +42,6 @@ public enum AppCapabilityType { /** * Convert String to AppCapabilityType - * * @param value String * @return AppCapabilityType */ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java index a9f319d66..e0ff50265 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java @@ -36,133 +36,133 @@ package com.smartdevicelink.proxy.rpc.enums; * * <p><b>Enum List</b></p> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>NAVIGATION</td> - * <td>NavigationCapability</td> - * <td>Returns Navigation Capabilities</td> - * <td align=center>Y</td> - * <td>Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * <tr> - * <td>PHONE_CALL</td> - * <td>PhoneCapability</td> - * <td>Returns Phone Capabilities</td> - * <td align=center>Y</td> - * <td>Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * <tr> - * <td>VIDEO_STREAMING</td> - * <td>VideoStreamingCapability</td> - * <td>Returns Video Streaming Capabilities</td> - * <td align=center>Y</td> - * <td>Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * <tr> - * <td>REMOTE_CONTROL</td> - * <td>RemoteControlCapabilities</td> - * <td>Returns Remote Control Capabilities</td> - * <td align=center>Y</td> - * <td>Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * <tr> - * <td>HMI</td> - * <td>HMICapabilities</td> - * <td>Returns HMI Capabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * <tr> - * <td>DISPLAY</td> - * <td>DisplayCapabilities</td> - * <td>Returns Display Capabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * <tr> - * <td>AUDIO_PASSTHROUGH</td> - * <td>List<AudioPassThruCapabilities></td> - * <td>Returns a List of AudioPassThruCapabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> - * </tr> - * <tr> - * <td>PCM_STREAMING</td> - * <td>AudioPassThruCapabilities</td> - * <td>Returns an AudioPassThruCapabilities Object</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> - * </tr> - * <tr> - * <td>BUTTON</td> - * <td>List<ButtonCapabilities></td> - * <td>Returns a List of ButtonCapabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> - * </tr> - * <tr> - * <td>HMI_ZONE</td> - * <td>HmiZoneCapabilities</td> - * <td>Returns HmiZone Capabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * <tr> - * <td>PRESET_BANK</td> - * <td>PresetBankCapabilities</td> - * <td>Returns PresetBank Capabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * <tr> - * <td>SOFTBUTTON</td> - * <td>List<SoftButtonCapabilities></td> - * <td>Returns a List of SoftButtonCapabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> - * </tr> - * <tr> - * <td>SPEECH</td> - * <td>SpeechCapabilities</td> - * <td>Returns Speech Capabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * <tr> - * <td>VOICE_RECOGNITION</td> - * <td>VrCapabilities</td> - * <td>Returns VOICE_RECOGNITION</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * <tr> - * <td>APP_SERVICES</td> - * <td>AppServicesCapabilities</td> - * <td>Returns APP_SERVICES</td> - * <td align=center>N</td> - * <td>Available Asynchronously, Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * <tr> - * <td>SEAT_LOCATION</td> - * <td>SeatLocationCapability</td> - * <td>Returns SEAT_LOCATION</td> - * <td align=center>N</td> - * <td>Available Asynchronously, Call is synchronous <strong>after</strong> initial call</strong></td> - * </tr> - * <tr> - * <td>DRIVER_DISTRACTION</td> - * <d>DriverDistractionCapability</td> - * <td>Returns DRIVER_DISTRACTION</td> - * <td align=center>N</td> - * <td><strong>Since 7.0</strong> Describes capabilities when the driver is distracted</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>NAVIGATION</td> + * <td>NavigationCapability</td> + * <td>Returns Navigation Capabilities</td> + * <td align=center>Y</td> + * <td>Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * <tr> + * <td>PHONE_CALL</td> + * <td>PhoneCapability</td> + * <td>Returns Phone Capabilities</td> + * <td align=center>Y</td> + * <td>Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * <tr> + * <td>VIDEO_STREAMING</td> + * <td>VideoStreamingCapability</td> + * <td>Returns Video Streaming Capabilities</td> + * <td align=center>Y</td> + * <td>Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * <tr> + * <td>REMOTE_CONTROL</td> + * <td>RemoteControlCapabilities</td> + * <td>Returns Remote Control Capabilities</td> + * <td align=center>Y</td> + * <td>Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * <tr> + * <td>HMI</td> + * <td>HMICapabilities</td> + * <td>Returns HMI Capabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * <tr> + * <td>DISPLAY</td> + * <td>DisplayCapabilities</td> + * <td>Returns Display Capabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * <tr> + * <td>AUDIO_PASSTHROUGH</td> + * <td>List<AudioPassThruCapabilities></td> + * <td>Returns a List of AudioPassThruCapabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> + * </tr> + * <tr> + * <td>PCM_STREAMING</td> + * <td>AudioPassThruCapabilities</td> + * <td>Returns an AudioPassThruCapabilities Object</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> + * </tr> + * <tr> + * <td>BUTTON</td> + * <td>List<ButtonCapabilities></td> + * <td>Returns a List of ButtonCapabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> + * </tr> + * <tr> + * <td>HMI_ZONE</td> + * <td>HmiZoneCapabilities</td> + * <td>Returns HmiZone Capabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * <tr> + * <td>PRESET_BANK</td> + * <td>PresetBankCapabilities</td> + * <td>Returns PresetBank Capabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * <tr> + * <td>SOFTBUTTON</td> + * <td>List<SoftButtonCapabilities></td> + * <td>Returns a List of SoftButtonCapabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> + * </tr> + * <tr> + * <td>SPEECH</td> + * <td>SpeechCapabilities</td> + * <td>Returns Speech Capabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * <tr> + * <td>VOICE_RECOGNITION</td> + * <td>VrCapabilities</td> + * <td>Returns VOICE_RECOGNITION</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * <tr> + * <td>APP_SERVICES</td> + * <td>AppServicesCapabilities</td> + * <td>Returns APP_SERVICES</td> + * <td align=center>N</td> + * <td>Available Asynchronously, Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * <tr> + * <td>SEAT_LOCATION</td> + * <td>SeatLocationCapability</td> + * <td>Returns SEAT_LOCATION</td> + * <td align=center>N</td> + * <td>Available Asynchronously, Call is synchronous <strong>after</strong> initial call</strong></td> + * </tr> + * <tr> + * <td>DRIVER_DISTRACTION</td> + * <d>DriverDistractionCapability</td> + * <td>Returns DRIVER_DISTRACTION</td> + * <td align=center>N</td> + * <td><strong>Since 7.0</strong> Describes capabilities when the driver is distracted</td> + * </tr> + * </table> */ public enum SystemCapabilityType { @@ -170,82 +170,82 @@ public enum SystemCapabilityType { /** * <strong>Requires</strong> initial asynchronous call, then available synchronously after successful call. <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>NAVIGATION</td> - * <td>NavigationCapability</td> - * <td>Returns Navigation Capabilities</td> - * <td align=center>Y</td> - * <td>Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>NAVIGATION</td> + * <td>NavigationCapability</td> + * <td>Returns Navigation Capabilities</td> + * <td align=center>Y</td> + * <td>Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * </table> */ NAVIGATION(true), /** * <strong>Requires</strong> initial asynchronous call, then available synchronously after successful call. <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>PHONE_CALL</td> - * <td>PhoneCapability</td> - * <td>Returns Phone Capabilities</td> - * <td align=center>Y</td> - * <td>Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>PHONE_CALL</td> + * <td>PhoneCapability</td> + * <td>Returns Phone Capabilities</td> + * <td align=center>Y</td> + * <td>Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * </table> */ PHONE_CALL(true), /** * <strong>Requires</strong> initial asynchronous call, then available synchronously after successful call. <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>VIDEO_STREAMING</td> - * <td>VideoStreamingCapability</td> - * <td>Returns Video Streaming Capabilities</td> - * <td align=center>Y</td> - * <td>Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>VIDEO_STREAMING</td> + * <td>VideoStreamingCapability</td> + * <td>Returns Video Streaming Capabilities</td> + * <td align=center>Y</td> + * <td>Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * </table> */ VIDEO_STREAMING(true), /** * <strong>Requires</strong> initial asynchronous call, then available synchronously after successful call. <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <td>REMOTE_CONTROL</td> - * <td>RemoteControlCapabilities</td> - * <td>Returns Remote Control Capabilities</td> - * <td align=center>Y</td> - * <td>Call is synchronous <strong>after</strong> initial call</td> - * </tr> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <td>REMOTE_CONTROL</td> + * <td>RemoteControlCapabilities</td> + * <td>Returns Remote Control Capabilities</td> + * <td align=center>Y</td> + * <td>Call is synchronous <strong>after</strong> initial call</td> + * </tr> * </table> */ REMOTE_CONTROL(true), @@ -255,20 +255,20 @@ public enum SystemCapabilityType { /** * Available Synchronously after Register App Interface response <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>HMI</td> - * <td>HMICapabilities</td> - * <td>Returns HMI Capabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>HMI</td> + * <td>HMICapabilities</td> + * <td>Returns HMI Capabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> * </table> */ HMI(false), @@ -277,21 +277,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response <br> * Returns: DisplayCapabilities * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>DISPLAY</td> - * <td>DisplayCapabilities</td> - * <td>Returns Display Capabilities</td> - * <td align=center>N</td> - * <td> Available Synchronously <strong>after</strong> Register App Interface response received</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>DISPLAY</td> + * <td>DisplayCapabilities</td> + * <td>Returns Display Capabilities</td> + * <td align=center>N</td> + * <td> Available Synchronously <strong>after</strong> Register App Interface response received</td> + * </tr> + * </table> */ @Deprecated DISPLAY(false), @@ -301,21 +301,21 @@ public enum SystemCapabilityType { * @since 6.0 * Returns: List<DisplayCapability> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>DISPLAYS</td> - * <td>List<DisplayCapability></td> - * <td>Returns a list of Display Capability</td> - * <td align=center>Y</td> - * <td> <strong>Since 6.0</strong> Contain the display related information and all windows related to that display.</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>DISPLAYS</td> + * <td>List<DisplayCapability></td> + * <td>Returns a list of Display Capability</td> + * <td align=center>Y</td> + * <td> <strong>Since 6.0</strong> Contain the display related information and all windows related to that display.</td> + * </tr> + * </table> */ DISPLAYS(true), @@ -323,21 +323,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response <br> * Returns: List<PrerecordedSpeech> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>PRERECORDED_SPEECH</td> - * <td>prerecordedSpeechCapabilities</td> - * <td>Returns List<PrerecordedSpeech></td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response received</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>PRERECORDED_SPEECH</td> + * <td>prerecordedSpeechCapabilities</td> + * <td>Returns List<PrerecordedSpeech></td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response received</td> + * </tr> + * </table> */ PRERECORDED_SPEECH(false), @@ -345,21 +345,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response <br> * <b>Note:</b> @SuppressWarnings("unchecked") may be needed when casting depending on implementation * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>AUDIO_PASSTHROUGH</td> - * <td>List<AudioPassThruCapabilities></td> - * <td>Returns a List of AudioPassThruCapabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>AUDIO_PASSTHROUGH</td> + * <td>List<AudioPassThruCapabilities></td> + * <td>Returns a List of AudioPassThruCapabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> + * </tr> + * </table> */ AUDIO_PASSTHROUGH(false), @@ -367,21 +367,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response <br> * <b>Note:</b> @SuppressWarnings("unchecked") may be needed when casting depending on implementation * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>PCM_STREAMING</td> - * <td>AudioPassThruCapabilities</td> - * <td>Returns a AudioPassThruCapabilities Object</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>PCM_STREAMING</td> + * <td>AudioPassThruCapabilities</td> + * <td>Returns a AudioPassThruCapabilities Object</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> + * </tr> + * </table> */ PCM_STREAMING(false), @@ -389,21 +389,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response <br> * <b>Note:</b> @SuppressWarnings("unchecked") may be needed when casting depending on implementation * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>BUTTON</td> - * <td>List<ButtonCapabilities></td> - * <td>Returns a List of ButtonCapabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>BUTTON</td> + * <td>List<ButtonCapabilities></td> + * <td>Returns a List of ButtonCapabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> + * </tr> + * </table> */ @Deprecated BUTTON(false), @@ -411,42 +411,42 @@ public enum SystemCapabilityType { /** * Available Synchronously after Register App Interface response <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>HMI_ZONE</td> - * <td>HmiZoneCapabilities</td> - * <td>Returns HmiZone Capabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>HMI_ZONE</td> + * <td>HmiZoneCapabilities</td> + * <td>Returns HmiZone Capabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * </table> */ HMI_ZONE(false), /** * Available Synchronously after Register App Interface response <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>PRESET_BANK</td> - * <td>PresetBankCapabilities</td> - * <td>Returns PresetBank Capabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>PRESET_BANK</td> + * <td>PresetBankCapabilities</td> + * <td>Returns PresetBank Capabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * </table> */ @Deprecated PRESET_BANK(false), @@ -456,21 +456,21 @@ public enum SystemCapabilityType { * Returns: List<SoftButtonCapabilities> <br> * Note: @SuppressWarnings("unchecked") may be needed when casting depending on implementation * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>SOFTBUTTON</td> - * <td>List<SoftButtonCapabilities></td> - * <td>Returns a List of SoftButtonCapabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>SOFTBUTTON</td> + * <td>List<SoftButtonCapabilities></td> + * <td>Returns a List of SoftButtonCapabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation</td> + * </tr> + * </table> */ @Deprecated SOFTBUTTON(false), @@ -478,102 +478,102 @@ public enum SystemCapabilityType { /** * Available Synchronously after Register App Interface response <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>SPEECH</td> - * <td>SpeechCapabilities</td> - * <td>Returns Speech Capabilities</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>SPEECH</td> + * <td>SpeechCapabilities</td> + * <td>Returns Speech Capabilities</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * </table> */ SPEECH(false), /** * Available Synchronously after Register App Interface response <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>VOICE_RECOGNITION</td> - * <td>VrCapabilities</td> - * <td>Returns VOICE_RECOGNITION</td> - * <td align=center>N</td> - * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>VOICE_RECOGNITION</td> + * <td>VrCapabilities</td> + * <td>Returns VOICE_RECOGNITION</td> + * <td align=center>N</td> + * <td>Available Synchronously <strong>after</strong> Register App Interface response</td> + * </tr> + * </table> */ VOICE_RECOGNITION(false), /** * Available Synchronously after Register App Interface response <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>APP_SERVICES</td> - * <td>AppServicesCapabilities</td> - * <td>Returns APP_SERVICES</td> - * <td align=center>N</td> - * <td>Available Asynchronously, Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>APP_SERVICES</td> + * <td>AppServicesCapabilities</td> + * <td>Returns APP_SERVICES</td> + * <td align=center>N</td> + * <td>Available Asynchronously, Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * </table> */ APP_SERVICES(true), /** * Available Synchronously after Register App Interface response <br> * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>SEAT_LOCATION</td> - * <td>SeatLocationCapability</td> - * <td>Returns SEAT_LOCATION</td> - * <td align=center>N</td> - * <td>Available Asynchronously, Call is synchronous <strong>after</strong> initial call</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>SEAT_LOCATION</td> + * <td>SeatLocationCapability</td> + * <td>Returns SEAT_LOCATION</td> + * <td align=center>N</td> + * <td>Available Asynchronously, Call is synchronous <strong>after</strong> initial call</td> + * </tr> + * </table> */ SEAT_LOCATION(true), /** * <table border="1" rules="all"> - * <tr> - * <th>Enum Name</th> - * <th>Return Type</th> - * <th>Description</th> - * <th>Requires Async?</th> - * <th>Notes</th> - * </tr> - * <tr> - * <td>DRIVER_DISTRACTION</td> - * <td>DriverDistractionCapability</td> - * <td>Returns DRIVER_DISTRACTION</td> - * <td align=center>N</td> - * <td><strong>Since 7.0</strong> Describes capabilities when the driver is distracted</td> - * </tr> - * </table> + * <tr> + * <th>Enum Name</th> + * <th>Return Type</th> + * <th>Description</th> + * <th>Requires Async?</th> + * <th>Notes</th> + * </tr> + * <tr> + * <td>DRIVER_DISTRACTION</td> + * <td>DriverDistractionCapability</td> + * <td>Returns DRIVER_DISTRACTION</td> + * <td align=center>N</td> + * <td><strong>Since 7.0</strong> Describes capabilities when the driver is distracted</td> + * </tr> + * </table> */ DRIVER_DISTRACTION(true); diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/VehicleDataType.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/VehicleDataType.java index 9255f8b08..050a0169c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/VehicleDataType.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/VehicleDataType.java @@ -67,7 +67,6 @@ public enum VehicleDataType { VEHICLEDATA_CLIMATEDATA,
/**
* Notifies EXTERNTEMPData may be subscribed
- *
* @deprecated since SmartDeviceLink 7.1.0
*/
@Deprecated
@@ -193,7 +192,7 @@ public enum VehicleDataType { * @since SmartDeviceLink 7.0.0
*/
VEHICLEDATA_GEARSTATUS,
- /**
+ /**
* @since SmartDeviceLink 7.1.0
*/
VEHICLEDATA_SEATOCCUPANCY;
diff --git a/base/src/main/java/com/smartdevicelink/session/BaseSdlSession.java b/base/src/main/java/com/smartdevicelink/session/BaseSdlSession.java index 73221ec86..a33d3eb04 100644 --- a/base/src/main/java/com/smartdevicelink/session/BaseSdlSession.java +++ b/base/src/main/java/com/smartdevicelink/session/BaseSdlSession.java @@ -308,7 +308,6 @@ public abstract class BaseSdlSession implements ISdlProtocol, ISecurityInitializ /** * Extracts the SystemInfo out of a packet - * * @param packet should be a StartServiceACK for the RPC service * @return an instance of SystemInfo if the information is available, null otherwise */ @@ -515,7 +514,7 @@ public abstract class BaseSdlSession implements ISdlProtocol, ISecurityInitializ * Retrieves list of the active transports * * @return a list of active transports - */ + * */ @Nullable public List<TransportRecord> getActiveTransports() { if (this.sdlProtocol != null) { diff --git a/base/src/main/java/com/smartdevicelink/session/ISdlSessionListener.java b/base/src/main/java/com/smartdevicelink/session/ISdlSessionListener.java index 863c52559..2f754a30e 100644 --- a/base/src/main/java/com/smartdevicelink/session/ISdlSessionListener.java +++ b/base/src/main/java/com/smartdevicelink/session/ISdlSessionListener.java @@ -62,8 +62,8 @@ public interface ISdlSessionListener { * Called to indicate that a session has started with the connected SDL device. This means the * RPC and Bulk service types have also been started. * - * @param sessionID session ID associated with the session that was established - * @param version the protocol version that has been negotiated for this session + * @param sessionID session ID associated with the session that was established + * @param version the protocol version that has been negotiated for this session * @param systemInfo info about the device that this service is started */ void onSessionStarted(int sessionID, Version version, SystemInfo systemInfo); diff --git a/base/src/main/java/com/smartdevicelink/streaming/video/VideoStreamingParameters.java b/base/src/main/java/com/smartdevicelink/streaming/video/VideoStreamingParameters.java index 977f120e0..77e0ffb0a 100644 --- a/base/src/main/java/com/smartdevicelink/streaming/video/VideoStreamingParameters.java +++ b/base/src/main/java/com/smartdevicelink/streaming/video/VideoStreamingParameters.java @@ -88,7 +88,6 @@ public class VideoStreamingParameters { /** * deprecated constructor of VideoStreamingParameters. This constructor will be removed in the future version. - * * @param displayDensity * @param frameRate * @param bitrate @@ -110,7 +109,6 @@ public class VideoStreamingParameters { /** * new constructor of VideoStreamingParameters, which now has stableFrameRate param. - * * @param displayDensity * @param frameRate * @param bitrate diff --git a/base/src/main/java/com/smartdevicelink/util/BitConverter.java b/base/src/main/java/com/smartdevicelink/util/BitConverter.java index 1133579b9..df507d6fe 100644 --- a/base/src/main/java/com/smartdevicelink/util/BitConverter.java +++ b/base/src/main/java/com/smartdevicelink/util/BitConverter.java @@ -107,7 +107,7 @@ public class BitConverter { /**
* @param sizeBuf byte array that will be converted to int
- * @param offset The position indicating where to begin converting.
+ * @param offset The position indicating where to begin converting.
* @return int converted from byte array,
* -1 if byte array is null,
* and 0 if the offset is greater than the length of the byte array
@@ -137,7 +137,7 @@ public class BitConverter { /**
* @param sizeBuf byte array that will be converted to short
- * @param offset The position indicating where to begin converting.
+ * @param offset The position indicating where to begin converting.
* @return short converted from byte array,
* -1 if byte array is null,
* and 0 if the offset is greater than the length of the byte array
diff --git a/base/src/main/java/com/smartdevicelink/util/FileUtls.java b/base/src/main/java/com/smartdevicelink/util/FileUtls.java index c4db14e76..387f06b5b 100644 --- a/base/src/main/java/com/smartdevicelink/util/FileUtls.java +++ b/base/src/main/java/com/smartdevicelink/util/FileUtls.java @@ -32,7 +32,6 @@ package com.smartdevicelink.util; import androidx.annotation.NonNull; - import com.smartdevicelink.BuildConfig; import java.io.ByteArrayOutputStream; diff --git a/generator/templates/base_template.java b/generator/templates/base_template.java index 556eb76be..e2f44a2cf 100644 --- a/generator/templates/base_template.java +++ b/generator/templates/base_template.java @@ -29,17 +29,15 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ -package - -{{package_name}}; - {%for i in imports%} - {%-if i!=''%} -import {{i}};{{'\n'if loop.last}} - {%-else%} - {{''}} - {%-endif%} - {%-endfor%} - {%-if description is defined or since is defined or see is defined or deprecated is defined%} +package {{package_name}}; +{% for i in imports %} +{%- if i != '' %} +import {{i}};{{ '\n' if loop.last }} +{%- else %} +{{''}} +{%- endif %} +{%- endfor %} +{%- if description is defined or since is defined or see is defined or deprecated is defined %} /** {%- if description is defined %} {%- for d in description %} @@ -65,13 +63,13 @@ import {{i}};{{'\n'if loop.last}} * <td>{%- for d in param.description %}{{d}}{%- endfor %}</td> * <td>{%- if param.mandatory is eq true %}Y{%- else %}N{%- endif %}</td> * <td>{%- for k in param.values %}{{ '{' if loop.first}}"{{k}}": {{param.values[k]}}{{ ', ' if not loop.last else '}'}}{%- endfor %}</td> - {%- if param.since is defined and param.since is not none %}{% set see, deprecated, since, history, spacing, headerParam = param.see, param.deprecated, param.since, param.history, ' * ', 'true' %} + {%- if param.since is defined and param.since is not none %}{% set see, deprecated, since, history, spacing, headerParam = param.see, param.deprecated, param.since, param.history, ' * ', 'true' %} * <td> - {%- include "javadoc_version_info.java" %} + {%- include "javadoc_version_info.java" %} * </td> - {%- else %} + {%- else %} * <td></td> - {%- endif %} + {%- endif %} * </tr> {%- endfor %} * </table> @@ -81,9 +79,9 @@ import {{i}};{{'\n'if loop.last}} {%- endif %}{% set prefix = ' * ' %} {%- include "javadoc_version_info.java" %} */ - {%-endif%} - {%-if deprecated is not none%} +{%- endif %} +{%- if deprecated is not none %} @Deprecated -{%-endif%} - {%-block body%} - {%endblock-%} +{%- endif %} +{%- block body %} +{% endblock -%} diff --git a/generator/templates/enum_template.java b/generator/templates/enum_template.java index 29c6bed85..72b88494e 100644 --- a/generator/templates/enum_template.java +++ b/generator/templates/enum_template.java @@ -1,83 +1,83 @@ -{%extends"base_template.java"%} - {%block body%} -public enum {{class_name}}{ - {%-for param in params%} - {%-if param.description is defined or param.since is defined%} - /** - {%- if param.description is defined %} - {%- for d in param.description %} - * {{d}} - {%- endfor %}{% endif -%} - {%- if param.description is defined and (param.since is defined or param.see is defined) %} - * - {%- endif %}{% set see, deprecated, since, history, spacing, prefix = param.see, param.deprecated, param.since, param.history, ' ', ' * ' %} - {%- include "javadoc_version_info.java" %} - */ - {%-endif%} - {%-if param.deprecated is defined%} -@Deprecated - {%-endif%} - {%-if kind=="simple"%} - {{param.name}}{{","if not loop.last}} - {%-elif kind=="custom"%} - {{param.name}}({{param.internal}}){{","if not loop.last}} - {%-endif%} - {%-endfor%}; +{% extends "base_template.java" %} +{% block body %} +public enum {{class_name}} { + {%- for param in params %} + {%- if param.description is defined or param.since is defined %} + /** + {%- if param.description is defined %} + {%- for d in param.description %} + * {{d}} + {%- endfor %}{% endif -%} + {%- if param.description is defined and (param.since is defined or param.see is defined) %} + * + {%- endif %}{% set see, deprecated, since, history, spacing, prefix = param.see, param.deprecated, param.since, param.history, ' ', ' * ' %} + {%- include "javadoc_version_info.java" %} + */ + {%- endif %} + {%- if param.deprecated is defined %} + @Deprecated + {%- endif %} + {%- if kind == "simple" %} + {{param.name}}{{ "," if not loop.last }} + {%- elif kind == "custom" %} + {{param.name}}({{param.internal}}){{ "," if not loop.last }} + {%- endif %} + {%- endfor %}; - {%-if kind=="simple"%} + {%- if kind == "simple" %} -/** - * Convert String to {{class_name}} - * - * @param value String - * @return {{class_name}} - */ -public static {{class_name}}valueForString(String value){ - try{ - return valueOf(value); - }catch(Exception e){ - return null; - } + /** + * Convert String to {{class_name}} + * + * @param value String + * @return {{class_name}} + */ + public static {{class_name}} valueForString(String value) { + try { + return valueOf(value); + } catch (Exception e) { + return null; } - {%-elif kind=="custom"%} + } + {%- elif kind == "custom" %} -private final String VALUE; + private final String VALUE; -/** - * Private constructor - */ -private {{class_name}}(String value){ - this.VALUE=value; - } + /** + * Private constructor + */ + private {{class_name}}(String value) { + this.VALUE = value; + } -/** - * Convert String to {{class_name}} - * - * @param value String - * @return {{class_name}} - */ -public static {{class_name}}valueForString(String value){ - if(value==null){ - return null; + /** + * Convert String to {{class_name}} + * + * @param value String + * @return {{class_name}} + */ + public static {{class_name}} valueForString(String value) { + if (value == null) { + return null; } - for({{class_name}}anEnum:EnumSet.allOf({{class_name}}.class)){ - if(anEnum.toString().equals(value)){ - return anEnum; - } + for ({{class_name}} anEnum : EnumSet.allOf({{class_name}}.class)) { + if (anEnum.toString().equals(value)) { + return anEnum; + } } return null; - } + } -/** - * Return String value of element - * - * @return String - */ -@Override -public String toString(){ + /** + * Return String value of element + * + * @return String + */ + @Override + public String toString() { return VALUE; - } - {%-endif%} - } - {%endblock-%}
\ No newline at end of file + } + {%- endif %} +} +{% endblock -%}
\ No newline at end of file diff --git a/generator/templates/function_template.java b/generator/templates/function_template.java index 3c153639e..96ac7cf99 100644 --- a/generator/templates/function_template.java +++ b/generator/templates/function_template.java @@ -1,68 +1,68 @@ -{%extends"struct_function_template.java"%} +{% extends "struct_function_template.java" %} - {%-block params%} - {%-if params is defined%} - {%-for p in params%} - {%-if p.origin not in('success','resultCode','info')or kind!="response"%}{%set see,deprecated,since,history,spacing,begin,end,prefix=p.see,p.deprecated,p.since,p.history,' ','/**',' */',' * '%} - {%-include"javadoc_version_info.java"%} - {%-if p.deprecated is not none%} -@Deprecated - {%-endif%} -public static final String{{p.key}}="{{p.origin}}"; - {%-endif%} - {%-endfor%} - {%-endif%} - {%-endblock%} + {%- block params %} + {%- if params is defined %} + {%- for p in params %} + {%- if p.origin not in ('success', 'resultCode', 'info') or kind != "response" %}{% set see, deprecated, since, history, spacing, begin, end, prefix = p.see, p.deprecated, p.since, p.history, ' ', '/**', ' */', ' * ' %} + {%- include "javadoc_version_info.java" %} + {%- if p.deprecated is not none %} + @Deprecated + {%- endif %} + public static final String {{p.key}} = "{{p.origin}}"; + {%- endif %} + {%- endfor %} + {%- endif %} + {%- endblock %} - {%-block constructor_simple%} -public {{class_name}}(){ + {%- block constructor_simple %} + public {{class_name}}() { super(FunctionID.{{function_id}}.toString()); - }{%endblock-%} + }{% endblock -%} - {%-block setter%} - {%-for p in params|rejectattr('name')%} - {%-if p.origin not in('success','resultCode','info')or kind!="response"%} + {%- block setter %} + {%- for p in params|rejectattr('name') %} + {%- if p.origin not in ('success', 'resultCode', 'info') or kind != "response" %} - /** - * Sets the {{p.origin}}. - * - {%- include "javadoc_template.java" %} - */ - {%-if p.deprecated is defined and p.deprecated is not none%} -@Deprecated - {%-endif%} -public {{class_name}}set{{p.title}}({%if p.mandatory%}@NonNull {%endif%}{{p.return_type}}{{p.last}}){ - setParameters({{p.key}},{{p.last}}); + /** + * Sets the {{p.origin}}. + * + {%- include "javadoc_template.java" %} + */ + {%- if p.deprecated is defined and p.deprecated is not none %} + @Deprecated + {%- endif %} + public {{class_name}} set{{p.title}}({% if p.mandatory %}@NonNull {% endif %}{{p.return_type}} {{p.last}}) { + setParameters({{p.key}}, {{p.last}}); return this; - } + } - /** - * Gets the {{p.origin}}. - * - {%- include "javadoc_return.java" %} - */ - {%-if p.SuppressWarnings is defined%} -@SuppressWarnings("{{p.SuppressWarnings}}") - {%-endif%} - {%-if p.deprecated is defined and p.deprecated is not none%} -@Deprecated - {%-endif%} -public {{p.return_type}}get{{p.title}}(){ - {%-if p.return_type in['String','Boolean','Integer']%} + /** + * Gets the {{p.origin}}. + * + {%- include "javadoc_return.java" %} + */ + {%- if p.SuppressWarnings is defined %} + @SuppressWarnings("{{p.SuppressWarnings}}") + {%- endif %} + {%- if p.deprecated is defined and p.deprecated is not none %} + @Deprecated + {%- endif %} + public {{p.return_type}} get{{p.title}}() { + {%- if p.return_type in ['String', 'Boolean', 'Integer'] %} return get{{p.return_type}}({{p.key}}); - {%-elif p.return_type in['Float']%} - Object object=getParameters({{p.key}}); + {%- elif p.return_type in ['Float'] %} + Object object = getParameters({{p.key}}); return SdlDataTypeConverter.objectToFloat(object); - {%-elif p.return_type in['Double']%} - Object object=getParameters({{p.key}}); + {%- elif p.return_type in ['Double'] %} + Object object = getParameters({{p.key}}); return SdlDataTypeConverter.objectToDouble(object); - {%-else%} - {%-set clazz=p.return_type%} - {%-if p.return_type.startswith('List')%}{%set clazz=p.return_type[5:-1]%}{%endif%} - return({{p.return_type}})getObject({{clazz}}.class,{{p.key}}); - {%-endif%} - } + {%- else %} + {%- set clazz = p.return_type %} + {%- if p.return_type.startswith('List')%}{%set clazz = p.return_type[5:-1]%}{% endif %} + return ({{p.return_type}}) getObject({{clazz}}.class, {{p.key}}); + {%- endif %} + } - {%-endif%} - {%-endfor%} - {%-endblock%}
\ No newline at end of file + {%- endif %} + {%- endfor %} + {%- endblock %}
\ No newline at end of file diff --git a/generator/templates/javadoc_return.java b/generator/templates/javadoc_return.java index 944915f8f..debd19e0a 100644 --- a/generator/templates/javadoc_return.java +++ b/generator/templates/javadoc_return.java @@ -1,14 +1,14 @@ -{%-if p.description is defined%} - {%-for d in p.description%} - {%-if loop.index==1%} - *@return{{p.return_type}}{{d}} - {%-else%} - *{{d}} - {%-endif%}{%-endfor%} - {%-else%} - *@return{{p.return_type}} - {%-endif%} - {%-if p.values is defined and p.values%} - *{%-for k in p.values%}{{' {'if loop.first}}"{{k}}":{{p.values[k]}}{{', 'if not loop.last else'}'}}{%-endfor%} - {%-endif%}{%set see,deprecated,since,history,spacing,prefix=p.see,p.deprecated,p.since,p.history,' ',' * '%} - {%-include"javadoc_version_info.java"%}
\ No newline at end of file + {%- if p.description is defined %} + {%- for d in p.description %} + {%- if loop.index == 1 %} + * @return {{p.return_type}} {{d}} + {%- else %} + * {{d}} + {%- endif %}{%- endfor %} + {%- else %} + * @return {{p.return_type}} + {%- endif %} + {%- if p.values is defined and p.values %} + * {%- for k in p.values %}{{ ' {' if loop.first}}"{{k}}": {{p.values[k]}}{{ ', ' if not loop.last else '}'}}{%- endfor %} + {%- endif %}{% set see, deprecated, since, history, spacing, prefix = p.see, p.deprecated, p.since, p.history, ' ', ' * ' %} + {%- include "javadoc_version_info.java" %}
\ No newline at end of file diff --git a/generator/templates/javadoc_template.java b/generator/templates/javadoc_template.java index 797386533..66a902fdb 100644 --- a/generator/templates/javadoc_template.java +++ b/generator/templates/javadoc_template.java @@ -1,14 +1,14 @@ -{%-if p.description is defined%} - {%-for d in p.description%} - {%-if loop.index==1%} - *@param {{p.last}}{{d}} - {%-else%} - *{{d}} - {%-endif%}{%-endfor%} - {%-else%} - *@param {{p.last}} - {%-endif%} - {%-if p.values is defined and p.values%} - *{%-for k in p.values%}{{' {'if loop.first}}"{{k}}":{{p.values[k]}}{{', 'if not loop.last else'}'}}{%-endfor%} - {%-endif%}{%set see,deprecated,since,history,spacing,prefix=p.see,p.deprecated,p.since,p.history,' ',' * '%} - {%-include"javadoc_version_info.java"%}
\ No newline at end of file + {%- if p.description is defined %} + {%- for d in p.description %} + {%- if loop.index == 1 %} + * @param {{p.last}} {{d}} + {%- else %} + * {{d}} + {%- endif %}{%- endfor %} + {%- else %} + * @param {{p.last}} + {%- endif %} + {%- if p.values is defined and p.values %} + * {%- for k in p.values %}{{ ' {' if loop.first}}"{{k}}": {{p.values[k]}}{{ ', ' if not loop.last else '}'}}{%- endfor %} + {%- endif %}{% set see, deprecated, since, history, spacing, prefix = p.see, p.deprecated, p.since, p.history, ' ', ' * ' %} + {%- include "javadoc_version_info.java" %}
\ No newline at end of file diff --git a/generator/templates/javadoc_version_info.java b/generator/templates/javadoc_version_info.java index 69451a922..0eabb1bd2 100644 --- a/generator/templates/javadoc_version_info.java +++ b/generator/templates/javadoc_version_info.java @@ -1,23 +1,23 @@ -{%-if since is defined and since is not none%} - {%-if begin is defined%} - {{spacing}}{{begin}} - {%-endif%} - {%-if deprecated is defined and deprecated is not none%} - {{spacing}}{{prefix}}@since SmartDeviceLink{{history[0].since}} - {%-if headerParam is defined and headerParam is not none%} - {{spacing}}{{prefix}}@property-deprecated in SmartDeviceLink{{since}} - {%-else%} - {{spacing}}{{prefix}}@deprecated in SmartDeviceLink{{since}} - {%-endif%} - {%-elif history is defined and history is not none%} - {{spacing}}{{prefix}}@since SmartDeviceLink{{history[0].since}} - {%-else%} - {{spacing}}{{prefix}}@since SmartDeviceLink{{since}} - {%-endif%} - {%-if see is defined%} - {{spacing}}{{prefix}}@see {{see}} - {%-endif%} - {%-if end is defined%} - {{spacing}}{{end}} - {%-endif%} - {%-endif%}
\ No newline at end of file +{%- if since is defined and since is not none %} +{%- if begin is defined %} +{{spacing}}{{begin}} +{%- endif %} +{%- if deprecated is defined and deprecated is not none %} +{{spacing}}{{prefix}}@since SmartDeviceLink {{history[0].since}} +{%- if headerParam is defined and headerParam is not none %} +{{spacing}}{{prefix}}@property-deprecated in SmartDeviceLink {{since}} +{%- else %} +{{spacing}}{{prefix}}@deprecated in SmartDeviceLink {{since}} +{%- endif %} +{%- elif history is defined and history is not none %} +{{spacing}}{{prefix}}@since SmartDeviceLink {{history[0].since}} +{%- else %} +{{spacing}}{{prefix}}@since SmartDeviceLink {{since}} +{%- endif %} +{%- if see is defined %} +{{spacing}}{{prefix}}@see {{see}} +{%- endif %} +{%- if end is defined %} +{{spacing}}{{end}} +{%- endif %} +{%- endif %}
\ No newline at end of file diff --git a/generator/templates/struct_function_template.java b/generator/templates/struct_function_template.java index 9eea20285..a0ab096f9 100644 --- a/generator/templates/struct_function_template.java +++ b/generator/templates/struct_function_template.java @@ -1,49 +1,49 @@ -{%extends"base_template.java"%} +{% extends "base_template.java" %} - {%block body%} -public class {{class_name}}extends{{extends_class}}{ - {%-block params%} - {%-endblock%} +{% block body %} +public class {{class_name}} extends {{extends_class}} { + {%- block params %} + {%- endblock %} - /** - * Constructs a new {{class_name}} object - */ - {%-block constructor_simple%} - {%endblock%} + /** + * Constructs a new {{class_name}} object + */ + {%- block constructor_simple %} + {% endblock %} -/** - * Constructs a new {{class_name}} object indicated by the Hashtable parameter - * - * @param hash The Hashtable to use - */ -public {{class_name}}(Hashtable<String, Object> hash){ + /** + * Constructs a new {{class_name}} object indicated by the Hashtable parameter + * + * @param hash The Hashtable to use + */ + public {{class_name}}(Hashtable<String, Object> hash) { super(hash); - } - {%-if params is defined%} - {%-set constructor=[]%} - {%-for p in params|selectattr('mandatory')%}{{constructor.append('@NonNull '+p.return_type+' '+p.last)or''}} - {%-endfor%} - {%-if constructor|length>0%} + } + {%- if params is defined %} + {%- set constructor = [] %} + {%- for p in params|selectattr('mandatory') %}{{ constructor.append('@NonNull ' + p.return_type + ' ' + p.last) or '' }} + {%- endfor %} + {%- if constructor|length > 0 %} -/** - * Constructs a new {{class_name}} object - * - {%- for p in params|selectattr('mandatory') %} - {%- include "javadoc_template.java" %} - {%- endfor %} - */ -public {{class_name}}({{constructor|join(', ')}}){ + /** + * Constructs a new {{class_name}} object + * + {%- for p in params|selectattr('mandatory') %} + {%- include "javadoc_template.java" %} + {%- endfor %} + */ + public {{class_name}}({{ constructor|join(', ') }}) { this(); - {%-for p in params|selectattr('mandatory')%} + {%- for p in params|selectattr('mandatory') %} set{{p.title}}({{p.last}}); - {%-endfor%} - } - {%-endif%} - {%-endif%} + {%- endfor %} + } + {%- endif %} + {%- endif %} - {%-if params is defined%} - {%-block setter%} - {%-endblock%} - {%-endif%} - } - {%endblock-%} + {%- if params is defined %} + {%- block setter %} + {%- endblock%} + {%- endif %} +} +{% endblock -%} diff --git a/generator/templates/struct_template.java b/generator/templates/struct_template.java index 4e5a2b4f4..5fcca3ba9 100644 --- a/generator/templates/struct_template.java +++ b/generator/templates/struct_template.java @@ -1,61 +1,61 @@ -{%extends"struct_function_template.java"%} +{% extends "struct_function_template.java" %} - {%-block params%} - {%-if params is defined%} - {%-for p in params%}{%set see,deprecated,since,history,spacing,begin,end,prefix=p.see,p.deprecated,p.since,p.history,' ','/**',' */',' * '%} - {%-include"javadoc_version_info.java"%} - {%-if p.deprecated is not none%} -@Deprecated - {%-endif%} -public static final String{{p.key}}="{{p.origin}}"; - {%-endfor%} - {%-endif%} - {%-endblock%} + {%- block params %} + {%- if params is defined %} + {%- for p in params %}{% set see, deprecated, since, history, spacing, begin, end, prefix = p.see, p.deprecated, p.since, p.history, ' ', '/**', ' */', ' * ' %} + {%- include "javadoc_version_info.java" %} + {%- if p.deprecated is not none %} + @Deprecated + {%- endif %} + public static final String {{p.key}} = "{{p.origin}}"; + {%- endfor %} + {%- endif %} + {%- endblock %} - {%-block constructor_simple%} -public {{class_name}}(){} - {%-endblock-%} + {%- block constructor_simple %} + public {{class_name}}() { } + {%- endblock -%} - {%-block setter%} - {%-for p in params|rejectattr('name')%} + {%- block setter %} + {%- for p in params|rejectattr('name') %} - /** - * Sets the {{p.origin}}. - * - {%- include "javadoc_template.java" %} - */ - {%-if p.deprecated is defined and p.deprecated is not none%} -@Deprecated - {%-endif%} -public {{class_name}}set{{p.title}}({%if p.mandatory%}@NonNull {%endif%}{{p.return_type}}{{p.last}}){ - setValue({{p.key}},{{p.last}}); + /** + * Sets the {{p.origin}}. + * + {%- include "javadoc_template.java" %} + */ + {%- if p.deprecated is defined and p.deprecated is not none %} + @Deprecated + {%- endif %} + public {{class_name}} set{{p.title}}({% if p.mandatory %}@NonNull {% endif %}{{p.return_type}} {{p.last}}) { + setValue({{p.key}}, {{p.last}}); return this; - } + } - /** - * Gets the {{p.origin}}. - * - {%- include "javadoc_return.java" %} - */ - {%-if p.SuppressWarnings is defined%} -@SuppressWarnings("{{p.SuppressWarnings}}") - {%-endif%} - {%-if p.deprecated is defined and p.deprecated is not none%} -@Deprecated - {%-endif%} -public {{p.return_type}}get{{p.title}}(){ - {%-if p.return_type in['String','Boolean','Integer']%} + /** + * Gets the {{p.origin}}. + * + {%- include "javadoc_return.java" %} + */ + {%- if p.SuppressWarnings is defined %} + @SuppressWarnings("{{p.SuppressWarnings}}") + {%- endif %} + {%- if p.deprecated is defined and p.deprecated is not none %} + @Deprecated + {%- endif %} + public {{p.return_type}} get{{p.title}}() { + {%- if p.return_type in ['String', 'Boolean', 'Integer'] %} return get{{p.return_type}}({{p.key}}); - {%-elif p.return_type in['Float']%} - Object object=getValue({{p.key}}); + {%- elif p.return_type in ['Float'] %} + Object object = getValue({{p.key}}); return SdlDataTypeConverter.objectToFloat(object); - {%-else%} - {%-set clazz=p.return_type%} - {%-if p.return_type.startswith('List')%}{%set clazz=p.return_type[5:-1]%}{%endif%} - return({{p.return_type}})getObject({{clazz}}.class,{{p.key}}); - {%-endif%} - } + {%- else %} + {%- set clazz = p.return_type %} + {%- if p.return_type.startswith('List')%}{%set clazz = p.return_type[5:-1]%}{% endif %} + return ({{p.return_type}}) getObject({{clazz}}.class, {{p.key}}); + {%- endif %} + } - {%-endfor%} - {%-endblock%} + {%- endfor %} + {%- endblock %} diff --git a/javaSE/javaSE/src/main/java/com/smartdevicelink/BuildConfig.java b/javaSE/javaSE/src/main/java/com/smartdevicelink/BuildConfig.java index 3cd816118..9b4ce8fca 100644 --- a/javaSE/javaSE/src/main/java/com/smartdevicelink/BuildConfig.java +++ b/javaSE/javaSE/src/main/java/com/smartdevicelink/BuildConfig.java @@ -1,33 +1,33 @@ /* - * Copyright (c) 2017 - 2020, SmartDeviceLink Consortium, Inc. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * - * * Redistributions of source code must retain the above copyright notice, this - * list of conditions and the following disclaimer. - * - * * Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following disclaimer in the documentation - * and/or other materials provided with the distribution. - * - * * Neither the name of SmartDeviceLink Consortium, Inc. nor the names of its - * contributors may be used to endorse or promote products derived from - * this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE - * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR - * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - */ +* Copyright (c) 2017 - 2020, SmartDeviceLink Consortium, Inc. +* All rights reserved. +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions are met: +* +* * Redistributions of source code must retain the above copyright notice, this +* list of conditions and the following disclaimer. +* +* * Redistributions in binary form must reproduce the above copyright notice, +* this list of conditions and the following disclaimer in the documentation +* and/or other materials provided with the distribution. +* +* * Neither the name of SmartDeviceLink Consortium, Inc. nor the names of its +* contributors may be used to endorse or promote products derived from +* this software without specific prior written permission. +* +* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +* +*/ package com.smartdevicelink; // THIS FILE IS AUTO GENERATED, DO NOT MODIFY!! diff --git a/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/SdlManagerListener.java b/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/SdlManagerListener.java index aedac486f..fbe236f08 100644 --- a/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/SdlManagerListener.java +++ b/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/SdlManagerListener.java @@ -72,7 +72,6 @@ public interface SdlManagerListener extends BaseSdlManagerListener { /** * A way to determine if this SDL session should continue to be active while * connected to the determined system information of the vehicle. - * * @param systemInfo systemInfo - the system information of the vehicle that this session is currently active on. * @return Return true if this session should continue, false if the session should end */ diff --git a/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/file/FileManager.java b/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/file/FileManager.java index ddbd52b80..b53a734d5 100644 --- a/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/file/FileManager.java +++ b/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/file/FileManager.java @@ -34,7 +34,6 @@ package com.smartdevicelink.managers.file; import androidx.annotation.NonNull; import androidx.annotation.RestrictTo; - import com.smartdevicelink.managers.ISdl; import com.smartdevicelink.managers.file.filetypes.SdlFile; import com.smartdevicelink.util.DebugTool; diff --git a/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/screen/AlertManager.java b/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/screen/AlertManager.java index 730f547b4..15e92eb1a 100644 --- a/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/screen/AlertManager.java +++ b/javaSE/javaSE/src/main/java/com/smartdevicelink/managers/screen/AlertManager.java @@ -1,5 +1,4 @@ package com.smartdevicelink.managers.screen; - import androidx.annotation.NonNull; import androidx.annotation.RestrictTo; |