summaryrefslogtreecommitdiff
path: root/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java
blob: ae31614f909e30c8fe6849157cfc47033d01c67b (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
/*
 * 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 java.util.Hashtable;

/**
 * Describes the hour, minute and second values used to set the media clock.
 * <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>hours</td>
 *             <td>Integer</td>
 *             <td>The hour. Minvalue="0", maxvalue="59"
 *                     <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
 *             </td>
 *             <td>SmartDeviceLink 1.0</td>
 *         </tr>
 *         <tr>
 *             <td>minutes</td>
 *             <td>Integer</td>
 *             <td>The minute. Minvalue="0", maxvalue="59".</td>
 *             <td>SmartDeviceLink 1.0</td>
 *         </tr>
 *     <tr>
 *             <td>seconds</td>
 *             <td>Integer</td>
 *             <td>The second. Minvalue="0", maxvalue="59".</td>
 *             <td>SmartDeviceLink 1.0</td>
 *         </tr>
 * </table>
 *
 * @since SmartDeviceLink 1.0
 */
public class StartTime extends RPCStruct {
    public static final String KEY_MINUTES = "minutes";
    public static final String KEY_SECONDS = "seconds";
    public static final String KEY_HOURS = "hours";

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

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

    /**
     * Constructs a newly allocated StartTime object
     *
     * @param timeInterval time interval in seconds
     */
    public StartTime(@NonNull Integer timeInterval) {
        this();
        int hours = timeInterval / 3600;
        int minutes = (timeInterval % 3600) / 60;
        int seconds = timeInterval % 60;
        setHours(hours);
        setMinutes(minutes);
        setSeconds(seconds);
    }

    /**
     * Constructs a newly allocated StartTime object
     *
     * @param hours   The hour
     * @param minutes The minute
     * @param seconds The second
     */
    public StartTime(@NonNull Integer hours, @NonNull Integer minutes, @NonNull Integer seconds) {
        this();
        setHours(hours);
        setMinutes(minutes);
        setSeconds(seconds);
    }

    /**
     * Get the hour. Minvalue="0", maxvalue="59"
     * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
     *
     * @return hours Minvalue="0", maxvalue="59"
     */
    public Integer getHours() {
        return getInteger(KEY_HOURS);
    }

    /**
     * Set the hour. Minvalue="0", maxvalue="59"
     * <p><b>Note:</b></p>Some display types only support a max value of 19. If out of range, it will be rejected.
     *
     * @param hours min: 0; max: 59
     */
    public StartTime setHours(@NonNull Integer hours) {
        setValue(KEY_HOURS, hours);
        return this;
    }

    /**
     * Get the minute. Minvalue="0", maxvalue="59".
     *
     * @return minutes Minvalue="0", maxvalue="59"
     */
    public Integer getMinutes() {
        return getInteger(KEY_MINUTES);
    }

    /**
     * Set the minute. Minvalue="0", maxvalue="59".
     *
     * @param minutes min: 0; max: 59
     */
    public StartTime setMinutes(@NonNull Integer minutes) {
        setValue(KEY_MINUTES, minutes);
        return this;
    }

    /**
     * Get the second. Minvalue="0", maxvalue="59".
     *
     * @return seconds. Minvalue="0", maxvalue="59".
     */
    public Integer getSeconds() {
        return getInteger(KEY_SECONDS);
    }

    /**
     * Set the second. Minvalue="0", maxvalue="59".
     *
     * @param seconds min: 0 max: 59
     */
    public StartTime setSeconds(@NonNull Integer seconds) {
        setValue(KEY_SECONDS, seconds);
        return this;
    }
}