Element.java

  1. /**
  2.  *
  3.  * Copyright © 2014-2019 Florian Schmaus
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  17. package org.jivesoftware.smack.packet;

  18. /**
  19.  * Interface to represent a XML element. This is similar to {@link ExtensionElement}, but does not
  20.  * carry a namespace and is usually included as child element of an stanza extension.
  21.  */
  22. public interface Element {

  23.     CharSequence toXML(XmlEnvironment xmlEnvironment);

  24.     /**
  25.      * Returns the XML representation of this Element. This method takes an optional argument for the enclosing
  26.      * namespace which may be null or the empty String if the value is not known.
  27.      *
  28.      * @param enclosingNamespace the enclosing namespace or {@code null}.
  29.      * @return the stanza extension as XML.
  30.      */
  31.     default CharSequence toXML(String enclosingNamespace) {
  32.         XmlEnvironment xmlEnvironment = new XmlEnvironment(enclosingNamespace);
  33.         return toXML(xmlEnvironment);
  34.     }

  35.     default CharSequence toXML() {
  36.         return toXML(XmlEnvironment.EMPTY);
  37.     }
  38. }