model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/DataTreeAwareEffectiveStatement.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 static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.yangtools.yang.model.api.stmt.DefaultMethodHelpers.filterOptional;
  12
  13 import com.google.common.annotations.Beta;
  14 import java.util.Optional;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.eclipse.jdt.annotation.NonNullByDefault;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  19
  20 /**
  21  * Interface implemented by all {@link SchemaTreeAwareEffectiveStatement}s which can contain a {@code data tree} child.
  22  *
  23  * @param <A> Argument type
  24  * @param <D> Class representing declared version of this statement.
  25  */
  26 @Beta
  27 public interface DataTreeAwareEffectiveStatement<A, D extends DeclaredStatement<A>>
  28         extends SchemaTreeAwareEffectiveStatement<A, D> {
  29     /**
  30      * Namespace of {@code data node}s. This is a subtree of
  31      * {@link SchemaTreeAwareEffectiveStatement.SchemaTreeNamespace} in that all data nodes are also schema nodes. The
  32      * structure of the tree is different, though, as {@code choice} and {@code case} statements are glossed over and
  33      * they do not contribute to the tree hierarchy -- only their children do.
  34      *
  35      * <p>
  36      * This corresponds to the {@code data tree} view of a YANG-defined data.
  37      */
  38     @NonNullByDefault
  39     abstract class DataTreeNamespace extends EffectiveStatementNamespace<DataTreeEffectiveStatement<?>> {
  40         private DataTreeNamespace() {
  41             // Should never be instantiated
  42         }
  43     }
  44
  45     /**
  46      * Find a {@code data tree} child {@link DataTreeEffectiveStatement}, as identified by its QName argument.
  47      *
  48      * @param qname Child identifier
  49      * @return Data tree child, or empty
  50      * @throws NullPointerException if {@code qname} is null
  51      */
  52     default @NonNull Optional<DataTreeEffectiveStatement<?>> findDataTreeNode(final @NonNull QName qname) {
  53         return get(DataTreeNamespace.class, requireNonNull(qname));
  54     }
  55
  56     /**
  57      * Find a {@code data tree} child {@link DataTreeEffectiveStatement}, as identified by its QName argument.
  58      *
  59      * @param <E> Effective substatement type
  60      * @param type Effective substatement class
  61      * @param qname Child identifier
  62      * @return Data tree child, or empty
  63      * @throws NullPointerException if any argument is null
  64      */
  65     default <E> @NonNull Optional<E> findDataTreeNode(final Class<E> type, final @NonNull QName qname) {
  66         return filterOptional(type, findDataTreeNode(qname));
  67     }
  68 }