summaryrefslogtreecommitdiff
path: root/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java
blob: 8841126c36559fadb4d63ebf668a15aa2749cdba (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
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
/*
 * 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 com.smartdevicelink.proxy.RPCStruct;

import java.util.HashMap;
import java.util.Hashtable;

/**
 * Describes the type of vehicle the mobile phone is connected with.
 * <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>make</td>
 * 			<td>String</td>
 * 			<td>Make of the vehicle
 * 				 <ul>
 * 					<li>Maxlength = 500</li>
 * 				 </ul>
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>Model</td>
 * 			<td>String</td>
 * 			<td>Model of the vehicle, e.g. Fiesta
 * 				 <ul>
 * 					<li>Maxlength = 500</li>
 * 				 </ul>
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>modelYear</td>
 * 			<td>String</td>
 * 			<td>Model Year of the vehicle, e.g. 2013
 * 				 <ul>
 * 					<li>Maxlength = 500</li>
 * 				 </ul>
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 * 		<tr>
 * 			<td>trim</td>
 * 			<td>String</td>
 * 			<td>Trim of the vehicle, e.g. SE
 * 				 <ul>
 * 					<li>Maxlength = 500</li>
 * 				 </ul>
 * 			</td>
 * 			<td>SmartDeviceLink 2.0</td>
 * 		</tr>
 *  </table>
 *
 * @since SmartDeviceLink 2.0
 */
public class VehicleType extends RPCStruct {
    public static final String KEY_MAKE = "make";
    public static final String KEY_MODEL = "model";
    public static final String KEY_MODEL_YEAR = "modelYear";
    public static final String KEY_TRIM = "trim";

    /**
     * Constructs a newly allocated VehicleType object
     */
    public VehicleType() {
    }

    /**
     * Constructs a newly allocated VehicleType object indicated by the Hashtable parameter
     *
     * @param hash The Hashtable to use
     */
    public VehicleType(Hashtable<String, Object> hash) {
        super(hash);
    }

    /**
     * <p>
     * Constructs a new VehicleType object indicated by the Hashtable
     * parameter
     * </p>
     *
     * @param hash The Hashtable to use
     */
    public VehicleType(HashMap<String, Object> hash) {
        super(new Hashtable<>(hash));
    }

    /**
     * get the make of the vehicle
     *
     * @return the make of the vehicle
     */
    public String getMake() {
        return getString(KEY_MAKE);
    }

    /**
     * set the make of the vehicle
     *
     * @param make the make of the vehicle
     */
    public VehicleType setMake(String make) {
        setValue(KEY_MAKE, make);
        return this;
    }

    /**
     * get the model of the vehicle
     *
     * @return the model of the vehicle
     */
    public String getModel() {
        return getString(KEY_MODEL);
    }

    /**
     * set the model of the vehicle
     *
     * @param model the model of the vehicle
     */
    public VehicleType setModel(String model) {
        setValue(KEY_MODEL, model);
        return this;
    }

    /**
     * get the model year of the vehicle
     *
     * @return the model year of the vehicle
     */
    public String getModelYear() {
        return getString(KEY_MODEL_YEAR);
    }

    /**
     * set the model year of the vehicle
     *
     * @param modelYear the model year of the vehicle
     */
    public VehicleType setModelYear(String modelYear) {
        setValue(KEY_MODEL_YEAR, modelYear);
        return this;
    }

    /**
     * get the trim of the vehicle
     *
     * @return the trim of the vehicle
     */
    public String getTrim() {
        return getString(KEY_TRIM);
    }

    /**
     * set the trim of the vehicle
     *
     * @param trim the trim of the vehicle
     */
    public VehicleType setTrim(String trim) {
        setValue(KEY_TRIM, trim);
        return this;
    }
}