c407ef9ed682f581d6a91706d1d63580e799dfb3
[yangtools.git] / yang / yang-parser-spi / src / main / java / org / opendaylight / yangtools / yang / parser / spi / GroupingNamespace.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.yang.parser.spi;
9
10 import org.eclipse.jdt.annotation.NonNull;
11 import org.opendaylight.yangtools.yang.common.QName;
12 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
13 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
14 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
15 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace.TreeScoped;
16 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
17
18 /**
19  * Grouping namespace. * All grouping names defined within a parent node or at the top level of the module
20  * or its submodules share the same grouping identifier namespace. This namespace is scoped to all
21  * descendant nodes of the parent node or module.
22  *
23  * <p>
24  * This means that any descendant node may use that grouping, and it MUST NOT define a grouping with the same name.
25  */
26 public interface GroupingNamespace extends TreeScoped<QName, GroupingStatement, GroupingEffectiveStatement> {
27     NamespaceBehaviour<QName, StmtContext<?, GroupingStatement, GroupingEffectiveStatement>,
28             @NonNull GroupingNamespace> BEHAVIOUR = NamespaceBehaviour.treeScoped(GroupingNamespace.class);
29
30 }