data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/UserMapNode.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 java.util.Map;
  11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  12
  13 /**
  14  * {@link MapNode} which additionally preserves user-supplied ordering. This node represents a data instance of
  15  * a {@code list} with {@code ordered-by user;} substatement and a {@code key} definition.
  16  */
  17 public interface UserMapNode extends MapNode, OrderedNodeContainer<MapEntryNode> {
  18     @Override
  19     default Class<UserMapNode> contract() {
  20         return UserMapNode.class;
  21     }
  22
  23     /**
  24      * {@inheritDoc}
  25      *
  26      * <p>
  27      * The implementation is required to define a user-visible iteration order, which must match {@link #childAt(int)}.
  28      */
  29     @Override
  30     Map<NodeIdentifierWithPredicates, MapEntryNode> asMap();
  31 }