b147685742e19c85305b3471c5d3ff2151b2438f
[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 static com.google.common.base.Verify.verifyNotNull;
11
12 import java.util.Optional;
13 import org.eclipse.jdt.annotation.NonNull;
14 import org.eclipse.jdt.annotation.Nullable;
15 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
16
17 public interface PatternStatement extends ConstrainedDocumentedDeclaredStatement<PatternConstraint> {
18     default @NonNull PatternConstraint getValue() {
19         // FIXME: YANGTOOLS-908: verifyNotNull() should not be needed here
20         return verifyNotNull(argument());
21     }
22
23     /**
24      * Return a modifier statement, if present. In RFC6020 semantics, there are no modifiers and this methods always
25      * returns null.
26      *
27      * @return modifier statement, nul if not present.
28      */
29     default @Nullable ModifierStatement getModifierStatement() {
30         final Optional<ModifierStatement> opt = findFirstDeclaredSubstatement(ModifierStatement.class);
31         return opt.isPresent() ? opt.get() : null;
32     }
33 }