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.YangStmtMapping;
  16 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  17 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  18
  19 // FIXME: 6.0.0: change the over definition of the argument:
  20 //               - argument = XSD pattern string
  21 public interface PatternStatement extends ConstrainedDocumentedDeclaredStatement<PatternConstraint> {
  22     @Override
  23     default StatementDefinition statementDefinition() {
  24         return YangStmtMapping.PATTERN;
  25     }
  26
  27     default @NonNull PatternConstraint getValue() {
  28         // FIXME: YANGTOOLS-908: verifyNotNull() should not be needed here
  29         return verifyNotNull(argument());
  30     }
  31
  32     /**
  33      * Return a modifier statement, if present. In RFC6020 semantics, there are no modifiers and this methods always
  34      * returns null.
  35      *
  36      * @return modifier statement, nul if not present.
  37      */
  38     default @Nullable ModifierStatement getModifierStatement() {
  39         final Optional<ModifierStatement> opt = findFirstDeclaredSubstatement(ModifierStatement.class);
  40         return opt.isPresent() ? opt.get() : null;
  41     }
  42 }