2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.api;
10 import java.util.Collection;
11 import java.util.List;
12 import org.eclipse.jdt.annotation.NonNull;
13 import org.opendaylight.yangtools.yang.common.QName;
16 * Interface describing YANG 'list' statement.
19 * The 'list' statement is used to define an interior data node in the schema tree. A list entry is uniquely identified
20 * by the values of the list's keys, if defined.
22 public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget, DataSchemaNode,
23 NotificationNodeContainer, ActionNodeContainer, ElementCountConstraintAware, MustConstraintAware {
25 * Returns the list of leaf identifiers.
27 * @return List of QNames of leaf identifiers of this list, empty if the list has no keys.
29 @NonNull List<QName> getKeyDefinition();
32 * YANG 'ordered-by' statement. It defines whether the order of entries within a list are determined by the user
33 * or the system. If not present, default is false.
35 * @return true if ordered-by argument is "user", false otherwise
37 boolean isUserOrdered();
40 * Returns unique constraints.
42 * @return Collection of unique constraints of this list schema node
44 @NonNull Collection<UniqueConstraint> getUniqueConstraints();