Merge branch 'release/RC_5.0.0' into feature/annotations_spec_match_test

Author: bilal-alsharifi

JavaSuiteFolderStructure.png

@@ -8,27 +8,28 @@ SmartDeviceLink (SDL) is a standard set of protocols and messages that connect a
 
   * The [Core](https://github.com/smartdevicelink/sdl_core) component is the software which Vehicle Manufacturers (OEMs)  implement in their vehicle head units. Integrating this component into their head unit and HMI based on a set of guidelines and templates enables access to various smartphone applications.
   * The optional [SDL Server](https://github.com/smartdevicelink/sdl_server) can be used by Vehicle OEMs to update application policies and gather usage information for connected applications.
-  * The [iOS](https://github.com/smartdevicelink/sdl_ios) and [Android](https://github.com/smartdevicelink/sdl_java_suite) libraries are implemented by app developers into their applications to enable command and control via the connected head unit.
-  * The [JavaSE](https://github.com/smartdevicelink/sdl_java_suite) (Embedded) and [JavaEE](https://github.com/smartdevicelink/sdl_java_suite) (Cloud) libraries, written in Java, are implemented by app developers into their applications to enable command and control of a connected head unit.
-  
+  * The App Libraries - [Android](https://github.com/smartdevicelink/sdl_java_suite), [iOS](https://github.com/smartdevicelink/sdl_ios), [JavaScript](https://github.com/smartdevicelink/sdl_javascript_suite), [JavaSE](https://github.com/smartdevicelink/sdl_java_suite) (Embedded), and [JavaEE](https://github.com/smartdevicelink/sdl_java_suite) (Cloud) - are implemented by app developers into their applications to enable command and control of a connected head unit.
+
 Pull Requests Welcome!
 
-To understand if a contribution should be entered as an Android Pull Request (or issue), or an SDL Evolution Proposal, please reference [this document](https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals_versus_issues.md).
+To understand if a contribution should be entered as a Java Suite Pull Request (or issue), or an SDL Evolution Proposal, please reference [this document](https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals_versus_issues.md).
 
 <a href="http://www.youtube.com/watch?feature=player_embedded&v=AzdQdSCS24M" target="_blank"><img src="http://i.imgur.com/nm8UujD.png?1" alt="SmartDeviceLink" border="10" /></a>
 
-## Client Proxy
+## App Library
 
-The client libraries component of SDL is meant to run on the end user’s smart-device from within SDL enabled apps, as an embedded app, or connected to from the cloud. The libraries allows the apps to connect to SDL enabled head-units and hardware through bluetooth, USB, TCP for Android and cloud and embedded apps can connect through web sockets, Java Beans, and other custom transports. Once the library establishes a connection between the smart device and head-unit through the preferred method of transport, the two components are able to communicate using the SDL defined protocol. The app integrating this library project is then able to expose its functionality to the head-unit through text, media, and other interactive elements.
+The app library component of SDL is meant to run on the end user’s smart-device from within SDL enabled apps, as an embedded app, or connected to the cloud. App libraries allow the apps to connect to SDL enabled head-units and hardware through bluetooth, USB, and TCP for Android, and cloud and embedded apps can connect through web sockets, Java Beans, and other custom transports. Once the library establishes a connection between the smart device and head-unit through the preferred method of transport, the two components are able to communicate using the SDL defined protocol. The app integrating this library project is then able to expose its functionality to the head-unit through text, media, and other interactive elements.
 
 # SmartDeviceLink Java Suite
 
-## SmartDeviceLink Android
-[ ![Download Android](https://api.bintray.com/packages/smartdevicelink/sdl_android/sdl_android/images/download.svg) ](https://bintray.com/smartdevicelink/sdl_android/sdl_android/_latestVersion)
+You can find guides and API Reference Documentation specific to SDL Android, JavaSE, and JavaEE libraries on [smartdevicelink.com](https://smartdevicelink.com/docs/).
 
-We're still working on creating documentation for each of these individual repositories, but in the meantime, you can find more information about SmartDeviceLink [here](https://smartdevicelink.com)
+Contents and timing for SDL Java Suite releases can be tracked on the [GitHub Projects](https://github.com/smartdevicelink/sdl_java_suite/projects) page.
 
-You can also find some branches that have yet to be merged into this GitHub project on the GENIVI page [here](http://git.projects.genivi.org/?p=smartdevicelink_android.git;a=summary).
+Additional information about recent and upcoming SDL Releases can be found in the [SDL Evolution README](https://github.com/smartdevicelink/sdl_evolution#recent-and-upcoming-releases).
+
+## SmartDeviceLink Android
+[ ![Download Android](https://api.bintray.com/packages/smartdevicelink/sdl_android/sdl_android/images/download.svg) ](https://bintray.com/smartdevicelink/sdl_android/sdl_android/_latestVersion)
 
 ### Installation
 
@@ -118,9 +119,6 @@ from within the project (JavaSE or JavaEE) and a JAR should be generated in the
 #### base Folder
 The base folder contains the source set that is shared between all of the compilable projects. This folder does not contain a compilable project. 
 
-#### baseAndroid Folder
-The baseAndroid folder contains symbolic links to files and folders from the base folder. This has been included since the Java Suite refactor is a minor version release and the base folder contains breaking changes for the Android project. This folder does not contain a compilable project. 
-
 #### android Folder 
 The android folder contains the SDL Android library as well as the sample project for Android. Both of those are compilable projects. 
 
@@ -134,4 +132,4 @@ The JavaSE sample app is in the hello_sdl_java folder. It demonstrates an effici
 The javaEE folder contains the SDL JavaEE library. The JavaSE folder is used as a source set and added as a dependency. This library is based off the JavaSE library and will contain specifics for the JavaEe platform.
 
 ###### JavaEE Sample App
-The JavaEE sample app is in the hello_sdl_java_ee folder. Most of the code is commented out since the library and sample app do not include the dependencies of JavaEE due to licensing issues. However, the commented out code demonstrates how to build a Java based app into the JavaEE bean architecture.  
+The JavaEE sample app is in the hello_sdl_java_ee folder. Most of the code is commented out since the library and sample app do not include the dependencies of JavaEE due to licensing issues. However, the commented out code demonstrates how to build a Java based app into the JavaEE bean architecture.  

README.md

@@ -41,7 +41,7 @@ android {
 
 dependencies {
     api fileTree(dir: 'libs', include: ['*.jar'])
-    api 'com.smartdevicelink:bson_java_port:RC1_1.2.2'
+    api 'com.smartdevicelink:bson_java_port:1.2.2'
     api 'com.livio.taskmaster:taskmaster:0.3.0'
     api 'androidx.lifecycle:lifecycle-extensions:2.2.0'
     api 'androidx.annotation:annotation:1.1.0'

android/sdl_android/build.gradle

@@ -32,7 +32,7 @@ public void testValidEnums() {
         GlobalProperty enumMenuIcon = GlobalProperty.valueForString(example);
         example = "KEYBOARDPROPERTIES";
         GlobalProperty enumKeyboardProperties = GlobalProperty.valueForString(example);
-        example = "USERLOCATION";
+        example = "USER_LOCATION";
         GlobalProperty enumUserLocation = GlobalProperty.valueForString(example);
 
         assertNotNull("HELPPROMPT returned null", enumHelpPrompt);
@@ -42,7 +42,7 @@ public void testValidEnums() {
         assertNotNull("MENUNAME returned null", enumMenuName);
         assertNotNull("MENUICON returned null", enumMenuIcon);
         assertNotNull("KEYBOARDPROPERTIES returned null", enumKeyboardProperties);
-        assertNotNull("USERLOCATION returned null", enumUserLocation);
+        assertNotNull("USER_LOCATION returned null", enumUserLocation);
     }
 
     /**
@@ -86,6 +86,7 @@ public void testListEnum() {
         enumTestList.add(GlobalProperty.MENUICON);
         enumTestList.add(GlobalProperty.KEYBOARDPROPERTIES);
         enumTestList.add(GlobalProperty.USERLOCATION);
+        enumTestList.add(GlobalProperty.USER_LOCATION);
 
         assertTrue("Enum value list does not match enum class list",
                 enumValueList.containsAll(enumTestList) && enumTestList.containsAll(enumValueList));

android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/enums/GlobalPropertyTests.java

@@ -161,6 +161,7 @@ public void onResponse(int correlationId, RPCResponse response) {
 
     }
 
+    @SuppressWarnings("deprecation")
     private void sendSetDisplayLayoutWithTemplateConfiguration(TemplateConfiguration configuration, final CompletionListener listener) {
         final SetDisplayLayout setLayout = new SetDisplayLayout().setDisplayLayout(configuration.getTemplate()).setDayColorScheme(configuration.getDayColorScheme()).setNightColorScheme(configuration.getNightColorScheme());
         setLayout.setOnRPCResponseListener(new OnRPCResponseListener() {
@@ -497,6 +498,7 @@ Show extractTextAndLayoutFromShow(Show show) {
         newShow.setMainField2(show.getMainField2());
         newShow.setMainField3(show.getMainField3());
         newShow.setMainField4(show.getMainField4());
+        newShow.setMediaTrack(show.getMediaTrack());
         newShow.setTemplateTitle(show.getTemplateTitle());
         newShow.setMetadataTags(show.getMetadataTags());
         newShow.setAlignment(show.getAlignment());
@@ -526,6 +528,7 @@ Show assembleLayout(Show show) {
         return show;
     }
 
+    @SuppressWarnings("deprecation")
     private void updateCurrentScreenDataFromSetDisplayLayout(SetDisplayLayout setDisplayLayout) {
         currentScreenData.setTemplateConfiguration(new TemplateConfiguration().setTemplate(setDisplayLayout.getDisplayLayout()).setDayColorScheme(setDisplayLayout.getDayColorScheme()).setNightColorScheme(setDisplayLayout.getNightColorScheme()));
         if (currentScreenDataUpdateListener != null) {

base/src/main/java/com/smartdevicelink/managers/screen/TextAndGraphicUpdateOperation.java

@@ -311,7 +311,7 @@ public OnSystemRequest setFileType(FileType fileType) {
 
     /**
      * @param offset of the data attached
-     * @deprecated as of SmartDeviceLink 4.0
+     * @deprecated as of SmartDeviceLink 4.0. Use {@link #setOffset(Long)} instead.
      */
     public OnSystemRequest setOffset(Integer offset) {
         if (offset == null) {
@@ -377,7 +377,7 @@ public Long getLength() {
 
     /**
      * @param length of the data attached
-     * @deprecated as of SmartDeviceLink 4.0
+     * @deprecated as of SmartDeviceLink 4.0. Use {@link #setLength(Long)} instead.
      */
     public OnSystemRequest setLength(Integer length) {
         if (length == null) {

base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java

@@ -268,7 +268,7 @@ public byte[] getFileData() {
 
     /**
      * @param offset Optional offset in bytes for resuming partial data chunks
-     * @deprecated as of SmartDeviceLink 4.0
+     * @deprecated as of SmartDeviceLink 4.0. Use {@link #setOffset(Long)} instead.
      */
     public PutFile setOffset(Integer offset) {
         if (offset == null) {
@@ -305,7 +305,7 @@ public Long getOffset() {
     /**
      * @param length 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
-     * @deprecated as of SmartDeviceLink 4.0
+     * @deprecated as of SmartDeviceLink 4.0. Use {@link #setLength(Long)} instead.
      */
     public PutFile setLength(Integer length) {
         if (length == null) {

base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java

@@ -43,6 +43,7 @@
  * Seat control data corresponds to "SEAT" ModuleType.
  */
 public class SeatControlData extends RPCStruct {
+    @Deprecated
     public static final String KEY_ID = "id";
     public static final String KEY_HEATING_ENABLED = "heatingEnabled";
     public static final String KEY_COOLING_ENABLED = "coolingEnabled";
@@ -81,6 +82,7 @@ public SeatControlData(Hashtable<String, Object> hash) {
      *
      * @param id type of SupportedSeat.
      */
+    @Deprecated
     public SeatControlData(@NonNull SupportedSeat id) {
         this();
         setId(id);
@@ -91,6 +93,7 @@ public SeatControlData(@NonNull SupportedSeat id) {
      *
      * @param id
      */
+    @Deprecated
     public SeatControlData setId(@NonNull SupportedSeat id) {
         setValue(KEY_ID, id);
         return this;
@@ -101,6 +104,7 @@ public SeatControlData setId(@NonNull SupportedSeat id) {
      *
      * @return SupportedSeat.
      */
+    @Deprecated
     public SupportedSeat getId() {
         return (SupportedSeat) getObject(SupportedSeat.class, KEY_ID);
     }

base/src/main/java/com/smartdevicelink/proxy/rpc/SeatControlData.java

@@ -93,7 +93,9 @@
  * <p>   REJECTED</p>
  *
  * @since SmartDeviceLink 2.0
+ * @deprecated in SmartDeviceLink 6.0
  */
+@Deprecated
 public class SetDisplayLayout extends RPCRequest {
     public static final String KEY_DISPLAY_LAYOUT = "displayLayout";
     public static final String KEY_DAY_COLOR_SCHEME = "dayColorScheme";

base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java

@@ -45,7 +45,9 @@
  * Set Display Layout Response is sent, when SetDisplayLayout has been called
  *
  * @since SmartDeviceLink 2.0
+ * @deprecated in SmartDeviceLink 6.0
  */
+@Deprecated
 public class SetDisplayLayoutResponse extends RPCResponse {
     public static final String KEY_BUTTON_CAPABILITIES = "buttonCapabilities";
     public static final String KEY_DISPLAY_CAPABILITIES = "displayCapabilities";