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

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, s.r.o. 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.opendaylight.yangtools.yang.common.QName;
  12 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  13 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  14 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  15
  16 /**
  17  * Common interface grouping all {@link EffectiveStatement}s which are accessible via
  18  * {@link SchemaTreeAwareEffectiveStatement.SchemaTreeNamespace}. This such statement corresponds to a
  19  * {@code schema node}.
  20  *
  21  * <p>
  22  * This interface could be named {@code SchemaNodeEffectiveStatement}, but that could induce a notion that it has
  23  * something to do with {@link SchemaNode} -- which it has not. SchemaNode semantics are wrong in may aspects
  24  * and while implementations of this interface may also implement SchemaNode, the semantics of this interface should
  25  * always be preferred and SchemaNode is to be treated as deprecated whenever possible.
  26  *
  27  * @param <D> Declared statement type
  28  */
  29 @Beta
  30 public interface SchemaTreeEffectiveStatement<D extends DeclaredStatement<QName>>
  31     extends NamespacedEffectiveStatement<D> {
  32
  33 }