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