2 * Copyright (c) 2016 ZTE, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.data.util;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.ImmutableList;
14 import com.google.common.collect.ImmutableMap;
15 import com.google.common.collect.ImmutableSet;
16 import com.google.common.collect.Maps;
17 import java.util.Collection;
18 import java.util.Optional;
19 import org.eclipse.jdt.annotation.NonNull;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
22 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
23 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
24 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
25 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
26 import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
27 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
28 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
29 import org.opendaylight.yangtools.yang.model.api.OutputSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
31 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
33 import org.opendaylight.yangtools.yang.model.api.Status;
34 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
35 import org.opendaylight.yangtools.yang.model.api.UsesNode;
36 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
40 * org.opendaylight.yangtools.yang.data.util
41 * Utility class for taking notification or rpc as ContainerSchemaNode.
42 * @author <a href="mailto:geng.xingyuan@zte.com.cn">Geng Xingyuan</a>
44 public final class ContainerSchemaNodes {
46 private ContainerSchemaNodes() {
50 public static ContainerLike forNotification(final NotificationDefinition notification) {
51 return new NotificationContainerSchemaNode(notification);
55 public static ContainerLike forRPC(final RpcDefinition rpc) {
56 return new RpcContainerSchemaNode(rpc);
59 private abstract static class AbstractContainerSchemaNode implements ContainerLike {
60 private final SchemaNode schemaNode;
62 private AbstractContainerSchemaNode(final SchemaNode schemaNode) {
63 this.schemaNode = schemaNode;
67 public Collection<? extends UsesNode> getUses() {
68 return ImmutableSet.of();
72 public boolean isAugmenting() {
77 public Optional<Boolean> effectiveConfig() {
78 return Optional.empty();
82 public QName getQName() {
83 return schemaNode.getQName();
88 public SchemaPath getPath() {
89 return schemaNode.getPath();
93 public Optional<String> getDescription() {
94 return schemaNode.getDescription();
98 public Optional<String> getReference() {
99 return schemaNode.getReference();
103 public Status getStatus() {
104 return schemaNode.getStatus();
108 public Collection<? extends @NonNull MustDefinition> getMustConstraints() {
109 return ImmutableList.of();
113 public Optional<? extends QualifiedBound> getWhenCondition() {
114 return Optional.empty();
118 private static final class RpcContainerSchemaNode extends AbstractContainerSchemaNode {
120 private final RpcDefinition rpcDefinition;
122 private RpcContainerSchemaNode(final RpcDefinition rpcDefinition) {
123 super(rpcDefinition);
124 this.rpcDefinition = rpcDefinition;
128 public Collection<? extends GroupingDefinition> getGroupings() {
129 return rpcDefinition.getGroupings();
133 public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
134 return rpcDefinition.getTypeDefinitions();
138 public Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
139 return ImmutableSet.of();
143 public Collection<? extends DataSchemaNode> getChildNodes() {
144 final InputSchemaNode input = rpcDefinition.getInput();
145 final OutputSchemaNode output = rpcDefinition.getOutput();
146 if (input == null && output == null) {
147 return ImmutableList.of();
148 } else if (input != null && output != null) {
149 return ImmutableList.of(input,output);
150 } else if (input != null) {
151 return ImmutableList.of(input);
153 return ImmutableList.of(output);
158 public Optional<DataSchemaNode> findDataChildByName(final QName name) {
159 switch (name.getLocalName()) {
161 return Optional.of(rpcDefinition.getInput());
163 return Optional.of(rpcDefinition.getOutput());
165 return Optional.empty();
171 public boolean isAddedByUses() {
176 public Collection<? extends ActionDefinition> getActions() {
177 return ImmutableSet.of();
181 public Collection<? extends NotificationDefinition> getNotifications() {
182 return ImmutableSet.of();
186 private static final class NotificationContainerSchemaNode extends AbstractContainerSchemaNode {
188 private final NotificationDefinition notification;
189 private final ImmutableMap<QName, ? extends DataSchemaNode> mapNodes;
191 private NotificationContainerSchemaNode(final NotificationDefinition notification) {
193 this.notification = notification;
194 mapNodes = Maps.uniqueIndex(notification.getChildNodes(), DataSchemaNode::getQName);
198 public Collection<? extends NotificationDefinition> getNotifications() {
199 return ImmutableSet.of(notification);
203 public Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
204 return notification.getAvailableAugmentations();
208 public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
209 return notification.getTypeDefinitions();
213 public Collection<? extends DataSchemaNode> getChildNodes() {
214 return notification.getChildNodes();
218 public Collection<? extends GroupingDefinition> getGroupings() {
219 return notification.getGroupings();
223 public Optional<DataSchemaNode> findDataChildByName(final QName name) {
224 return Optional.ofNullable(mapNodes.get(requireNonNull(name)));
229 public boolean isAddedByUses() {
230 //FIXME: reference to https://bugs.opendaylight.org/show_bug.cgi?id=6897
235 public Collection<? extends ActionDefinition> getActions() {
236 return ImmutableSet.of();