data/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  *
   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.data.api.schema;
   9
  10 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  11
  12 /**
  13  * Abstract node which does not have value but contains valid {@link DataContainerChild} nodes. Schema of this node is
  14  * described by instance of {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer}.
  15  *
  16  * <p>
  17  * <b>NOTE:</b>
  18  * All implementations of this interface are assumed to be {@link OrderingAware.System}, i.e. order-independent.
  19  *
  20  * <h2>Implementation notes</h2>
  21  * This interface should not be implemented directly, but rather implementing one of it's subclasses
  22  * <ul>
  23  *   <li>{@link AugmentationNode}</li>
  24  *   <li>{@link ChoiceNode}</li>
  25  *   <li>{@link ContainerNode}</li>
  26  *   <li>{@link MapEntryNode} and its specializations</li>
  27  *   <li>{@link UnkeyedListEntryNode}</li>
  28  * </ul>
  29  */
  30 public interface DataContainerNode
  31         extends DistinctNodeContainer<PathArgument, DataContainerChild>, OrderingAware.System {
  32     @Override
  33     int hashCode();
  34
  35     @Override
  36     boolean equals(Object obj);
  37 }