model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/DataTreeEffectiveStatement.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.DataSchemaNode;
  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 DataTreeAwareEffectiveStatement.DataTreeNamespace}. This such statement corresponds to a {@code data node}.
  19  *
  20  * <p>
  21  * This interface could be named {@code SchemaNodeEffectiveStatement}, but that could induce a notion that it has
  22  * something to do with {@link DataSchemaNode} -- which it has not. DataSchemaNode semantics are wrong in may aspects
  23  * and while implementations of this interface may also implement DataSchemaNode, the semantics of this interface should
  24  * always be preferred and DataSchemaNode is to be treated as deprecated whenever possible.
  25  *
  26  * @param <D> Declared statement type
  27  */
  28 @Beta
  29 public interface DataTreeEffectiveStatement<D extends DeclaredStatement<QName>>
  30     extends SchemaTreeEffectiveStatement<D> {
  31
  32 }