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.opendaylight.yangtools.yang.common.QName;
20 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
21 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
22 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
23 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
24 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
25 import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
27 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
28 import org.opendaylight.yangtools.yang.model.api.OutputSchemaNode;
29 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
30 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
32 import org.opendaylight.yangtools.yang.model.api.Status;
33 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
34 import org.opendaylight.yangtools.yang.model.api.UsesNode;
35 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
39 * org.opendaylight.yangtools.yang.data.util
40 * Utility class for taking notification or rpc as ContainerSchemaNode.
41 * @author <a href="mailto:geng.xingyuan@zte.com.cn">Geng Xingyuan</a>
43 public final class ContainerSchemaNodes {
45 private ContainerSchemaNodes() {
49 public static ContainerLike forNotification(final NotificationDefinition notification) {
50 return new NotificationContainerSchemaNode(notification);
54 public static ContainerLike forRPC(final RpcDefinition rpc) {
55 return new RpcContainerSchemaNode(rpc);
58 private abstract static class AbstractContainerSchemaNode implements ContainerLike {
59 private final SchemaNode schemaNode;
61 private AbstractContainerSchemaNode(final SchemaNode schemaNode) {
62 this.schemaNode = schemaNode;
66 public Collection<? extends UsesNode> getUses() {
67 return ImmutableSet.of();
71 public boolean isAugmenting() {
76 public boolean isConfiguration() {
81 public QName getQName() {
82 return schemaNode.getQName();
87 public SchemaPath getPath() {
88 return schemaNode.getPath();
92 public Optional<String> getDescription() {
93 return schemaNode.getDescription();
97 public Optional<String> getReference() {
98 return schemaNode.getReference();
102 public Status getStatus() {
103 return schemaNode.getStatus();
107 public Collection<? extends MustDefinition> getMustConstraints() {
108 return ImmutableList.of();
112 public Optional<? extends QualifiedBound> getWhenCondition() {
113 return Optional.empty();
117 private static final class RpcContainerSchemaNode extends AbstractContainerSchemaNode {
119 private final RpcDefinition rpcDefinition;
121 private RpcContainerSchemaNode(final RpcDefinition rpcDefinition) {
122 super(rpcDefinition);
123 this.rpcDefinition = rpcDefinition;
127 public Collection<? extends GroupingDefinition> getGroupings() {
128 return rpcDefinition.getGroupings();
132 public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
133 return rpcDefinition.getTypeDefinitions();
137 public Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
138 return ImmutableSet.of();
142 public Collection<? extends DataSchemaNode> getChildNodes() {
143 final InputSchemaNode input = rpcDefinition.getInput();
144 final OutputSchemaNode output = rpcDefinition.getOutput();
145 if (input == null && output == null) {
146 return ImmutableList.of();
147 } else if (input != null && output != null) {
148 return ImmutableList.of(input,output);
149 } else if (input != null) {
150 return ImmutableList.of(input);
152 return ImmutableList.of(output);
157 public Optional<DataSchemaNode> findDataChildByName(final QName name) {
158 switch (name.getLocalName()) {
160 return Optional.of(rpcDefinition.getInput());
162 return Optional.of(rpcDefinition.getOutput());
164 return Optional.empty();
170 public boolean isAddedByUses() {
175 public Collection<? extends ActionDefinition> getActions() {
176 return ImmutableSet.of();
180 public Collection<? extends NotificationDefinition> getNotifications() {
181 return ImmutableSet.of();
185 private static final class NotificationContainerSchemaNode extends AbstractContainerSchemaNode {
187 private final NotificationDefinition notification;
188 private final ImmutableMap<QName, ? extends DataSchemaNode> mapNodes;
190 private NotificationContainerSchemaNode(final NotificationDefinition notification) {
192 this.notification = notification;
193 mapNodes = Maps.uniqueIndex(notification.getChildNodes(), DataSchemaNode::getQName);
197 public Collection<? extends NotificationDefinition> getNotifications() {
198 return ImmutableSet.of(notification);
202 public Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
203 return notification.getAvailableAugmentations();
207 public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
208 return notification.getTypeDefinitions();
212 public Collection<? extends DataSchemaNode> getChildNodes() {
213 return notification.getChildNodes();
217 public Collection<? extends GroupingDefinition> getGroupings() {
218 return notification.getGroupings();
222 public Optional<DataSchemaNode> findDataChildByName(final QName name) {
223 return Optional.ofNullable(mapNodes.get(requireNonNull(name)));
228 public boolean isAddedByUses() {
229 //FIXME: reference to https://bugs.opendaylight.org/show_bug.cgi?id=6897
234 public Collection<? extends ActionDefinition> getActions() {
235 return ImmutableSet.of();