7fff6d9bd954cb5720632f4439fa8328fddb5f28
[yangtools.git] / 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 org.eclipse.jdt.annotation.NonNull;
14 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
15
16 /**
17  * Represents YANG if-feature statement. The "if-feature" statement makes its parent statement conditional.
18  */
19 public interface IfFeatureStatement extends DeclaredStatement<IfFeatureExpr> {
20     /**
21      * In YANG 1.1 (RFC7950) implementation of IfFeatureStatement, the argument is a boolean expression over feature
22      * names defined by "feature" statements. Hence, add implementation to return a predicate on a collection
23      * of features against which to evaluate.
24      *
25      * @return Predicate on a collection of QNames against which to evaluate
26      */
27     @Beta
28     default @NonNull IfFeatureExpr getIfFeaturePredicate() {
29         // FIXME: YANGTOOLS-908: verifyNotNull() should not be needed here
30         return verifyNotNull(argument());
31     }
32 }