1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.text;
18
19import android.os.Parcel;
20
21/**
22 * Annotations are simple key-value pairs that are preserved across
23 * TextView save/restore cycles and can be used to keep application-specific
24 * data that needs to be maintained for regions of text.
25 */
26public class Annotation implements ParcelableSpan {
27    private final String mKey;
28    private final String mValue;
29
30    public Annotation(String key, String value) {
31        mKey = key;
32        mValue = value;
33    }
34
35    public Annotation(Parcel src) {
36        mKey = src.readString();
37        mValue = src.readString();
38    }
39
40    public int getSpanTypeId() {
41        return getSpanTypeIdInternal();
42    }
43
44    /** @hide */
45    public int getSpanTypeIdInternal() {
46        return TextUtils.ANNOTATION;
47    }
48
49    public int describeContents() {
50        return 0;
51    }
52
53    public void writeToParcel(Parcel dest, int flags) {
54        writeToParcelInternal(dest, flags);
55    }
56
57    /** @hide */
58    public void writeToParcelInternal(Parcel dest, int flags) {
59        dest.writeString(mKey);
60        dest.writeString(mValue);
61    }
62
63    public String getKey() {
64        return mKey;
65    }
66
67    public String getValue() {
68        return mValue;
69    }
70}
71