yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/StoreTreeNode.java

   1 /*
   2  * Copyright (c) 2014 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.data.api.schema.tree;
   9
  10 import java.util.Optional;
  11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  12
  13 /**
  14  * A tree node which has references to its child leaves. This are typically internal non-data leaves, such as
  15  * containers, lists, etc.
  16  *
  17  * @param <C> Final node type
  18  */
  19 // FIXME: 3.0.0: Use @NonNullByDefault
  20 public interface StoreTreeNode<C extends StoreTreeNode<C>> {
  21     /**
  22      * Returns a direct child of the node.
  23      *
  24      * @param child Identifier of child
  25      * @return Optional with node if the child is existing, {@link Optional#empty()} otherwise.
  26      */
  27     // FIXME: 3.0.0: document NullPointerException being thrown
  28     Optional<C> getChild(PathArgument child);
  29 }