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.Set;
  11
  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      *
  29      * @return child nodes in lexicographical order
  30      */
  31     Set<DataSchemaNode> getChildNodes();
  32
  33     /**
  34      * Returns set of all groupings defined within this DataNodeContainer.
  35      *
  36      * @return grouping statements in lexicographical order
  37      */
  38     Set<GroupingDefinition> getGroupings();
  39
  40     /**
  41      * @param name
  42      *            QName of seeked child
  43      * @return child node of this DataNodeContainer if child with given name is
  44      *         present, null otherwise
  45      */
  46     DataSchemaNode getDataChildByName(QName name);
  47
  48     /**
  49      * @param name
  50      *            name of seeked child as String
  51      * @return child node of this DataNodeContainer if child with given name is
  52      *         present, null otherwise
  53      */
  54     DataSchemaNode getDataChildByName(String name);
  55
  56     /**
  57      * @return Set of all uses nodes defined within this DataNodeContainer
  58      */
  59     Set<UsesNode> getUses();
  60
  61 }