com.smartdevicelink.proxy.rpc

Class Turn

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.Turn

All Implemented Interfaces:

Cloneable

public class Turn
extends RPCStruct

Describes a navigation turn including an optional icon

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
navigationText	String	Text to describe the turn (e.g. street name) Maxlength = 500	SmartDeviceLink 2.0
turnIcon	Image	Image to be shown for a turn	SmartDeviceLink 2.0

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_NAVIGATION_TEXT
static String	KEY_TURN_IMAGE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
Turn()
Turn(Hashtable<String,Object> hash)

Method Summary

Modifier and Type	Method and Description
String	getNavigationText() get the text to describe the turn (e.g.
Image	getTurnIcon() get the image to be shown for a turn
Turn	setNavigationText(String navigationText) set the text to describe the turn (e.g.
Turn	setTurnIcon(Image turnIcon) set Image to be shown for a turn

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, 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_NAVIGATION_TEXT

public static final String KEY_NAVIGATION_TEXT

See Also:

Constant Field Values

KEY_TURN_IMAGE

public static final String KEY_TURN_IMAGE

See Also:

Constant Field Values

Constructor Detail

Turn

public Turn()

Turn

public Turn(Hashtable<String,Object> hash)

Method Detail

setNavigationText

public Turn setNavigationText(String navigationText)

set the text to describe the turn (e.g. street name)

Parameters:

navigationText - the text to describe the turn (e.g. street name)

getNavigationText

public String getNavigationText()

get the text to describe the turn (e.g. street name)

Returns:

the text to describe the turn (e.g. street name)

setTurnIcon

public Turn setTurnIcon(Image turnIcon)

set Image to be shown for a turn

Parameters:

turnIcon - the image to be shown for a turn

getTurnIcon

public Image getTurnIcon()

get the image to be shown for a turn

Returns:

the image to be shown for a turn