Refactor typedef implementations
[yangtools.git] / 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.common.QName;
13 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
14 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
15 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
16
17 /**
18  * Effective model statement which should be used to derive application behaviour related to typedefs.
19  */
20 public interface TypedefEffectiveStatement extends EffectiveStatement<QName, TypedefStatement>, TypeDefinitionAware {
21     @Override
22     default StatementDefinition statementDefinition() {
23         return YangStmtMapping.TYPEDEF;
24     }
25
26     /**
27      * Return this type definition as an effective type statement.
28      *
29      * @return Effective type statement.
30      */
31     @Beta
32     @NonNull TypeEffectiveStatement<TypeStatement> asTypeEffectiveStatement();
33 }