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

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.yangtools.yang.model.api;
  10
  11 import com.google.common.annotations.Beta;
  12 import javax.annotation.Nullable;
  13
  14 /**
  15  * The "anydata" statement defines an interior node in the schema tree.
  16  * It takes one argument, which is an identifier, followed by a block of
  17  * substatements that holds detailed anydata information.
  18  *
  19  * <p>
  20  * The "anydata" statement is used to represent an unknown set of nodes
  21  * that can be modeled with YANG, except anyxml, but for which the data
  22  * model is not known at module design time.  It is possible, though not
  23  * required, for the data model for anydata content to become known
  24  * through protocol signaling or other means that are outside the scope
  25  * of this document.
  26  */
  27 @Beta
  28 public interface AnyDataSchemaNode extends DataSchemaNode {
  29     /**
  30      * Schema of XML data.
  31      *
  32      * @return schema of contained XML data or null if it is not provided
  33      */
  34     @Nullable ContainerSchemaNode getSchemaOfAnyData();
  35 }