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

   1 /*
   2  * Copyright (c) 2013 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 javax.xml.transform.dom.DOMSource;
  11 import org.opendaylight.yangtools.odlext.model.api.YangModeledAnyxmlSchemaNode;
  12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  16 import org.opendaylight.yangtools.yang.data.api.schema.AnydataNode;
  17 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  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.DOMSourceAnyxmlNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  23 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
  30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnyXmlNodeBuilder;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnyXmlNodeSchemaAwareBuilder;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnydataNodeBuilder;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeSchemaAwareBuilder;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeSchemaAwareBuilder;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeSchemaAwareBuilder;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeSchemaAwareBuilder;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeSchemaAwareBuilder;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeSchemaAwareBuilder;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeSchemaAwareBuilder;
  51 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  52 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeSchemaAwareBuilder;
  53 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeBuilder;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeSchemaAwareBuilder;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeSchemaAwareBuilder;
  57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
  58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
  59 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableYangModeledAnyXmlNodeBuilder;
  60 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
  61 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  62 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  63 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  64 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  65 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  66 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  67
  68 public final class Builders {
  69     private Builders() {
  70         // Hidden on purpose
  71     }
  72
  73     public static <T> NormalizedNodeBuilder<NodeIdentifier, T, LeafNode<T>> leafBuilder() {
  74         return ImmutableLeafNodeBuilder.create();
  75     }
  76
  77     @Deprecated(since = "6.0.7", forRemoval = true)
  78     public static <T> NormalizedNodeBuilder<NodeIdentifier, T, LeafNode<T>> leafBuilder(
  79             final LeafSchemaNode schema) {
  80         return ImmutableLeafNodeSchemaAwareBuilder.create(schema);
  81     }
  82
  83     public static <T> NormalizedNodeBuilder<NodeWithValue, T, LeafSetEntryNode<T>> leafSetEntryBuilder() {
  84         return ImmutableLeafSetEntryNodeBuilder.create();
  85     }
  86
  87     @Deprecated(since = "6.0.7", forRemoval = true)
  88     public static <T> NormalizedNodeBuilder<NodeWithValue, T, LeafSetEntryNode<T>> leafSetEntryBuilder(
  89             final LeafListSchemaNode schema) {
  90         return ImmutableLeafSetEntryNodeSchemaAwareBuilder.create(schema);
  91     }
  92
  93     public static NormalizedNodeBuilder<NodeIdentifier, DOMSource, DOMSourceAnyxmlNode> anyXmlBuilder() {
  94         return ImmutableAnyXmlNodeBuilder.create();
  95     }
  96
  97     @Deprecated(since = "6.0.7", forRemoval = true)
  98     public static NormalizedNodeBuilder<NodeIdentifier, DOMSource, DOMSourceAnyxmlNode> anyXmlBuilder(
  99             final AnyxmlSchemaNode schema) {
 100         return ImmutableAnyXmlNodeSchemaAwareBuilder.create(schema);
 101     }
 102
 103     @Deprecated(since = "6.0.7", forRemoval = true)
 104     public static DataContainerNodeBuilder<NodeIdentifier, YangModeledAnyXmlNode> yangModeledAnyXmlBuilder(
 105             final YangModeledAnyxmlSchemaNode schema) {
 106         return ImmutableYangModeledAnyXmlNodeBuilder.create(schema);
 107     }
 108
 109     public static <T> NormalizedNodeBuilder<NodeIdentifier, T, AnydataNode<T>> anydataBuilder(
 110             final Class<T> objectModel) {
 111         return ImmutableAnydataNodeBuilder.create(objectModel);
 112     }
 113
 114     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> orderedLeafSetBuilder() {
 115         return ImmutableOrderedLeafSetNodeBuilder.create();
 116     }
 117
 118     @Deprecated(since = "6.0.7", forRemoval = true)
 119     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> orderedLeafSetBuilder(final LeafListSchemaNode schema) {
 120         return ImmutableOrderedLeafSetNodeSchemaAwareBuilder.create(schema);
 121     }
 122
 123     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> leafSetBuilder() {
 124         return ImmutableLeafSetNodeBuilder.create();
 125     }
 126
 127     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> leafSetBuilder(final LeafSetNode<T> node) {
 128         return ImmutableLeafSetNodeBuilder.create(node);
 129     }
 130
 131     @Deprecated(since = "6.0.7", forRemoval = true)
 132     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> leafSetBuilder(final LeafListSchemaNode schema) {
 133         return ImmutableLeafSetNodeSchemaAwareBuilder.create(schema);
 134     }
 135
 136     @Deprecated(since = "6.0.7", forRemoval = true)
 137     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> leafSetBuilder(final LeafListSchemaNode schema,
 138             final LeafSetNode<T> node) {
 139         return ImmutableLeafSetNodeSchemaAwareBuilder.create(schema, node);
 140     }
 141
 142     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder() {
 143         return ImmutableContainerNodeBuilder.create();
 144     }
 145
 146     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder(
 147             final ContainerNode node) {
 148         return ImmutableContainerNodeBuilder.create(node);
 149     }
 150
 151     @Deprecated(since = "6.0.7", forRemoval = true)
 152     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder(final ContainerLike schema) {
 153         return ImmutableContainerNodeSchemaAwareBuilder.create(schema);
 154     }
 155
 156     @Deprecated(since = "6.0.7", forRemoval = true)
 157     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder(final ContainerLike schema,
 158             final ContainerNode node) {
 159         return ImmutableContainerNodeSchemaAwareBuilder.create(schema, node);
 160     }
 161
 162     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder() {
 163         return ImmutableMapEntryNodeBuilder.create();
 164     }
 165
 166     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder(
 167             final MapEntryNode mapEntryNode) {
 168         return ImmutableMapEntryNodeBuilder.create(mapEntryNode);
 169     }
 170
 171     @Deprecated(since = "6.0.7", forRemoval = true)
 172     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder(
 173             final ListSchemaNode schema) {
 174         return ImmutableMapEntryNodeSchemaAwareBuilder.create(schema);
 175     }
 176
 177     public static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> orderedMapBuilder() {
 178         return ImmutableOrderedMapNodeBuilder.create();
 179     }
 180
 181     public static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> orderedMapBuilder(final ListSchemaNode schema) {
 182         return ImmutableOrderedMapNodeSchemaAwareBuilder.create(schema);
 183     }
 184
 185     public static CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> unkeyedListBuilder() {
 186         return ImmutableUnkeyedListNodeBuilder.create();
 187     }
 188
 189     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder() {
 190         return ImmutableMapNodeBuilder.create();
 191     }
 192
 193     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder(final MapNode node) {
 194         return ImmutableMapNodeBuilder.create(node);
 195     }
 196
 197     @Deprecated(since = "6.0.7", forRemoval = true)
 198     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder(final ListSchemaNode schema) {
 199         return ImmutableMapNodeSchemaAwareBuilder.create(schema);
 200     }
 201
 202     @Deprecated(since = "6.0.7", forRemoval = true)
 203     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder(final ListSchemaNode schema,
 204             final MapNode node) {
 205         return ImmutableMapNodeSchemaAwareBuilder.create(schema, node);
 206     }
 207
 208     public static DataContainerNodeBuilder<AugmentationIdentifier, AugmentationNode> augmentationBuilder() {
 209         return ImmutableAugmentationNodeBuilder.create();
 210     }
 211
 212     @Deprecated(since = "6.0.7", forRemoval = true)
 213     public static DataContainerNodeBuilder<AugmentationIdentifier, AugmentationNode> augmentationBuilder(
 214             final AugmentationSchemaNode schema) {
 215         return ImmutableAugmentationNodeSchemaAwareBuilder.create(schema);
 216     }
 217
 218     public static DataContainerNodeBuilder<NodeIdentifier, ChoiceNode> choiceBuilder() {
 219         return ImmutableChoiceNodeBuilder.create();
 220     }
 221
 222     @Deprecated(since = "6.0.7", forRemoval = true)
 223     public static DataContainerNodeBuilder<NodeIdentifier, ChoiceNode> choiceBuilder(final ChoiceSchemaNode schema) {
 224         return ImmutableChoiceNodeSchemaAwareBuilder.create(schema);
 225     }
 226
 227     public static DataContainerNodeBuilder<NodeIdentifier, UnkeyedListEntryNode> unkeyedListEntryBuilder() {
 228         return ImmutableUnkeyedListEntryNodeBuilder.create();
 229     }
 230 }