RPCStruct (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AirbagStatus, AppCapability, AppInfo, AppServiceCapability, AppServiceData, AppServiceManifest, AppServiceRecord, AppServicesCapabilities, AudioControlCapabilities, AudioControlData, AudioPassThruCapabilities, BeltStatus, BodyInformation, ButtonCapabilities, Choice, ClimateControlCapabilities, ClimateControlData, ClimateData, CloudAppProperties, ClusterModeStatus, Coordinate, DateTime, DeviceInfo, DeviceStatus, DIDResult, DisplayCapabilities, DisplayCapability, DoorStatus, DriverDistractionCapability, DTC, DynamicUpdateCapabilities, ECallInfo, EmergencyEvent, EqualizerSettings, FuelRange, GateStatus, GearStatus, GPSData, Grid, HapticRect, Headers, HeadLampStatus, HMICapabilities, HMIPermissions, HMISettingsControlCapabilities, HMISettingsControlData, Image, ImageField, ImageResolution, KeyboardCapabilities, KeyboardLayoutCapability, KeyboardProperties, LightCapabilities, LightControlCapabilities, LightControlData, LightState, LocationDetails, MassageCushionFirmness, MassageModeData, MediaServiceData, MediaServiceManifest, MenuParams, MetadataTags, ModuleData, ModuleInfo, MyKey, NavigationCapability, NavigationInstruction, NavigationServiceData, NavigationServiceManifest, OasisAddress, ParameterPermissions, PermissionItem, PhoneCapability, PresetBankCapabilities, RadioControlCapabilities, RadioControlData, RdsData, Rectangle, RemoteControlCapabilities, RGBColor, RoofStatus, RPCMessage, ScreenParams, SdlMsgVersion, SeatControlCapabilities, SeatControlData, SeatLocation, SeatLocationCapability, SeatMemoryAction, SeatOccupancy, SeatStatus, SeekStreamingIndicator, SingleTireStatus, SisData, SoftButton, SoftButtonCapabilities, StabilityControlsStatus, StartTime, StationIDNumber, SystemCapability, Temperature, TemplateColorScheme, TemplateConfiguration, TextField, TireStatus, TouchCoord, TouchEvent, TouchEventCapabilities, TTSChunk, Turn, VehicleDataResult, VehicleType, VideoStreamingCapability, VideoStreamingFormat, VrHelpItem, WeatherAlert, WeatherData, WeatherServiceData, WeatherServiceManifest, WindowCapability, WindowState, WindowStatus, WindowTypeCapabilities
```
public class RPCStruct
extends Object
implements Cloneable
```

Field Summary

Fields
Modifier and Type Field and Description

static String KEY_BULK_DATA

static String KEY_PROTECTED

protected Hashtable<String,Object> store

Fields
Modifier and Type	Field and Description
`static String`	`KEY_BULK_DATA`
`static String`	`KEY_PROTECTED`
`protected Hashtable<String,Object>`	`store`

Constructor Summary

Constructors
Modifier Constructor and Description

RPCStruct()

RPCStruct(Hashtable<String,Object> hashtable)

protected RPCStruct(RPCStruct rpcs)

Constructors
Modifier	Constructor and Description
	`RPCStruct()`
	`RPCStruct(Hashtable<String,Object> hashtable)`
`protected`	`RPCStruct(RPCStruct rpcs)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RPCStruct`	`clone()` Creates a deep copy of the object
`void`	`deserializeJSON(JSONObject jsonObject)`
`boolean`	`equals(Object obj)` Uses the RPCStruct store for RPCStruct objects
`void`	`format(Version rpcVersion, boolean formatParams)` This method should clean the the RPC to make sure it is compliant with the spec.
`protected Object`	`formatObject(Class tClass, Object obj)`
`Boolean`	`getBoolean(String key)`
`byte[]`	`getBulkData()`
`Double`	`getDouble(String key)`
`Float`	`getFloat(String key)`
`Integer`	`getInteger(String key)`
`Long`	`getLong(String key)`
`protected String`	`getMessageTypeName(Set<String> keys)`
`Object`	`getObject(Class tClass, String key)`
`Hashtable<String,Object>`	`getStore()`
`boolean`	`getStoreValue(String key)`
`String`	`getString(String key)`
`Object`	`getValue(String key)`
`protected Object`	`getValueForString(Class tClass, String s)`
`int`	`hashCode()` Used to compile hashcode for RPCStruct
`protected boolean`	`hasKey(Set<String> keys, String keyName)`
`Boolean`	`isPayloadProtected()`
`JSONObject`	`serializeJSON()`
`JSONObject`	`serializeJSON(byte protocolVersion)`
`RPCStruct`	`setBulkData(byte[] bulkData)`
`RPCStruct`	`setPayloadProtected(Boolean bVal)`
`RPCStruct`	`setValue(String key, Object value)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_BULK_DATA

public static final String KEY_BULK_DATA

See Also:: Constant Field Values

KEY_PROTECTED

public static final String KEY_PROTECTED

See Also:: Constant Field Values

store

protected Hashtable<String,Object> store

Constructor Detail

RPCStruct
```
public RPCStruct()
```

RPCStruct
```
protected RPCStruct(RPCStruct rpcs)
```

RPCStruct

public RPCStruct(Hashtable<String,Object> hashtable)

Method Detail
- getStoreValue
```
public boolean getStoreValue(String key)
```
- getStore
```
public Hashtable<String,Object> getStore()
```
- deserializeJSON
```
public void deserializeJSON(JSONObject jsonObject)
                     throws JSONException
```
  Throws:
  
  JSONException
- serializeJSON
```
public JSONObject serializeJSON()
                         throws JSONException
```
  Throws:
  
  JSONException
- serializeJSON
```
public JSONObject serializeJSON(byte protocolVersion)
                         throws JSONException
```
  Throws:
  
  JSONException
- format
```
public void format(Version rpcVersion,
                   boolean formatParams)
```
  This method should clean the the RPC to make sure it is compliant with the spec.
  
  NOTE: Super needs to be called at the END of the method
  
  Parameters:
  
  rpcVersion - the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.
  
  formatParams - if true, the format method will be called on subsequent params
- getBulkData
```
public byte[] getBulkData()
```
- setBulkData
```
public RPCStruct setBulkData(byte[] bulkData)
```
- setPayloadProtected
```
public RPCStruct setPayloadProtected(Boolean bVal)
```
- isPayloadProtected
```
public Boolean isPayloadProtected()
```
- getMessageTypeName
```
protected String getMessageTypeName(Set<String> keys)
```
- hasKey
```
protected boolean hasKey(Set<String> keys,
                         String keyName)
```
- setValue
```
public RPCStruct setValue(String key,
                          Object value)
```
- getValue
```
public Object getValue(String key)
```
- getObject
```
public Object getObject(Class tClass,
                        String key)
```
- formatObject
```
protected Object formatObject(Class tClass,
                              Object obj)
```
  Parameters:
  
  tClass - a Class to cast Objects to
  
  obj - Object returned from a stored hashtable
  
  Returns:
  
  A null object if obj is null or if none of the following is true: a) obj is an instance of tClass b) obj is an instance of String and it tClass has a valid `valueForString` method c) obj is an instance of a Hashtable d) obj is an instance of a List
- getValueForString
```
protected Object getValueForString(Class tClass,
                                   String s)
```
  Parameters:
  
  tClass - - a Class with a `valueForString(String s)` method that returns an Object for a given String
  
  s - - a String to be converted to an Object using a `valueForString(String s)` method
  
  Returns:
  
  An Object converted using a `valueForString(String s)` method in the Class passed in, or a null object if such method does not exist
- getString
```
public String getString(String key)
```
- getInteger
```
public Integer getInteger(String key)
```
- getDouble
```
public Double getDouble(String key)
```
- getFloat
```
public Float getFloat(String key)
```
- getBoolean
```
public Boolean getBoolean(String key)
```
- getLong
```
public Long getLong(String key)
```
- clone
```
public RPCStruct clone()
```
  Creates a deep copy of the object
  
  Overrides:
  
  clone in class Object
  
  Returns:
  
  deep copy of the object, null if an exception occurred
- equals
```
public boolean equals(@Nullable
                      Object obj)
```
  Uses the RPCStruct store for RPCStruct objects
  
  Overrides:
  
  equals in class Object
  
  Parameters:
  
  obj - - The object to compare
  
  Returns:
  
  boolean of whether the objects are the same or not
- hashCode
```
public int hashCode()
```
  Used to compile hashcode for RPCStruct
  
  Overrides:
  
  hashCode in class Object
  
  Returns:
  
  Custom hashcode of RPCStruct

Class RPCStruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_BULK_DATA

KEY_PROTECTED

store

Constructor Detail

RPCStruct

RPCStruct

RPCStruct

Method Detail

getStoreValue

getStore

deserializeJSON

serializeJSON

serializeJSON

format

getBulkData

setBulkData

setPayloadProtected

isPayloadProtected

getMessageTypeName

hasKey

setValue

getValue

getObject

formatObject

getValueForString

getString

getInteger

getDouble

getFloat

getBoolean

getLong

clone

equals

hashCode