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;
14 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
15 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueEffectiveStatement;
18 * Interface describing YANG 'list' statement.
21 * The 'list' statement is used to define an interior data node in the schema tree. A list entry is uniquely identified
22 * by the values of the list's keys, if defined.
24 public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget, DataSchemaNode, ActionNodeContainer,
25 NotificationNodeContainer, ElementCountConstraintAware, MustConstraintAware,
26 UserOrderedAware<ListEffectiveStatement> {
28 * Returns the list of leaf identifiers.
30 * @return List of QNames of leaf identifiers of this list, empty if the list has no keys.
32 @NonNull List<@NonNull QName> getKeyDefinition();
35 * Returns unique constraints.
37 * @return Collection of unique constraints of this list schema node
39 @NonNull Collection<? extends @NonNull UniqueEffectiveStatement> getUniqueConstraints();