yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ModifierStatement.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.yangtools.yang.model.api.stmt;
  10
  11 import static com.google.common.base.Verify.verifyNotNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  17 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  18 import org.opendaylight.yangtools.yang.model.api.type.ModifierKind;
  19
  20 /**
  21  * Represents YANG modifier statement.
  22  *
  23  * <p>
  24  * The "modifier" statement, which is an optional substatement to the "pattern" statement, takes as an argument
  25  * the string "invert-match". If a pattern has the "invert-match" modifier present, the type is restricted to values
  26  * that do not match the pattern.
  27  */
  28 @Beta
  29 public interface ModifierStatement extends DeclaredStatement<ModifierKind> {
  30     @Override
  31     default StatementDefinition statementDefinition() {
  32         return YangStmtMapping.MODIFIER;
  33     }
  34
  35     default @NonNull ModifierKind getValue() {
  36         // FIXME: YANGTOOLS-908: verifyNotNull() should not be needed here
  37         return verifyNotNull(argument());
  38     }
  39 }