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.Optional;
  11 import com.google.common.base.Preconditions;
  12 import java.util.Map;
  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 ImmutableMapNodeBuilder.create().withNodeIdentifier(NodeIdentifier.create(name));
  46     }
  47
  48     /**
  49      * Construct immutable leaf node
  50      *
  51      * @param name Identifier of leaf node
  52      * @param value Value of leaf node
  53      * @param <T> Type of leaf node value
  54      * @return Leaf node with supplied identifier and value
  55      */
  56     public static <T> LeafNode<T> leafNode(final NodeIdentifier name, final T value) {
  57         return ImmutableLeafNodeBuilder.<T>create()
  58                 .withNodeIdentifier(name)
  59                 .withValue(value)
  60                 .build();
  61     }
  62
  63     /**
  64      * Construct immutable leaf node
  65      *
  66      * @param name QName which will be used as node identifier
  67      * @param value Value of leaf node.
  68      * @param <T> Type of leaf node value
  69      * @return Leaf node with supplied identifier and value
  70      */
  71     public static <T> LeafNode<T> leafNode(final QName name,final T value) {
  72         return leafNode(NodeIdentifier.create(name), value);
  73     }
  74
  75     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder(final QName nodeName, final QName keyName, final Object keyValue) {
  76         return ImmutableMapEntryNodeBuilder.create()
  77                 .withNodeIdentifier(new NodeIdentifierWithPredicates(nodeName, keyName, keyValue))
  78                 .withChild(leafNode(keyName, keyValue));
  79     }
  80
  81     public static MapEntryNode mapEntry(final QName nodeName,final QName keyName,final Object keyValue) {
  82         return mapEntryBuilder(nodeName, keyName, keyValue).build();
  83     }
  84
  85     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder() {
  86         return ImmutableMapEntryNodeBuilder.create();
  87     }
  88
  89     public static ContainerNode containerNode(final QName name) {
  90         return ImmutableContainerNodeBuilder.create().withNodeIdentifier(NodeIdentifier.create(name)).build();
  91     }
  92
  93     public static ChoiceNode choiceNode(final QName name) {
  94         return ImmutableChoiceNodeBuilder.create().withNodeIdentifier(NodeIdentifier.create(name)).build();
  95     }
  96
  97     /**
  98      * Convert YangInstanceIdentifier into a normalized node structure
  99      *
 100      * @param ctx schema context to used during serialization
 101      * @param id instance identifier to convert to node structure starting from root
 102      * @return serialized normalized node for provided instance Id
 103      */
 104     public static NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id) {
 105         return fromInstanceId(ctx, id, Optional.<NormalizedNode<?, ?>>absent(), Optional.<Map.Entry<QName, ModifyAction>>absent());
 106     }
 107
 108     /**
 109      * Convert YangInstanceIdentifier into a normalized node structure
 110      *
 111      * @param ctx schema context to used during serialization
 112      * @param id instance identifier to convert to node structure starting from root
 113      * @param deepestElement pre-built deepest child that will be inserted at the last path argument of provided instance Id
 114      * @return serialized normalized node for provided instance Id with overridden last child.
 115      */
 116     public static NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id, final NormalizedNode<?, ?> deepestElement) {
 117         return fromInstanceId(ctx, id, Optional.<NormalizedNode<?, ?>>of(deepestElement), Optional.<Map.Entry<QName, ModifyAction>>absent());
 118     }
 119
 120     /**
 121      * Convert YangInstanceIdentifier into a normalized node structure
 122      *
 123      * @param ctx schema context to used during serialization
 124      * @param id instance identifier to convert to node structure starting from root
 125      * @param deepestElement pre-built deepest child that will be inserted at the last path argument of provided instance Id
 126      * @param operation modify operation attribute to be added to the deepest child. QName is the operation attribute key and ModifyAction is the value.
 127      * @return serialized normalized node for provided instance Id with (optionally) overridden last child and (optionally) marked with specific operation attribute.
 128      */
 129     public static NormalizedNode<?, ?> fromInstanceId(final SchemaContext ctx, final YangInstanceIdentifier id, final Optional<NormalizedNode<?, ?>> deepestElement, final Optional<Map.Entry<QName, ModifyAction>> operation) {
 130         Preconditions.checkNotNull(ctx);
 131         Preconditions.checkNotNull(id);
 132         final YangInstanceIdentifier.PathArgument topLevelElement = id.getPathArguments().get(0);
 133         final DataSchemaNode dataChildByName = ctx.getDataChildByName(topLevelElement.getNodeType());
 134         Preconditions.checkNotNull(dataChildByName, "Cannot find %s node in schema context. Instance identifier has to start from root", topLevelElement);
 135         final InstanceIdToNodes<?> instanceIdToNodes = InstanceIdToNodes.fromSchemaAndQNameChecked(ctx, topLevelElement.getNodeType());
 136         return instanceIdToNodes.create(id, deepestElement, operation);
 137     }
 138 }