/*
 * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang.data.api.schema.tree;

import java.util.Optional;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;

/**
 * A tree node which has references to its child leaves. This are typically internal non-data leaves, such as
 * containers, lists, etc.
 *
 * @param <C> Final node type
 */
// FIXME: 3.0.0: Use @NonNullByDefault
public interface StoreTreeNode<C extends StoreTreeNode<C>> {
    /**
     * Returns a direct child of the node.
     *
     * @param child Identifier of child
     * @return Optional with node if the child is existing, {@link Optional#empty()} otherwise.
     */
    // FIXME: 3.0.0: document NullPointerException being thrown
    Optional<C> getChild(PathArgument child);
}

/*
 * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang.data.api.schema.tree;

import java.util.Optional;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;

/**
 * A tree node which has references to its child leaves. These are typically internal non-data leaves, such as
 * containers, lists, etc.
 *
 * @param <C> Final node type
 */
public interface StoreTreeNode<C extends StoreTreeNode<C>> {
    /**
     * Returns a direct child of the node.
     *
     * @param child Identifier of child
     * @return Optional with node if the child is existing, {@link Optional#empty()} otherwise.
     * @throws NullPointerException when {@code child} is null
     */
    // FIXME: 4.0.0: Optional<? extends C>
    @NonNull Optional<C> getChild(PathArgument child);
}

Document StoreTreeNode.getChild() nullness