Populate data/ hierarchy
[yangtools.git] / model / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / stmt / UniqueEffectiveStatement.java
1 /*
2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.model.api.stmt;
9
10 import com.google.common.annotations.Beta;
11 import java.util.Set;
12 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
13 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
14 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
15 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
16
17 /**
18  * Interface describing YANG 'unique' constraint.
19  *
20  * <p>
21  * The 'unique' constraint specifies that the combined values of all the leaf instances specified in the argument
22  * string, including leafs with default values, MUST be unique within all list entry instances in which all referenced
23  * leafs exist (for more information see RFC-6020 section 7.8.3.).
24  */
25 @Beta
26 public interface UniqueEffectiveStatement extends EffectiveStatement<Set<Descendant>, UniqueStatement> {
27     @Override
28     default StatementDefinition statementDefinition() {
29         return YangStmtMapping.UNIQUE;
30     }
31 }