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 com.google.common.annotations.Beta;
  11 import javax.xml.transform.dom.DOMSource;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.odlext.model.api.YangModeledAnyXmlSchemaNode;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  18 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  23 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.OpaqueAnydataNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.opaque.OpaqueData;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnyXmlNodeBuilder;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnyXmlNodeSchemaAwareBuilder;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeSchemaAwareBuilder;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeSchemaAwareBuilder;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeSchemaAwareBuilder;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeSchemaAwareBuilder;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeSchemaAwareBuilder;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeSchemaAwareBuilder;
  51 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
  52 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeSchemaAwareBuilder;
  53 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeSchemaAwareBuilder;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOpaqueAnydataNodeBuilder;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeBuilder;
  57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeSchemaAwareBuilder;
  58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
  59 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeSchemaAwareBuilder;
  60 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
  61 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
  62 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableYangModeledAnyXmlNodeBuilder;
  63 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  64 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  65 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  66 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  67 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  68 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  69 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  70
  71 public final class Builders {
  72
  73     private Builders() {
  74         throw new UnsupportedOperationException("Utilities class should not be instantiated");
  75     }
  76
  77     public static <T> NormalizedNodeBuilder<NodeIdentifier, T, LeafNode<T>> leafBuilder() {
  78         return ImmutableLeafNodeBuilder.create();
  79     }
  80
  81     public static <T> NormalizedNodeBuilder<NodeIdentifier, T, LeafNode<T>> leafBuilder(
  82             final LeafSchemaNode schema) {
  83         return ImmutableLeafNodeSchemaAwareBuilder.create(schema);
  84     }
  85
  86     public static <T> NormalizedNodeBuilder<NodeWithValue, T, LeafSetEntryNode<T>> leafSetEntryBuilder() {
  87         return ImmutableLeafSetEntryNodeBuilder.create();
  88     }
  89
  90     public static <T> NormalizedNodeBuilder<NodeWithValue, T, LeafSetEntryNode<T>> leafSetEntryBuilder(
  91             final LeafListSchemaNode schema) {
  92         return ImmutableLeafSetEntryNodeSchemaAwareBuilder.create(schema);
  93     }
  94
  95     // FIXME: 5.0.0 <T> should not be here
  96     public static <T> NormalizedNodeBuilder<NodeIdentifier, DOMSource, AnyXmlNode> anyXmlBuilder() {
  97         return ImmutableAnyXmlNodeBuilder.create();
  98     }
  99
 100     // FIXME: 5.0.0 <T> should not be here
 101     public static <T> NormalizedNodeBuilder<NodeIdentifier, DOMSource, AnyXmlNode> anyXmlBuilder(
 102             final AnyXmlSchemaNode schema) {
 103         return ImmutableAnyXmlNodeSchemaAwareBuilder.create(schema);
 104     }
 105
 106     // FIXME: 5.0.0 <T> should not be here
 107     public static <T> DataContainerNodeBuilder<NodeIdentifier, YangModeledAnyXmlNode> yangModeledAnyXmlBuilder(
 108             final YangModeledAnyXmlSchemaNode schema) {
 109         return ImmutableYangModeledAnyXmlNodeBuilder.create(schema);
 110     }
 111
 112     @Beta
 113     public static @NonNull NormalizedNodeBuilder<NodeIdentifier, OpaqueData, OpaqueAnydataNode> opaqueAnydataBuilder() {
 114         return ImmutableOpaqueAnydataNodeBuilder.create();
 115     }
 116
 117     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> orderedLeafSetBuilder() {
 118         return ImmutableOrderedLeafSetNodeBuilder.create();
 119     }
 120
 121     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> orderedLeafSetBuilder(final LeafListSchemaNode schema) {
 122         return ImmutableOrderedLeafSetNodeSchemaAwareBuilder.create(schema);
 123     }
 124
 125     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> leafSetBuilder() {
 126         return ImmutableLeafSetNodeBuilder.create();
 127     }
 128
 129     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> leafSetBuilder(final LeafSetNode<T> node) {
 130         return ImmutableLeafSetNodeBuilder.create(node);
 131     }
 132
 133     public static <T> ListNodeBuilder<T, LeafSetEntryNode<T>> leafSetBuilder(final LeafListSchemaNode schema) {
 134         return ImmutableLeafSetNodeSchemaAwareBuilder.create(schema);
 135     }
 136
 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     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder(
 152             final ContainerSchemaNode schema) {
 153         return ImmutableContainerNodeSchemaAwareBuilder.create(schema);
 154     }
 155
 156     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder(
 157             final ContainerSchemaNode schema, final ContainerNode node) {
 158         return ImmutableContainerNodeSchemaAwareBuilder.create(schema, node);
 159     }
 160
 161     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder() {
 162         return ImmutableMapEntryNodeBuilder.create();
 163     }
 164
 165     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder(
 166             final MapEntryNode mapEntryNode) {
 167         return ImmutableMapEntryNodeBuilder.create(mapEntryNode);
 168     }
 169
 170     public static DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder(
 171             final ListSchemaNode schema) {
 172         return ImmutableMapEntryNodeSchemaAwareBuilder.create(schema);
 173     }
 174
 175     public static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> orderedMapBuilder() {
 176         return ImmutableOrderedMapNodeBuilder.create();
 177     }
 178
 179     public static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> orderedMapBuilder(final ListSchemaNode schema) {
 180         return ImmutableOrderedMapNodeSchemaAwareBuilder.create(schema);
 181     }
 182
 183     public static CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> unkeyedListBuilder() {
 184         return ImmutableUnkeyedListNodeBuilder.create();
 185     }
 186
 187     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder() {
 188         return ImmutableMapNodeBuilder.create();
 189     }
 190
 191     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder(final MapNode node) {
 192         return ImmutableMapNodeBuilder.create(node);
 193     }
 194
 195     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder(final ListSchemaNode schema) {
 196         return ImmutableMapNodeSchemaAwareBuilder.create(schema);
 197     }
 198
 199     public static CollectionNodeBuilder<MapEntryNode, MapNode> mapBuilder(final ListSchemaNode schema,
 200             final MapNode node) {
 201         return ImmutableMapNodeSchemaAwareBuilder.create(schema, node);
 202     }
 203
 204     public static DataContainerNodeBuilder<AugmentationIdentifier, AugmentationNode> augmentationBuilder() {
 205         return ImmutableAugmentationNodeBuilder.create();
 206     }
 207
 208     public static DataContainerNodeBuilder<AugmentationIdentifier, AugmentationNode> augmentationBuilder(
 209             final AugmentationSchemaNode schema) {
 210         return ImmutableAugmentationNodeSchemaAwareBuilder.create(schema);
 211     }
 212
 213     public static DataContainerNodeBuilder<NodeIdentifier, ChoiceNode> choiceBuilder() {
 214         return ImmutableChoiceNodeBuilder.create();
 215     }
 216
 217     public static DataContainerNodeBuilder<NodeIdentifier, ChoiceNode> choiceBuilder(final ChoiceSchemaNode schema) {
 218         return ImmutableChoiceNodeSchemaAwareBuilder.create(schema);
 219     }
 220
 221     public static DataContainerNodeBuilder<NodeIdentifier, UnkeyedListEntryNode> unkeyedListEntryBuilder() {
 222         return ImmutableUnkeyedListEntryNodeBuilder.create();
 223     }
 224 }