mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-06-14 07:34:50 +02:00
3d4e7938a7
ExtensionElement is now a marker interface that requires all implementation non-abstract classes to carry a static final QNAME field (of type QName). This is verified by a new unit test. Also FullyQualifiedElement is renamed to simply XmlElement. XmlElement is used over ExtensionElement when implementing classes do not statically know the qualified name of the XML elements they represent. In general, XmlElement should be used sparingly, and every XML element should be modeled by its own Java class (implementing ExtensionElement).
49 lines
2 KiB
Java
49 lines
2 KiB
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 java.util.List;
|
|
|
|
import org.jivesoftware.smack.packet.ExtensionElement;
|
|
import org.jivesoftware.smack.packet.Stanza;
|
|
import org.jivesoftware.smack.packet.XmlElement;
|
|
import org.jivesoftware.smack.util.PacketParserUtils;
|
|
|
|
/**
|
|
* This interface defines {@link ExtensionElement} implementations that contain other
|
|
* extensions. This effectively extends the idea of an extension within one of the
|
|
* top level {@link Stanza} types to consider any embedded element to be an extension
|
|
* of its parent. This more easily enables the usage of some of Smacks parsing
|
|
* utilities such as {@link PacketParserUtils#parseExtensionElement(String, String, org.jivesoftware.smack.xml.XmlPullParser, org.jivesoftware.smack.packet.XmlEnvironment)} to be used
|
|
* to parse any element of the XML being parsed.
|
|
*
|
|
* <p>Top level extensions have only one element, but they can have multiple children, or
|
|
* their children can have multiple children. This interface is a way of allowing extensions
|
|
* to be embedded within one another as a partial or complete one to one mapping of extension
|
|
* to element.
|
|
*
|
|
* @author Robin Collier
|
|
*/
|
|
public interface EmbeddedPacketExtension extends XmlElement {
|
|
/**
|
|
* Get the list of embedded {@link ExtensionElement} objects.
|
|
*
|
|
* @return List of embedded {@link ExtensionElement}
|
|
*/
|
|
List<XmlElement> getExtensions();
|
|
}
|