078e1a109c224ad581aecbfb455f2430725927d7
[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 javax.annotation.Nonnull;
12 import javax.annotation.Nullable;
13 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
14
15 public interface PatternStatement extends ConstrainedDocumentedDeclaredStatement<PatternConstraint> {
16     default @Nonnull PatternConstraint getValue() {
17         return argument();
18     }
19
20     /**
21      * Return a modifier statement, if present. In RFC6020 semantics, there are no modifiers and this methods always
22      * returns null.
23      *
24      * @return modifier statement, nul if not present.
25      */
26     default @Nullable ModifierStatement getModifierStatement() {
27         final Optional<ModifierStatement> opt = findFirstDeclaredSubstatement(ModifierStatement.class);
28         return opt.isPresent() ? opt.get() : null;
29     }
30 }