mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-06-13 07:04:49 +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).
109 lines
3 KiB
Java
109 lines
3 KiB
Java
/**
|
|
*
|
|
* Copyright © 2018 Paul Schaub
|
|
*
|
|
* 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.message_markup.element;
|
|
|
|
import java.util.Collections;
|
|
import java.util.List;
|
|
|
|
import javax.xml.namespace.QName;
|
|
|
|
import org.jivesoftware.smack.packet.ExtensionElement;
|
|
import org.jivesoftware.smack.util.XmlStringBuilder;
|
|
|
|
public class ListElement extends MarkupElement.NonEmptyChildElement {
|
|
|
|
public static final String ELEMENT = "list";
|
|
public static final QName QNAME = new QName(NAMESPACE, ELEMENT);
|
|
|
|
private final List<ListEntryElement> entries;
|
|
|
|
/**
|
|
* Create a new List element.
|
|
*
|
|
* @param start start index of the list
|
|
* @param end end index of the list
|
|
* @param entries list entries
|
|
*/
|
|
public ListElement(int start, int end, List<ListEntryElement> entries) {
|
|
super(start, end);
|
|
this.entries = Collections.unmodifiableList(entries);
|
|
}
|
|
|
|
/**
|
|
* Return a list of all list entries.
|
|
*
|
|
* @return entries TODO javadoc me please
|
|
*/
|
|
public List<ListEntryElement> getEntries() {
|
|
return entries;
|
|
}
|
|
|
|
@Override
|
|
public String getElementName() {
|
|
return QNAME.getLocalPart();
|
|
}
|
|
|
|
@Override
|
|
public void appendInnerXml(XmlStringBuilder xml) {
|
|
xml.append(getEntries());
|
|
}
|
|
|
|
public static class ListEntryElement implements ExtensionElement {
|
|
|
|
public static final String ELEMENT = "li";
|
|
|
|
public static final QName QNAME = new QName(NAMESPACE, ELEMENT);
|
|
|
|
private final int start;
|
|
|
|
/**
|
|
* Create a new ListEntry element.
|
|
*
|
|
* @param start start index
|
|
*/
|
|
public ListEntryElement(int start) {
|
|
this.start = start;
|
|
}
|
|
|
|
/**
|
|
* Return the start index of this entry.
|
|
* @return start index
|
|
*/
|
|
public int getStart() {
|
|
return start;
|
|
}
|
|
|
|
@Override
|
|
public String getElementName() {
|
|
return QNAME.getLocalPart();
|
|
}
|
|
|
|
@Override
|
|
public String getNamespace() {
|
|
return QNAME.getNamespaceURI();
|
|
}
|
|
|
|
@Override
|
|
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
|
|
XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
|
|
xml.attribute(MarkupElement.MarkupChildElement.ATTR_START, getStart());
|
|
xml.closeEmptyElement();
|
|
return xml;
|
|
}
|
|
}
|
|
}
|