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