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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.ButtonName;
import java.util.Hashtable;
/**
* Provides information about the capabilities of a SDL HMI button.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>SmartDeviceLink Ver. Available</th>
* </tr>
* <tr>
* <td>name</td>
* <td>ButtonName</td>
* <td>The name of theSDL HMI button.</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>shortPressAvailable</td>
* <td>Boolean</td>
* <td>The button supports a SHORT press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>longPressAvailable</td>
* <td>Boolean</td>
* <td>The button supports a LONG press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>upDownAvailable</td>
* <td>Boolean</td>
* <td>The button supports "button down" and "button up". When the button is depressed, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONDOWN.
* <p> When the button is released, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONUP.</p></td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
*
* <p>Upon the request HMI must provide the list of the following information:</p>
* <p>The names of all existing/supported hardware buttons.</p>
* <p>The availability of LONG/SHORT press for each existing/supported hardware button correspondingly</p>
* <p>The availability of UP/DOWN events for each existing/supported hardware button correspondingly.</p>
*
* @see ButtonName
* @see com.smartdevicelink.proxy.rpc.enums.ButtonEventMode
* @see com.smartdevicelink.proxy.rpc.enums.ButtonPressMode
* @see OnButtonEvent
* @see OnButtonPress
* @since SmartDeviceLink 1.0
*/
public class ButtonCapabilities extends RPCStruct {
public static final String KEY_NAME = "name";
public static final String KEY_SHORT_PRESS_AVAILABLE = "shortPressAvailable";
public static final String KEY_LONG_PRESS_AVAILABLE = "longPressAvailable";
public static final String KEY_UP_DOWN_AVAILABLE = "upDownAvailable";
public static final String KEY_MODULE_INFO = "moduleInfo";
/**
* Constructs a newly allocated ButtonCapabilities object
*/
public ButtonCapabilities() {
}
/**
* Constructs a newly allocated ButtonCapabilities object indicated by the Hashtable parameter
*
* @param hash The Hashtable to use
*/
public ButtonCapabilities(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Constructs a newly allocated ButtonCapabilities object
*
* @param name the name of button
* @param shortPressAvailable True if support otherwise False.
* @param longPressAvailable True if support otherwise False.
* @param upDownAvailable True if support otherwise False.
*/
public ButtonCapabilities(@NonNull ButtonName name, @NonNull Boolean shortPressAvailable, @NonNull Boolean longPressAvailable, @NonNull Boolean upDownAvailable) {
this();
setName(name);
setShortPressAvailable(shortPressAvailable);
setLongPressAvailable(longPressAvailable);
setUpDownAvailable(upDownAvailable);
}
/**
* Get the name of theSDL HMI button.
*
* @return ButtonName the name of the Button
*/
public ButtonName getName() {
return (ButtonName) getObject(ButtonName.class, KEY_NAME);
}
/**
* Set the name of theSDL HMI button.
*
* @param name the name of button
*/
public ButtonCapabilities setName(@NonNull ButtonName name) {
setValue(KEY_NAME, name);
return this;
}
/**
* Whether the button supports a SHORT press. See <i>{@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode}</i> for more information.
*
* @return True if support otherwise False.
*/
public Boolean getShortPressAvailable() {
return getBoolean(KEY_SHORT_PRESS_AVAILABLE);
}
/**
* Set the button supports a SHORT press. See <i>{@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode}</i> for more information.
*
* @param shortPressAvailable True if support otherwise False.
*/
public ButtonCapabilities setShortPressAvailable(@NonNull Boolean shortPressAvailable) {
setValue(KEY_SHORT_PRESS_AVAILABLE, shortPressAvailable);
return this;
}
/**
* Whether the button supports a LONG press. See <i>{@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode}</i> for more information.
*
* @return True if support otherwise False.
*/
public Boolean getLongPressAvailable() {
return getBoolean(KEY_LONG_PRESS_AVAILABLE);
}
/**
* Set the button supports a LONG press. See <i>{@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode}</i> for more information.
*
* @param longPressAvailable True if support otherwise False.
*/
public ButtonCapabilities setLongPressAvailable(@NonNull Boolean longPressAvailable) {
setValue(KEY_LONG_PRESS_AVAILABLE, longPressAvailable);
return this;
}
/**
* Whether the button supports "button down" and "button up". When the button is depressed, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONDOWN.
*
* @return True if support otherwise False.
*/
public Boolean getUpDownAvailable() {
return getBoolean(KEY_UP_DOWN_AVAILABLE);
}
/**
* Set the button supports "button down" and "button up". When the button is depressed, the <i>{@linkplain OnButtonEvent}</i> notification will be invoked with a value of BUTTONDOWN.
*
* @param upDownAvailable True if support otherwise False.
*/
public ButtonCapabilities setUpDownAvailable(@NonNull Boolean upDownAvailable) {
setValue(KEY_UP_DOWN_AVAILABLE, upDownAvailable);
return this;
}
/**
* Sets ModuleInfo for this capability
*
* @param info the ModuleInfo to be set
*/
public ButtonCapabilities setModuleInfo(ModuleInfo info) {
setValue(KEY_MODULE_INFO, info);
return this;
}
/**
* Gets a ModuleInfo of this capability
*
* @return module info of this capability
*/
public ModuleInfo getModuleInfo() {
return (ModuleInfo) getObject(ModuleInfo.class, KEY_MODULE_INFO);
}
}
|
