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 java.util.Collection;
  10 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  11
  12 /**
  13  *
  14  * Abstract node which does not have value but contains valid {@link DataContainerChild} nodes.
  15  *
  16  * Schema of this node is described by instance of {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer}.
  17  *
  18  * <h2>Implementation notes</h2>
  19  * This interface should not be implemented directly, but rather implementing one of it's subclasses
  20  * <ul>
  21  * <li>{@link ContainerNode}
  22  * <li>{@link MapEntryNode}
  23  * <li>{@link UnkeyedListEntryNode}
  24  * <li>{@link ChoiceNode}
  25  * <li>{@link AugmentationNode}
  26  * </ul>
  27  *
  28  * @param <K> {@link PathArgument} which identifies instance of {@link DataContainerNode}
  29  */
  30 public interface DataContainerNode<K extends PathArgument> extends //
  31         NormalizedNodeContainer<K, PathArgument, DataContainerChild<? extends PathArgument, ?>> {
  32
  33     /**
  34      * Returns iteration of all child nodes
  35      *
  36      * Order of returned child nodes may be defined by subinterfaces.
  37      *
  38      * <b>Implementation Notes:</b>
  39      * <p>
  40      * All nodes returned in this iterable, MUST also be accessible via
  41      * {@link #getChild(PathArgument)} using their associated identifier.
  42      *
  43      * @return Iteration of all child nodes
  44      */
  45     @Override
  46     Collection<DataContainerChild<? extends PathArgument, ?>> getValue();
  47 }