API Clarity: Documented o.o.y.yang.data.api and o.o.y.yang.data.api.schema packages.
[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / schema / MapNode.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.InstanceIdentifier.NodeIdentifier;
11 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifierWithPredicates;
12
13 /**
14  * Containment node, which contains {@link MapEntryNode} of the same type, which may
15  * be quickly retrieved using key.
16  *
17  * This node maps to the list node in YANG schema, schema and semantics of this node,
18  * its children and key construction is  defined by YANG <code>list</code>
19  * statement and its <code>key</code> and <code>ordered-by</code> substatements.
20  *
21  */
22 public interface MapNode extends //
23         MixinNode,
24         DataContainerChild<NodeIdentifier, Iterable<MapEntryNode>>,
25         NormalizedNodeContainer<NodeIdentifier, NodeIdentifierWithPredicates, MapEntryNode> {
26
27 }