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

   1 /*
   2  * Copyright (c) 2015 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.stmt;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import java.util.Set;
  14 import java.util.function.Predicate;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18
  19 /**
  20  * Represents YANG if-feature statement. The "if-feature" statement makes its parent statement conditional.
  21  */
  22 public interface IfFeatureStatement extends DeclaredStatement<Predicate<Set<QName>>> {
  23     /**
  24      * In YANG 1.1 (RFC7950) implementation of IfFeatureStatement, the argument is a boolean expression over feature
  25      * names defined by "feature" statements. Hence, add implementation to return a predicate on a collection
  26      * of features against which to evaluate.
  27      *
  28      * @return Predicate on a collection of QNames against which to evaluate
  29      */
  30     @Beta
  31     default @NonNull Predicate<Set<QName>> getIfFeaturePredicate() {
  32         // FIXME: YANGTOOLS-908: verifyNotNull() should not be needed here
  33         return verifyNotNull(argument());
  34     }
  35 }