yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UniqueConstraint.java

   1 /*
   2  * Copyright (c) 2016 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.model.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.Set;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
  14
  15 /**
  16  * Interface describing YANG 'unique' constraint.
  17  *
  18  * <p>
  19  * The 'unique' constraint specifies that the combined values of all the leaf instances specified in the argument
  20  * string, including leafs with default values, MUST be unique within all list entry instances in which all referenced
  21  * leafs exist (for more information see RFC-6020 section 7.8.3.).
  22  */
  23 @Beta
  24 // FIXME: 6.0.0: replace all usages of this class with UniqueEffectiveStatement and remove this
  25 public interface UniqueConstraint {
  26     @NonNull Set<Descendant> getTag();
  27 }