org.opendaylight.yangtools.yang.model.api.ActionNodeContainer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of yangtools-docs Show documentation

YANG Tools documentation

There is a newer version: 14.0.4

/*
 * Copyright (c) 2016 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.model.api;

import static java.util.Objects.requireNonNull;

import java.util.Collection;
import java.util.Optional;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.yang.common.QName;

/**
 * Node which can contain {@link ActionDefinition}.
 */
public interface ActionNodeContainer {
    /**
     * Return the set of actions.
     *
     * @return set of action nodes
     */
    @NonNull Collection getActions();

    /**
     * Find an action based on its QName. Default implementation searches the set returned by {@link #getActions()}.
     *
     * @param qname Action's QName
     * @return Action definition, if found
     * @throws NullPointerException if {@code qname} is {@code null}
     */
    default Optional findAction(final QName qname) {
        requireNonNull(qname);
        for (var action : getActions()) {
            if (qname.equals(action.getQName())) {
                return Optional.of(action);
            }
        }
        return Optional.empty();
    }
}