yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNodes.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.data.impl.schema;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.util.Map.Entry;
  12 import java.util.Optional;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  18 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  23 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  24 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  25 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  26 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
  27 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  28 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
  29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
  30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33
  34 public final class ImmutableNodes {
  35
  36     private ImmutableNodes() {
  37         throw new UnsupportedOperationException("Utilities class should not be instantiated");
  38     }
  39
  40     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapNodeBuilder() {
  41         return ImmutableMapNodeBuilder.create();
  42     }
  43
  44     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapNodeBuilder(final QName name) {
  45         return mapNodeBuilder(NodeIdentifier.create(name));
  46     }
  47
  48     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapNodeBuilder(final NodeIdentifier name) {
  49         return ImmutableMapNodeBuilder.create().withNodeIdentifier(name);
  50     }
  51
  52     /**
  53      * Construct immutable leaf node.
  54      *
  55      * @param name Identifier of leaf node
  56      * @param value Value of leaf node
  57      * @param <T> Type of leaf node value
  58      * @return Leaf node with supplied identifier and value
  59      */
  60     public static <T> LeafNode<T> leafNode(final NodeIdentifier name, final T value) {
  61         return ImmutableLeafNodeBuilder.<T>create()
  62                 .withNodeIdentifier(name)
  63                 .withValue(value)
  64                 .build();
  65     }
  66
  67     /**
  68      * Construct immutable leaf node.
  69      *
  70      * @param name QName which will be used as node identifier
  71      * @param value Value of leaf node.
  72      * @param <T> Type of leaf node value
  73      * @return Leaf node with supplied identifier and value
  74      */
  75     public static <T> LeafNode<T> leafNode(final QName name, final T value) {
  76         return leafNode(NodeIdentifier.create(name), value);
  77     }
  78
  79     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder(
  80             final QName nodeName, final QName keyName, final Object keyValue) {
  81         return ImmutableMapEntryNodeBuilder.create()
  82                 .withNodeIdentifier(new NodeIdentifierWithPredicates(nodeName, keyName, keyValue))
  83                 .withChild(leafNode(keyName, keyValue));
  84     }
  85
  86     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder() {
  87         return ImmutableMapEntryNodeBuilder.create();
  88     }
  89
  90     public static MapEntryNode mapEntry(final QName nodeName,final QName keyName,final Object keyValue) {
  91         return mapEntryBuilder(nodeName, keyName, keyValue).build();
  92     }
  93
  94     public static ContainerNode containerNode(final QName name) {
  95         return ImmutableContainerNodeBuilder.create().withNodeIdentifier(NodeIdentifier.create(name)).build();
  96     }
  97
  98     public static ChoiceNode choiceNode(final QName name) {
  99         return ImmutableChoiceNodeBuilder.create().withNodeIdentifier(NodeIdentifier.create(name)).build();
 100     }
 101
 102     /**
 103      * Convert YangInstanceIdentifier into a normalized node structure.
 104      *
 105      * @param ctx schema context to used during serialization
 106      * @param id instance identifier to convert to node structure starting from root
 107      * @return serialized normalized node for provided instance Id
 108      */
 109     public static NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id) {
 110         return fromInstanceId(ctx, id, Optional.empty(), Optional.empty());
 111     }
 112
 113     /**
 114      * Convert YangInstanceIdentifier into a normalized node structure.
 115      *
 116      * @param ctx schema context to used during serialization
 117      * @param id instance identifier to convert to node structure starting from root
 118      * @param deepestElement pre-built deepest child that will be inserted at the last path argument of provided
 119      *                       instance identifier
 120      * @return serialized normalized node for provided instance Id with overridden last child.
 121      */
 122     public static NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id,
 123             final NormalizedNode<?, ?> deepestElement) {
 124         return fromInstanceId(ctx, id, Optional.of(deepestElement), Optional.empty());
 125     }
 126
 127     /**
 128      * Convert YangInstanceIdentifier into a normalized node structure.
 129      *
 130      * @param ctx schema context to used during serialization
 131      * @param id instance identifier to convert to node structure starting from root
 132      * @param deepestElement pre-built deepest child that will be inserted at the last path argument of provided
 133      *                       instance identifier
 134      * @param operation modify operation attribute to be added to the deepest child. QName is the operation attribute
 135      *                  key and ModifyAction is the value.
 136      * @return serialized normalized node for provided instance Id with (optionally) overridden last child
 137      *         and (optionally) marked with specific operation attribute.
 138      */
 139     public static NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id,
 140             final Optional<NormalizedNode<?, ?>> deepestElement, final Optional<Entry<QName, ModifyAction>> operation) {
 141         final YangInstanceIdentifier.PathArgument topLevelElement = id.getPathArguments().get(0);
 142         final DataSchemaNode dataChildByName = ctx.getDataChildByName(topLevelElement.getNodeType());
 143         Preconditions.checkNotNull(dataChildByName,
 144             "Cannot find %s node in schema context. Instance identifier has to start from root", topLevelElement);
 145         final InstanceIdToNodes<?> instanceIdToNodes = InstanceIdToNodes.fromSchemaAndQNameChecked(ctx,
 146             topLevelElement.getNodeType());
 147         return instanceIdToNodes.create(id, deepestElement, operation);
 148     }
 149 }