org.jivesoftware.smackx.workgroup.util.MetaDataUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smack-legacy Show documentation

Smack legacy extensions. Usually XEPs in the state 'retracted', 'rejected', 'deprecated', 'obsolete' or in a long standing 'deferred' state.

There is a newer version: 4.5.0-beta5

Show newest version

/**
 *
 * Copyright 2003-2007 Jive Software.
 *
 * 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 org.jivesoftware.smackx.workgroup.util;

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

import org.jivesoftware.smack.util.StringUtils;
import org.jivesoftware.smack.xml.XmlPullParser;
import org.jivesoftware.smack.xml.XmlPullParserException;

import org.jivesoftware.smackx.workgroup.MetaData;

/**
 * Utility class for meta-data parsing and writing.
 *
 * @author Matt Tucker
 */
public class MetaDataUtils {

    /**
     * Parses any available meta-data and returns it as a Map of String name/value pairs. The
     * parser must be positioned at an opening meta-data tag, or the an empty map will be returned.
     *
     * @param parser the XML parser positioned at an opening meta-data tag.
     * @return the meta-data.
     * @throws XmlPullParserException if an error occurs while parsing the XML.
     * @throws IOException            if an error occurs while parsing the XML.
     */
    public static Map> parseMetaData(XmlPullParser parser) throws XmlPullParserException, IOException {
        XmlPullParser.Event eventType = parser.getEventType();

        // If correctly positioned on an opening meta-data tag, parse meta-data.
        if ((eventType == XmlPullParser.Event.START_ELEMENT)
                && parser.getName().equals(MetaData.ELEMENT_NAME)
                && parser.getNamespace().equals(MetaData.NAMESPACE)) {
            Map> metaData = new Hashtable<>();

            eventType = parser.next();

            // Keep parsing until we've gotten to end of meta-data.
            while ((eventType != XmlPullParser.Event.END_ELEMENT)
                    || !parser.getName().equals(MetaData.ELEMENT_NAME)) {
                String name = parser.getAttributeValue(0);
                String value = parser.nextText();

                if (metaData.containsKey(name)) {
                    List values = metaData.get(name);
                    values.add(value);
                }
                else {
                    List values = new ArrayList<>();
                    values.add(value);
                    metaData.put(name, values);
                }

                eventType = parser.next();
            }

            return metaData;
        }

        return Collections.emptyMap();
    }

    /**
     * Serializes a Map of String name/value pairs into the meta-data XML format.
     *
     * @param metaData the Map of meta-data as Map<String, List<String>>
     * @return the meta-data values in XML form.
     */
    public static String serializeMetaData(Map> metaData) {
        StringBuilder buf = new StringBuilder();
        if (metaData != null && metaData.size() > 0) {
            buf.append("");
            for (String key : metaData.keySet()) {
                List value = metaData.get(key);
                for (String v : value) {
                    buf.append("");
                    buf.append(StringUtils.escapeForXmlText(v));
                    buf.append("");
                }
            }
            buf.append("");
        }
        return buf.toString();
    }
}