yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/DataContainerNode.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
   3  * This program and the accompanying materials are made available under the
   4  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   5  * and is available at http://www.eclipse.org/legal/epl-v10.html
   6  */
   7 package org.opendaylight.yangtools.yang.data.api.schema;
   8
   9 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
  10
  11 /**
  12  *
  13  * Abstract node which does not have value but contains valid {@link DataContainerChild} nodes.
  14  *
  15  * Schema of this node is described by instance of {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer}.
  16  *
  17  * <h2>Implementation notes</h2>
  18  * This interface should not be implemented directly, but rather implementing one of it's subclasses
  19  * <ul>
  20  * <li>{@link ContainerNode}
  21  * <li>{@link MapEntryNode}
  22  * <li>{@link UnkeyedListEntryNode}
  23  * <li>{@link ChoiceNode}
  24  * <li>{@link AugmentationNode}
  25  * </ul>
  26  *
  27  * @param <K> {@link PathArgument} which identifies instance of {@link DataContainerNode}
  28  */
  29 public interface DataContainerNode<K extends PathArgument> extends //
  30         NormalizedNodeContainer<K, PathArgument, DataContainerChild<? extends PathArgument, ?>> {
  31
  32     /**
  33      * Returns iteration of all child nodes
  34      *
  35      * Order of returned child nodes may be defined by subinterfaces.
  36      *
  37      * <b>Implementation Notes:</b>
  38      * <p>
  39      * All nodes returned in this iterable, MUST also be accessible via
  40      * {@link #getChild(PathArgument)} using their associated identifier.
  41      *
  42      * @return Iteration of all child nodes
  43      */
  44     @Override
  45     Iterable<DataContainerChild<? extends PathArgument, ?>> getValue();
  46 }