001/**
002 *
003 * Copyright 2003-2007 Jive Software.
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 */
017
018package org.jivesoftware.smackx.iqprivate.packet;
019
020/**
021 * Interface to represent private data. Each private data chunk is an XML sub-document
022 * with a root element name and namespace.
023 *
024 * @see org.jivesoftware.smackx.iqprivate.PrivateDataManager
025 * @author Matt Tucker
026 */
027public interface PrivateData {
028
029    /**
030     * Returns the root element name.
031     *
032     * @return the element name.
033     */
034    String getElementName();
035
036    /**
037     * Returns the root element XML namespace.
038     *
039     * @return the namespace.
040     */
041    String getNamespace();
042
043    /**
044     * Returns the XML reppresentation of the PrivateData.
045     *
046     * @return the private data as XML.
047     */
048    CharSequence toXML();
049}