Populate data/ hierarchy
[yangtools.git] / model / rfc8040-model-api / src / main / java / org / opendaylight / yangtools / rfc8040 / model / api / YangDataSchemaNode.java
1 /*
2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.rfc8040.model.api;
9
10 import com.google.common.annotations.Beta;
11 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
12 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
13
14 /**
15  * Represents 'yang-data' extension statement defined in
16  * <a href="https://tools.ietf.org/html/rfc8040#section-8">RFC8040</a>. This statement must appear as a top-level
17  * statement, otherwise it is ignored and does not appear in the final schema context. It must contain exactly one
18  * top-level container node (directly or indirectly via a uses statement).
19  */
20 @Beta
21 public interface YangDataSchemaNode extends UnknownSchemaNode {
22     /**
23      * Returns container schema node container within this yang-data definition.
24      *
25      * @return container schema node
26      */
27     ContainerSchemaNode getContainerSchemaNode();
28
29     @Override
30     YangDataEffectiveStatement asEffectiveStatement();
31 }