mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-06-17 00:44: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).
57 lines
1.9 KiB
Java
57 lines
1.9 KiB
Java
/**
|
|
*
|
|
* Copyright 2018-2021 Florian Schmaus
|
|
*
|
|
* 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.smack.packet;
|
|
|
|
import javax.xml.namespace.QName;
|
|
|
|
/**
|
|
* Interface to represent XML elements. Every XML element in XMPP has a qualified XML name ({@link QName}). This name
|
|
* can be obtained via {@link #getQName()}.
|
|
* <p>
|
|
* XMPP uses "extension elements", i.e. XML elements, to provide extended functionality beyond what is in the base XMPP
|
|
* specification. Examples of extensions elements include message events, message properties, and extra presence data.
|
|
* IQ stanzas have limited support for extension elements. See {@link ExtensionElement} for more information about XMPP
|
|
* extension elements.
|
|
* </p>
|
|
* <p>
|
|
* It is recommend to use {@link ExtensionElement} over this class when creating new extension elements.
|
|
* </p>
|
|
*
|
|
* @see org.jivesoftware.smack.provider.ExtensionElementProvider
|
|
* @since 4.5
|
|
*/
|
|
public interface XmlElement extends NamedElement, XmlLangElement {
|
|
|
|
/**
|
|
* Returns the root element XML namespace.
|
|
*
|
|
* @return the namespace.
|
|
*/
|
|
String getNamespace();
|
|
|
|
default QName getQName() {
|
|
String namespaceURI = getNamespace();
|
|
String localPart = getElementName();
|
|
return new QName(namespaceURI, localPart);
|
|
}
|
|
|
|
@Override
|
|
default String getLanguage() {
|
|
return null;
|
|
}
|
|
}
|