com.smartdevicelink.proxy.rpc

Class SdlMsgVersion

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.SdlMsgVersion

All Implemented Interfaces:

Cloneable

public class SdlMsgVersion
extends RPCStruct

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.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
majorVersion	Integer	minvalue="1" maxvalue="10"	SmartDeviceLink 1.0
minorVersion	Integer	minvalue="0" maxvalue="1000"	SmartDeviceLink 1.0

Since:

SmartDeviceLink 1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_MAJOR_VERSION
static String	KEY_MINOR_VERSION
static String	KEY_PATCH_VERSION

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
SdlMsgVersion() Constructs a newly allocated SdlMsgVersion object
SdlMsgVersion(Hashtable<String,Object> hash) Constructs a newly allocated SdlMsgVersion object indicated by the Hashtable parameter
SdlMsgVersion(Integer majorVersion, Integer minorVersion) Constructs a newly allocated SdlMsgVersion object
SdlMsgVersion(Version version) Constructs a newly allocated SdlMsgVersion object

Method Summary

Modifier and Type	Method and Description
void	format(Version rpcVersion, boolean formatParams) This method should clean the the RPC to make sure it is compliant with the spec.
Integer	getMajorVersion() Get major version minvalue="1" maxvalue="10"
Integer	getMinorVersion() Get minor version minvalue="0" maxvalue="1000"
Integer	getPatchVersion() Get patch version minvalue="0" maxvalue="1000"
SdlMsgVersion	setMajorVersion(Integer majorVersion) Set major version minvalue="1" maxvalue="10"
SdlMsgVersion	setMinorVersion(Integer minorVersion) Set minor version minvalue="0" maxvalue="1000"
SdlMsgVersion	setPatchVersion(Integer patchVersion) Set patch version minvalue="0" maxvalue="1000"

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_MAJOR_VERSION

public static final String KEY_MAJOR_VERSION

See Also:

Constant Field Values

KEY_MINOR_VERSION

public static final String KEY_MINOR_VERSION

See Also:

Constant Field Values

KEY_PATCH_VERSION

public static final String KEY_PATCH_VERSION

See Also:

Constant Field Values

Constructor Detail

SdlMsgVersion

public SdlMsgVersion()

Constructs a newly allocated SdlMsgVersion object

SdlMsgVersion

public SdlMsgVersion(Hashtable<String,Object> hash)

Constructs a newly allocated SdlMsgVersion object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

SdlMsgVersion

public SdlMsgVersion(@NonNull
                     Integer majorVersion,
                     @NonNull
                     Integer minorVersion)

Constructs a newly allocated SdlMsgVersion object

Parameters:

majorVersion - minvalue="1" and maxvalue="10"

minorVersion - min: 0; max: 1000

SdlMsgVersion

public SdlMsgVersion(@NonNull
                     Version version)

Constructs a newly allocated SdlMsgVersion object

Parameters:

version - Creates a new RPC struct SdlMsgVersion based on the utility class

Method Detail

format

public void format(Version rpcVersion,
                   boolean formatParams)

Description copied from class: RPCStruct

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

Overrides:

format in class RPCStruct

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

getMajorVersion

public Integer getMajorVersion()

Get major version

• minvalue="1"
• maxvalue="10"

Returns:

the major version

setMajorVersion

public SdlMsgVersion setMajorVersion(@NonNull
                                     Integer majorVersion)

Set major version

• minvalue="1"
• maxvalue="10"

Parameters:

majorVersion - minvalue="1" and maxvalue="10"

getMinorVersion

public Integer getMinorVersion()

Get minor version

• minvalue="0"
• maxvalue="1000"

Returns:

the minor version

setMinorVersion

public SdlMsgVersion setMinorVersion(@NonNull
                                     Integer minorVersion)

Set minor version

• minvalue="0"
• maxvalue="1000"

Parameters:

minorVersion - min: 0; max: 1000

getPatchVersion

public Integer getPatchVersion()

Get patch version

• minvalue="0"
• maxvalue="1000"

Returns:

the patch version

setPatchVersion

public SdlMsgVersion setPatchVersion(Integer patchVersion)

Set patch version

• minvalue="0"
• maxvalue="1000"

Parameters:

patchVersion - min: 0; max: 1000