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