summaryrefslogtreecommitdiff
path: root/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java
blob: de052a6f7e2c78b813f292da76bcba116379e70c (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
/*
 * 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.FileType;
import com.smartdevicelink.proxy.rpc.enums.ImageFieldName;

import java.util.Hashtable;
import java.util.List;

/** <p>The name that identifies the field.For example AppIcon,SoftButton, LocationImage, etc.</p>
 * 
 * <p><b>Parameter List</b></p>
 * <table border="1" rules="all">
 * 		<tr>
 * 			<th>Name</th>
 * 			<th>Type</th>
 * 			<th>Description</th>
 *                 <th>Reg.</th>
 *               <th>Notes</th>
 * 			<th> Version</th>
 * 		</tr>
 * 		<tr>
 * 			<td>name</td>
 * 			<td>ImageFieldName</td>
 * 			<td>The name that identifies the field.{@linkplain  ImageFieldName}</td>
 *                 <td></td>
 *                 <td></td>
 * 			<td>SmartDeviceLink 3.0 </td>
 * 		</tr>
 * 		<tr>
 * 			<td>imageTypeSupported</td>
 * 			<td>FileType</td>
 * 			<td>The image types that are supported in this field. {@linkplain FileType}</td>
 *                 <td></td>
 *                 <td>maxlength: 100</td>
 * 			<td>SmartDeviceLink 3.0 </td>
 * 		</tr>
 * 		<tr>
 * 			<td>imageResolution</td>
 * 			<td>ImageResolution</td>
 * 			<td>The image resolution of this field.</td>
 *                 <td>Y</td>
 *                 <td></td>
 * 			<td>SmartDeviceLink 3.0 </td>
 * 		</tr>
 *  </table>
 * @since SmartDeviceLink 3.0
 * @see com.smartdevicelink.proxy.rpc.enums.ImageType
 * @see com.smartdevicelink.proxy.rpc.ImageResolution
 * @see com.smartdevicelink.proxy.rpc.enums.ImageFieldName
 *
 *
 * 
 *
 */

public class ImageField extends RPCStruct {
    public static final String KEY_IMAGE_TYPE_SUPPORTED = "imageTypeSupported";
    public static final String KEY_IMAGE_RESOLUTION = "imageResolution";
    public static final String KEY_NAME = "name";
    
    
    public ImageField() { }
   
    public ImageField(Hashtable<String, Object> hash) {
        super(hash);
    }

    public ImageField(@NonNull ImageFieldName name, @NonNull List<FileType> imageTypeSupported) {
        this();
        setName(name);
        setImageTypeSupported(imageTypeSupported);
    }

    public ImageFieldName getName() {
        return (ImageFieldName) getObject(ImageFieldName.class, KEY_NAME);
    } 
    public void setName(@NonNull ImageFieldName name ) {
        setValue(KEY_NAME, name);
    } 
    @SuppressWarnings("unchecked")
	public List<FileType> getImageTypeSupported() {
        return (List<FileType>) getObject(FileType.class, KEY_IMAGE_TYPE_SUPPORTED);
    }
    public void setImageTypeSupported(@NonNull List<FileType> imageTypeSupported ) {
        setValue(KEY_IMAGE_TYPE_SUPPORTED, imageTypeSupported);
    }
    @SuppressWarnings("unchecked")
    public ImageResolution getImageResolution() {
        return (ImageResolution) getObject(ImageResolution.class, KEY_IMAGE_RESOLUTION);
    } 
    public void setImageResolution( ImageResolution imageResolution ) {
        setValue(KEY_IMAGE_RESOLUTION, imageResolution);
    }      
}