org.jivesoftware.smackx.mood.provider.SimpleMoodConcretisationProvider Maven / Gradle / Ivy

Go to download
/**
 *
 * Copyright 2018 Paul Schaub.
 *
 * 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.mood.provider;

import java.io.IOException;

import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.xml.XmlPullParser;
import org.jivesoftware.smack.xml.XmlPullParserException;

import org.jivesoftware.smackx.mood.element.MoodConcretisation;

/**
 * Simple {@link MoodConcretisationProvider} implementation, suitable for really simple {@link MoodConcretisation}s,
 * that only consist of name and namespace. In such a case it is sufficient to just return an instance of the element
 * addressed by the element name and namespace, since no other values must be parsed.
 *
 * @param  type of the {@link MoodConcretisation}
 */
public abstract class SimpleMoodConcretisationProvider extends MoodConcretisationProvider {

    @Override
    public C parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment) throws IOException, XmlPullParserException {
        // Since the elements name and namespace is known, we can just return an instance of the MoodConcretisation.
        return simpleExtension();
    }

    protected abstract C simpleExtension();
}