aboutsummaryrefslogtreecommitdiff
path: root/src/java/com/android/ims/rcs/uce/presence/pidfparser/pidf/Presence.java
blob: e9a40a848d40e1445c14ec5395c4e360a6202847 (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
/*
 * Copyright (C) 2020 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 com.android.ims.rcs.uce.presence.pidfparser.pidf;

import android.annotation.NonNull;
import android.net.Uri;

import com.android.ims.rcs.uce.presence.pidfparser.ElementBase;
import com.android.internal.annotations.VisibleForTesting;

import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
import org.xmlpull.v1.XmlSerializer;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * The "present" element is the root element of an "application/pidf+xml" object.
 */
public class Presence extends ElementBase {
    /**
     * The presence element consists the following elements:
     * 1: Any number (including 0) of <tuple> elements
     * 2: Any number (including 0) of <note> elements
     * 3: Any number of OPTIONAL extension elements from other namespaces.
     */

    /** The name of this element */
    public static final String ELEMENT_NAME = "presence";

    private static final String ATTRIBUTE_NAME_ENTITY = "entity";

    // The presence element must have an "entity" attribute.
    private String mEntity;

    // The presence element contains any number of <tuple> elements
    private final List<Tuple> mTupleList = new ArrayList<>();

    // The presence element contains any number of <note> elements;
    private final List<Note> mNoteList = new ArrayList<>();

    public Presence() {
    }

    public Presence(@NonNull Uri contact) {
        initEntity(contact);
    }

    private void initEntity(Uri contact) {
        mEntity = contact.toString();
    }

    @VisibleForTesting
    public void setEntity(String entity) {
        mEntity = entity;
    }

    @Override
    protected String initNamespace() {
        return PidfConstant.NAMESPACE;
    }

    @Override
    protected String initElementName() {
        return ELEMENT_NAME;
    }

    public String getEntity() {
        return mEntity;
    }

    public void addTuple(@NonNull Tuple tuple) {
        mTupleList.add(tuple);
    }

    public @NonNull List<Tuple> getTupleList() {
        return Collections.unmodifiableList(mTupleList);
    }

    public void addNote(@NonNull Note note) {
        mNoteList.add(note);
    }

    public @NonNull List<Note> getNoteList() {
        return Collections.unmodifiableList(mNoteList);
    }

    @Override
    public void serialize(XmlSerializer serializer) throws IOException {
        String namespace = getNamespace();
        String elementName = getElementName();

        serializer.startTag(namespace, elementName);
        // entity attribute
        serializer.attribute(XmlPullParser.NO_NAMESPACE, ATTRIBUTE_NAME_ENTITY, mEntity);

        // tuple elements
        for (Tuple tuple : mTupleList) {
            tuple.serialize(serializer);
        }

        // note elements
        for (Note note : mNoteList) {
            note.serialize(serializer);
        }
        serializer.endTag(namespace, elementName);
    }

    @Override
    public void parse(XmlPullParser parser) throws IOException, XmlPullParserException {
        String namespace = parser.getNamespace();
        String name = parser.getName();

        if (!verifyParsingElement(namespace, name)) {
            throw new XmlPullParserException("Incorrect element: " + namespace + ", " + name);
        }

        mEntity = parser.getAttributeValue(XmlPullParser.NO_NAMESPACE, ATTRIBUTE_NAME_ENTITY);

        // Move to the next event.
        int eventType = parser.next();

        while(!(eventType == XmlPullParser.END_TAG
                && getNamespace().equals(parser.getNamespace())
                && getElementName().equals(parser.getName()))) {

            if (eventType == XmlPullParser.START_TAG) {
                String tagName = parser.getName();

                if (isTupleElement(eventType, tagName)) {
                    Tuple tuple = new Tuple();
                    tuple.parse(parser);
                    mTupleList.add(tuple);
                } else if (isNoteElement(eventType, tagName)) {
                    Note note = new Note();
                    note.parse(parser);
                    mNoteList.add(note);
                }
            }

            eventType = parser.next();

            // Leave directly if the event type is the end of the document.
            if (eventType == XmlPullParser.END_DOCUMENT) {
                return;
            }
        }
    }

    private boolean isTupleElement(int eventType, String name) {
        return (eventType == XmlPullParser.START_TAG && Tuple.ELEMENT_NAME.equals(name)) ?
                true : false;
    }

    private boolean isNoteElement(int eventType, String name) {
        return (eventType == XmlPullParser.START_TAG && Note.ELEMENT_NAME.equals(name)) ?
                true : false;
    }
}