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

   1 /*
   2  * Copyright (c) 2018 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.stmt;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.Optional;
  12 import javax.annotation.Nullable;
  13 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  14
  15 /**
  16  * Marker interface for statements which may contain a 'mandatory' statement, as defined in RFC7950.
  17  */
  18 @Beta
  19 public interface MandatoryStatementAwareDeclaredStatement<T> extends DeclaredStatement<T>,
  20         MandatoryStatementContainer {
  21     /**
  22      * Return a {@link MandatoryStatement} child, if present.
  23      *
  24      * @return A {@link MandatoryStatement}, or null if none is present.
  25      */
  26     @Override
  27     default @Nullable MandatoryStatement getMandatory() {
  28         final Optional<MandatoryStatement> opt = findFirstDeclaredSubstatement(MandatoryStatement.class);
  29         return opt.isPresent() ? opt.get() : null;
  30     }
  31 }