blob: a48610a7c2fea7d00b80946dec5ce6baef5371ea (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
package com.smartdevicelink.proxy.rpc;
import java.util.Hashtable;
import java.util.Vector;
import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.constants.Names;
import com.smartdevicelink.util.DebugTool;
/**
* A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.
* <p><b> Parameter List
* <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>Int16</td>
* <td>Application-scoped identifier that uniquely identifies this choice.
* <br/>Min: 0
* <br/>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.
* <br/>Min: 1
* <br/>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>
* <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>
*
* @since SmartDeviceLink 1.0
*/
public class Choice extends RPCStruct {
/**
* Constructs a newly allocated Choice object
*/
public Choice() { }
/**
* Constructs a newly allocated Choice object indicated by the Hashtable parameter
* @param hash The Hashtable to use
*/
public Choice(Hashtable hash) {
super(hash);
}
/**
* Get the application-scoped identifier that uniquely identifies this choice.
* @return choiceID Min: 0 Max: 65535
*/
public Integer getChoiceID() {
return (Integer) store.get(Names.choiceID);
}
/**
* Set the application-scoped identifier that uniquely identifies this choice.
* @param choiceID Min: 0 Max: 65535
*/
public void setChoiceID(Integer choiceID) {
if (choiceID != null) {
store.put(Names.choiceID, choiceID);
}
}
/**
* Text which appears in menu, representing this choice.
* <br/>Min: 1
* <br/>Max: 100
* @return menuName the menu name
*/
public String getMenuName() {
return (String) store.get(Names.menuName);
}
/**
* Text which appears in menu, representing this choice.
* <br/>Min: 1
* <br/>Max: 100
* @param menuName the menu name
*/
public void setMenuName(String menuName) {
if (menuName != null) {
store.put(Names.menuName, menuName);
}
}
/**
* Get 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
* @return vrCommands Vector
* @since SmartDeviceLink 2.0
*/
public Vector<String> getVrCommands() {
if (store.get(Names.vrCommands) instanceof Vector<?>) {
Vector<?> list = (Vector<?>)store.get( Names.vrCommands);
if (list != null && list.size() > 0) {
Object obj = list.get(0);
if (obj instanceof String) {
return (Vector<String>) list;
}
}
}
return null;
}
/**
* Set 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
* @param vrCommands the Vector of vrCommands
* @since SmartDeviceLink 2.0
*/
public void setVrCommands(Vector<String> vrCommands) {
if (vrCommands != null) {
store.put(Names.vrCommands, vrCommands);
}
}
/**
* Set the image
* @param image the image of the choice
*/
public void setImage(Image image) {
if (image != null) {
store.put(Names.image, image);
} else {
store.remove(Names.image);
}
}
/**
* Get the image
* @return the image of the choice
*/
public Image getImage() {
Object obj = store.get(Names.image);
if (obj instanceof Image) {
return (Image) obj;
} else if (obj instanceof Hashtable) {
try {
return new Image((Hashtable) obj);
} catch (Exception e) {
DebugTool.logError("Failed to parse " + getClass().getSimpleName() + "." + Names.image, e);
}
}
return null;
}
}
|
