org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode Maven / Gradle / Ivy
/*
* Copyright (c) 2015 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 com.google.common.annotations.Beta;
import com.google.common.collect.ImmutableList;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
/**
* A ChoiceSchemaNode defines a set of alternatives. It consists of a number of branches defined as
* {@link CaseSchemaNode} objects.
*/
public interface ChoiceSchemaNode extends DataSchemaNode, AugmentationTarget, MandatoryAware,
EffectiveStatementEquivalent {
/**
* Returns cases of choice, keyed by their {@link SchemaNode#getQName()}. Returned map does not contain null keys
* nor values.
*
* @return set of {@link CaseSchemaNode} objects defined in this node which represents set of arguments of the YANG
* {@code case} substatement of the {@code choice} statement.
*/
Collection getCases();
/**
* Returns the concrete case according to specified Q name.
*
* @param qname
* QName of sought Choice Case Node
* @return child case node of this Choice if child with given name is present, empty otherwise.
* @throws NullPointerException {@code qname} is {@code null}
*/
default Optional findCaseNode(final QName qname) {
requireNonNull(qname);
return getCases().stream().filter(node -> qname.equals(node.getQName())).findFirst();
}
/**
* Returns the concrete cases according to specified name, disregarding their namespace.
*
* @param localName local name of sought child as String
* @return child case nodes matching specified local name, empty list if no match is found.
* @throws NullPointerException if {@code localName} is {@code null}
*/
@Beta
default List findCaseNodes(final String localName) {
requireNonNull(localName);
return getCases().stream()
.filter(node -> localName.equals(node.getQName().getLocalName()))
.collect(ImmutableList.toImmutableList());
}
/**
* Find a specific data schema child, if present. This method searches among its {@link CaseSchemaNode}s,
* potentially recursing to nested choices.
*
* @param qname QName of sought data schema node
* @return Matching node, or empty if no match is found
* @throws NullPointerException if {@code qname} is {@code null}
*/
@Beta
default Optional findDataSchemaChild(final QName qname) {
requireNonNull(qname);
for (var caseNode : getCases()) {
final var child = caseNode.dataChildByName(qname);
if (child != null) {
return Optional.of(child);
}
}
return Optional.empty();
}
/**
* Returns name of case which is in the choice specified as default.
*
* @return string with the name of case which is specified in the argument of the YANG default
* substatement of choice statement.
*/
Optional getDefaultCase();
}