yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypedefEffectiveStatement.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 com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  13 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  14
  15 /**
  16  * Effective model statement which should be used to derive application behaviour related to {@code typedef}s.
  17  * All statements form the {@link TypedefNamespace}.
  18  */
  19 public interface TypedefEffectiveStatement extends NamespacedEffectiveStatement<TypedefStatement>, TypeDefinitionAware {
  20     @Override
  21     default StatementDefinition statementDefinition() {
  22         return YangStmtMapping.TYPEDEF;
  23     }
  24
  25     /**
  26      * Return this type definition as an effective type statement.
  27      *
  28      * @return Effective type statement.
  29      */
  30     @Beta
  31     @NonNull TypeEffectiveStatement<TypeStatement> asTypeEffectiveStatement();
  32 }