yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/MustConstraintAware.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;
   9
  10 import java.util.Collection;
  11 import org.eclipse.jdt.annotation.NonNull;
  12
  13 /**
  14  * Mix-in interface for nodes which can define must constraints.
  15  *
  16  * @author Robert Varga
  17  */
  18 public interface MustConstraintAware {
  19     /**
  20      * Specifies the rules which the node which contains {@code must} YANG substatement has to match.
  21      *
  22      * @return collection of {@code MustDefinition} (XPath) instances which represents the concrete data constraints
  23      */
  24     Collection<? extends @NonNull MustDefinition> getMustConstraints();
  25 }