Populate data/ hierarchy
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / stmt / PatternStatement.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. 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 java.util.Optional;
11 import org.eclipse.jdt.annotation.Nullable;
12 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
13 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
14
15 public interface PatternStatement extends ConstrainedDocumentedDeclaredStatement<PatternExpression> {
16     @Override
17     default StatementDefinition statementDefinition() {
18         return YangStmtMapping.PATTERN;
19     }
20
21     /**
22      * Return a modifier statement, if present. In RFC6020 semantics, there are no modifiers and this methods always
23      * returns null.
24      *
25      * @return modifier statement, null if not present.
26      */
27     default @Nullable ModifierStatement getModifierStatement() {
28         final Optional<ModifierStatement> opt = findFirstDeclaredSubstatement(ModifierStatement.class);
29         return opt.isPresent() ? opt.get() : null;
30     }
31 }