Smack/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java

/**
 *
 * Copyright the original author or authors
 *
 * 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.pubsub;

import org.jivesoftware.smack.packet.PacketExtension;

/**
 * The default payload representation for {@link PayloadItem#getPayload()}.  It simply 
 * stores the XML payload as a string.
 *  
 * @author Robin Collier
 */
public class SimplePayload implements PacketExtension
{
	private final String elemName;
	private final String ns;
	private final CharSequence payload;
	
	/**
	 * Construct a <tt>SimplePayload</tt> object with the specified element name, 
	 * namespace and content.  The content must be well formed XML.
	 * 
	 * @param elementName The root element name (of the payload)
	 * @param namespace The namespace of the payload, null if there is none
	 * @param xmlPayload The payload data
	 */
	public SimplePayload(String elementName, String namespace, CharSequence xmlPayload)
	{
		elemName = elementName;
		payload = xmlPayload;
		ns = namespace;
	}

	public String getElementName()
	{
		return elemName;
	}

	public String getNamespace()
	{
		return ns;
	}

	@Override
	public CharSequence toXML()
	{
		return payload;
	}

	@Override
	public String toString()
	{
		return getClass().getName() + "payload [" + toXML() + "]";
	}
}