IfFeatureStatement.java

/*
 * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang.model.api.stmt;

import com.google.common.annotations.Beta;
import java.util.Set;
import java.util.function.Predicate;
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;

/**
 * Represents YANG if-feature statement.
 *
 * The "if-feature" statement makes its parent statement conditional.
 */
public interface IfFeatureStatement extends DeclaredStatement<Predicate<Set<QName>>> {
    /**
     * In Yang 1.1 (RFC7950) implementation of IfFeatureStatement, the
     * argument is a boolean expression over feature names defined by
     * "feature" statements. Hence, add implementation to return a
     * predicate on a collection of features against which to evaluate.
     *
     * @return Predicate on a collection of QNames against which to evaluate
     */
    @Beta
    @Nonnull
    Predicate<Set<QName>> getIfFeaturePredicate();
}