yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/MapEntryNode.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.AttributesContainer;
  10 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  11
  12 /**
  13  *
  14  * Instance of Map entry, this node does not contains value, but child nodes.
  15  *
  16  */
  17 public interface MapEntryNode extends AttributesContainer, DataContainerNode<NodeIdentifierWithPredicates> {
  18
  19     /**
  20      *
  21      * Returns identifier of this node in parent map node
  22      *
  23      * Contents of identifier is defined by <code>key</code> (
  24      * {@link org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.ListSchemaNode#getKeyDefinition()}
  25      * ) statement in YANG schema for associated list item and child {@link LeafNode}s
  26      * values with {@link org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier}
  27      * as defined in the schema.
  28      *
  29      * @return identifier of this node in the context of parent node
  30      */
  31     @Override
  32     NodeIdentifierWithPredicates getIdentifier();
  33
  34 }