yang/odlext-model-api/src/main/java/org/opendaylight/yangtools/odlext/model/api/YangModeledAnyxmlSchemaNode.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.odlext.model.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
  13 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  14 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  15 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  16
  17 /**
  18  * The "YangModeledAnyXml" interface defines an interior node in the schema tree. It takes
  19  * one argument, which is an identifier represented by QName inherited from
  20  * {@link SchemaNode}, followed by a block of substatements that holds detailed
  21  * anyxml information. The substatements are defined in {@link DataSchemaNode}.
  22  * The "YangModeledAnyXml" in contrast to the "AnyXml" interface can also provide schema
  23  * of contained XML information. <br>
  24  * <br>
  25  * This interface was modeled according to definition in <a
  26  * href="https://tools.ietf.org/html/rfc6020#section-7.10">[RFC-6020] The anyxml
  27  * Statement</a>
  28  */
  29 @Beta
  30 public interface YangModeledAnyxmlSchemaNode extends AnyxmlSchemaNode {
  31
  32     /**
  33      * Returns the root schema node of the data in this anyxml node.
  34      *
  35      * @return DataSchemaNode - schema of contained XML data
  36      */
  37     @NonNull ContainerSchemaNode getSchemaOfAnyXmlData();
  38 }