yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DataNodeContainer.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 java.util.Collection;
  11 import java.util.Set;
  12 import org.opendaylight.yangtools.yang.common.QName;
  13
  14 /**
  15  * Node which can contains other nodes.
  16  */
  17 public interface DataNodeContainer {
  18
  19     /**
  20      * Returns set of all newly defined types within this DataNodeContainer.
  21      *
  22      * @return typedef statements in lexicographical order
  23      */
  24     Set<TypeDefinition<?>> getTypeDefinitions();
  25
  26     /**
  27      * Returns set of all child nodes defined within this DataNodeContainer.
  28      * Although the return type is a collection, each node is guaranteed to
  29      * be present at most once.
  30      *
  31      * @return child nodes in lexicographical order
  32      */
  33     Collection<DataSchemaNode> getChildNodes();
  34
  35     /**
  36      * Returns set of all groupings defined within this DataNodeContainer.
  37      *
  38      * @return grouping statements in lexicographical order
  39      */
  40     Set<GroupingDefinition> getGroupings();
  41
  42     /**
  43      * Returns the child node corresponding to the specified name.
  44      *
  45      * @param name
  46      *            QName of child
  47      * @return child node of this DataNodeContainer if child with given name is
  48      *         present, null otherwise
  49      */
  50     DataSchemaNode getDataChildByName(QName name);
  51
  52     /**
  53      * Returns grouping nodes used ny this container.
  54      *
  55      * @return Set of all uses nodes defined within this DataNodeContainer
  56      */
  57     Set<UsesNode> getUses();
  58 }