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 org.eclipse.jdt.annotation.NonNull;
  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     /**
  21      * Return a {@link MandatoryStatement} child, if present.
  22      *
  23      * @return A {@link MandatoryStatement}, or empty if none is present.
  24      */
  25     default @NonNull Optional<MandatoryStatement> getMandatory() {
  26         return findFirstDeclaredSubstatement(MandatoryStatement.class);
  27     }
  28 }