1 /** 2 * $RCSfile$ 3 * $Revision$ 4 * $Date$ 5 * 6 * Copyright 2003-2007 Jive Software. 7 * 8 * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); 9 * you may not use this file except in compliance with the License. 10 * You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, software 15 * distributed under the License is distributed on an "AS IS" BASIS, 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17 * See the License for the specific language governing permissions and 18 * limitations under the License. 19 */ 20 21 package org.jivesoftware.smackx.packet; 22 23 /** 24 * Interface to represent private data. Each private data chunk is an XML sub-document 25 * with a root element name and namespace. 26 * 27 * @see org.jivesoftware.smackx.PrivateDataManager 28 * @author Matt Tucker 29 */ 30 public interface PrivateData { 31 32 /** 33 * Returns the root element name. 34 * 35 * @return the element name. 36 */ 37 public String getElementName(); 38 39 /** 40 * Returns the root element XML namespace. 41 * 42 * @return the namespace. 43 */ 44 public String getNamespace(); 45 46 /** 47 * Returns the XML reppresentation of the PrivateData. 48 * 49 * @return the private data as XML. 50 */ 51 public String toXML(); 52 } 53