summaryrefslogtreecommitdiff
path: root/base/src/main/java/com/smartdevicelink/proxy/rpc/AppServiceCapability.java
blob: e582162f493f01fdbcfcabc32c7e993d08260883 (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
/*
 * Copyright (c) 2019 Livio, 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 Livio 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 android.support.annotation.NonNull;

import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.ServiceUpdateReason;

import java.util.Hashtable;

public class AppServiceCapability extends RPCStruct {

	public static final String KEY_UPDATE_REASON = "updateReason";
	public static final String KEY_UPDATED_APP_SERVICE_RECORD = "updatedAppServiceRecord";

	// Constructors

	public AppServiceCapability(){}

	/**
	 * @param hash of parameters
	 */
	public AppServiceCapability(Hashtable<String, Object> hash) {
		super(hash);
	}


	/**
	 * @param updatedAppServiceRecord -
	 */
	public AppServiceCapability(@NonNull AppServiceRecord updatedAppServiceRecord){
		this();
		setUpdatedAppServiceRecord(updatedAppServiceRecord);
	}

	// Setters and Getters

	/**
	 * Only included in OnSystemCapabilityUpdated. Update reason for this service record.
	 * @param updateReason -
	 */
	public void setUpdateReason(ServiceUpdateReason updateReason){
		setValue(KEY_UPDATE_REASON, updateReason);
	}

	/**
	 * Only included in OnSystemCapabilityUpdated. Update reason for this service record.
	 * @return updateReason - The updateReason
	 */
	public ServiceUpdateReason getUpdateReason(){
		return (ServiceUpdateReason) getObject(ServiceUpdateReason.class, KEY_UPDATE_REASON);
	}

	/**
	 * Only included in OnSystemCapabilityUpdated. Update reason for this service record.
	 * @param updatedAppServiceRecord -
	 */
	public void setUpdatedAppServiceRecord(AppServiceRecord updatedAppServiceRecord){
		setValue(KEY_UPDATED_APP_SERVICE_RECORD, updatedAppServiceRecord);
	}

	/**
	 * Only included in OnSystemCapabilityUpdated. Update reason for this service record.
	 * @return updateReason - The updateReason
	 */
	public AppServiceRecord getUpdatedAppServiceRecord(){
		return (AppServiceRecord) getObject(AppServiceRecord.class, KEY_UPDATED_APP_SERVICE_RECORD);
	}

	/**
	 * Helper method to compare an AppServiceCapability to this instance.
	 * @param capability the AppServiceCapability to compare to this one
	 * @return if both AppServiceCapability objects refer to the same service
	 */
	public boolean matchesAppService(AppServiceCapability capability){
		if(capability != null){
			AppServiceRecord appServiceRecord = getUpdatedAppServiceRecord();
			AppServiceRecord otherASR = capability.getUpdatedAppServiceRecord();

			if(appServiceRecord != null && otherASR != null) {
				// If both service IDs exists we can compare them. If either is null we can't use
				// only this check.
				if(appServiceRecord.getServiceID() != null && otherASR.getServiceID() != null){
					//return whether the app service IDs are equal or not
					return appServiceRecord.getServiceID().equalsIgnoreCase(otherASR.getServiceID());
				}else{
					AppServiceManifest manifest = appServiceRecord.getServiceManifest();
					AppServiceManifest otherManifest = otherASR.getServiceManifest();
					if(manifest != null && otherManifest != null){
						//Check the service names, if they are the same it can be assumed they are the same service
						return (manifest.getServiceName() != null && manifest.getServiceName().equalsIgnoreCase(otherManifest.getServiceName()));
					}
				}
			}
		}
		// If it got to this point it was not the same
		return false;
	}

}