model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/WhenConditionAware.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 com.google.common.annotations.Beta;
  11 import java.util.Optional;
  12 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
  13
  14 /**
  15  * Mix-in interface for nodes which can be conditional on a when statement.
  16  *
  17  * @author Robert Varga
  18  */
  19 @Beta
  20 public interface WhenConditionAware {
  21     /**
  22      * Returns when statement.
  23      *
  24      * <p>
  25      * If when condition is present node defined by the parent data definition
  26      * statement is only valid when the returned XPath
  27      * expression conceptually evaluates to "true"
  28      * for a particular instance, then the node defined by the parent data
  29      * definition statement is valid; otherwise, it is not.
  30      *
  31      * @return XPath condition
  32      */
  33     Optional<? extends QualifiedBound> getWhenCondition();
  34
  35 }