Populate data/ hierarchy
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / stmt / DefaultStatementAwareDeclaredStatement.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.common.QName;
14 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
15
16 /**
17  * Marker interface for statements which may contain a 'default' statement, as defined in RFC7950.
18  */
19 @Beta
20 public interface DefaultStatementAwareDeclaredStatement extends DeclaredStatement<QName> {
21     /**
22      * Return a {@link DefaultStatement} child, if present.
23      *
24      * @return A {@link DefaultStatement}, or empty if none is present.
25      */
26     default @NonNull Optional<DefaultStatement> getDefault() {
27         return findFirstDeclaredSubstatement(DefaultStatement.class);
28     }
29 }