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