yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/ModelStatement.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.meta;
   9
  10 import org.eclipse.jdt.annotation.NonNull;
  11 import org.eclipse.jdt.annotation.Nullable;
  12
  13 /**
  14  * Model statement. There are two base types of model statements:
  15  * <ul>
  16  * <li>{@link DeclaredStatement} - Statement representation as was defined in original
  17  * source. This representation could be used during computation of effective model
  18  * or during transforming YANG model from one serialization format to other.
  19  * </li>
  20  * <li>
  21  * {@link EffectiveStatement} - Representation of effective statement - this
  22  * statement may be different from declared, in such way, that it contains additional
  23  * substatements, provides access to model namespaces. Some effective statements may be not
  24  * directly declared in YANG source, but could be inferred by semantic processing of
  25  * other statements (eg. uses, augment).
  26  * </li>
  27  * </ul>
  28  *
  29  * @param <A> Argument type ({@link Void} if statement does not have argument.)
  30  */
  31 public interface ModelStatement<A> {
  32     /**
  33      * Statement Definition of this statement.
  34      *
  35      * @return definition of this statement.
  36      */
  37     @NonNull StatementDefinition statementDefinition();
  38
  39     /**
  40      * Returns statement argument.
  41      *
  42      * @return statement argument or null if statement does not have argument.
  43      */
  44     // FIXME: figure out @NonNull argument override in subclasses and switch to JDT @Nullable
  45     @Nullable A argument();
  46
  47     /**
  48      * Returns statement source, which denotes if statement was
  49      * explicitly declared in original model or inferred during
  50      * semantic processing of model.
  51      *
  52      * @return statement source.
  53      */
  54     @NonNull StatementSource getStatementSource();
  55 }