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

   1 /*
   2  * Copyright (c) 2013 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.model.api;
   9
  10 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
  11
  12 /**
  13  * Interface describing YANG 'grouping' statement.
  14  *
  15  * <p>
  16  * It is used to define a reusable block of nodes, which may be used locally in
  17  * the module, in modules that include it, and by other modules that import from it.
  18  *
  19  * <p>
  20  * Note: this interface extends {@link AddedByUsesAware}, but this contradicts the javadoc of {@link #isAddedByUses()},
  21  *       as groupings can never be encountered in 'data schema node' context. It is their children, which are data
  22  *       schema node, but those really are instantiated and typically differ in {@link #getQName()}'s namespace.
  23  */
  24 public interface GroupingDefinition extends DataNodeContainer, SchemaNode, NotificationNodeContainer,
  25        ActionNodeContainer, AddedByUsesAware, EffectiveStatementEquivalent<GroupingEffectiveStatement> {
  26
  27 }