001/**
002 *
003 * Copyright the original author or authors
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.shim.packet;
018
019import org.jivesoftware.smack.packet.ExtensionElement;
020import org.jivesoftware.smack.packet.NamedElement;
021import org.jivesoftware.smack.util.XmlStringBuilder;
022
023/**
024 * Represents a <b>Header</b> entry as specified by the <a href="http://xmpp.org/extensions/xep-031.html">Stanza Headers and Internet Metadata (SHIM)</a>.
025
026 * @author Robin Collier
027 */
028public class Header implements ExtensionElement {
029    public static final String ELEMENT = "header";
030
031    private final String name;
032    private final String value;
033
034    public Header(String name, String value) {
035        this.name = name;
036        this.value = value;
037    }
038
039    public String getName() {
040        return name;
041    }
042
043    public String getValue() {
044        return value;
045    }
046
047    @Override
048    public String getElementName() {
049        return ELEMENT;
050    }
051
052    @Override
053    public String getNamespace() {
054        return HeadersExtension.NAMESPACE;
055    }
056
057    @Override
058    public XmlStringBuilder toXML(String enclosingNamespace) {
059        // Upcast to NamedElement since we don't want a xmlns attribute
060        XmlStringBuilder xml = new XmlStringBuilder((NamedElement) this);
061        xml.attribute("name", name);
062        xml.rightAngleBracket();
063        xml.escape(value);
064        xml.closeElement(this);
065        return xml;
066    }
067}