blob: 8cc0384c10072db640ce678cee69df18dcc89539 (
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
|
/*
* Copyright 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.app.slice;
import android.annotation.NonNull;
import android.net.Uri;
import android.os.Parcel;
import android.os.Parcelable;
/**
* Class describing the structure of the data contained within a slice.
* <p>
* A data version contains a string which describes the type of structure
* and a revision which denotes this specific implementation. Revisions are expected
* to be backwards compatible and monotonically increasing. Meaning if a
* SliceSpec has the same type and an equal or lesser revision,
* it is expected to be compatible.
* <p>
* Apps rendering slices will provide a list of supported versions to the OS which
* will also be given to the app. Apps should only return a {@link Slice} with a
* {@link SliceSpec} that one of the supported {@link SliceSpec}s provided
* {@link #canRender}.
*
* @see Slice
* @see SliceProvider#onBindSlice(Uri)
*/
public final class SliceSpec implements Parcelable {
private final String mType;
private final int mRevision;
public SliceSpec(@NonNull String type, int revision) {
mType = type;
mRevision = revision;
}
/**
* @hide
*/
public SliceSpec(Parcel source) {
mType = source.readString();
mRevision = source.readInt();
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeString(mType);
dest.writeInt(mRevision);
}
/**
* Gets the type of the version.
*/
public String getType() {
return mType;
}
/**
* Gets the revision of the version.
*/
public int getRevision() {
return mRevision;
}
/**
* Indicates that this spec can be used to render the specified spec.
* <p>
* Rendering support is not bi-directional (e.g. Spec v3 can render
* Spec v2, but Spec v2 cannot render Spec v3).
*
* @param candidate candidate format of data.
* @return true if versions are compatible.
* @see androidx.app.slice.widget.SliceView
*/
public boolean canRender(@NonNull SliceSpec candidate) {
if (!mType.equals(candidate.mType)) return false;
return mRevision >= candidate.mRevision;
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof SliceSpec)) return false;
SliceSpec other = (SliceSpec) obj;
return mType.equals(other.mType) && mRevision == other.mRevision;
}
@Override
public String toString() {
return String.format("SliceSpec{%s,%d}", mType, mRevision);
}
public static final Creator<SliceSpec> CREATOR = new Creator<SliceSpec>() {
@Override
public SliceSpec createFromParcel(Parcel source) {
return new SliceSpec(source);
}
@Override
public SliceSpec[] newArray(int size) {
return new SliceSpec[size];
}
};
}
|
