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.MapEntryNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.SystemLeafSetNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.UserLeafSetNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.UserMapNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnyXmlNodeBuilder;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnyXmlNodeSchemaAwareBuilder;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnydataNodeBuilder;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeSchemaAwareBuilder;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeSchemaAwareBuilder;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeSchemaAwareBuilder;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeSchemaAwareBuilder;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeSchemaAwareBuilder;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeSchemaAwareBuilder;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
  51 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeSchemaAwareBuilder;
  52 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  53 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeSchemaAwareBuilder;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUserLeafSetNodeBuilder;
  57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUserLeafSetNodeSchemaAwareBuilder;
  58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUserMapNodeBuilder;
  59 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUserMapNodeSchemaAwareBuilder;
  60 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableYangModeledAnyXmlNodeBuilder;
  61 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
  62 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  63 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  64 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  65 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  66 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  67 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  68
  69 public final class Builders {
  70     private Builders() {
  71         // Hidden on purpose
  72     }
  73
  74     public static <T> NormalizedNodeBuilder<NodeIdentifier, T, LeafNode<T>> leafBuilder() {
  75         return ImmutableLeafNodeBuilder.create();
  76     }
  77
  78     public static <T> NormalizedNodeBuilder<NodeIdentifier, T, LeafNode<T>> leafBuilder(
  79             final LeafSchemaNode schema) {
  80         return ImmutableLeafNodeSchemaAwareBuilder.create(schema);
  81     }
  82
  83     // FIXME: 7.0.0: add generic arguments
  84     public static <T> NormalizedNodeBuilder<NodeWithValue, T, LeafSetEntryNode<T>> leafSetEntryBuilder() {
  85         return ImmutableLeafSetEntryNodeBuilder.create();
  86     }
  87
  88     // FIXME: 7.0.0: add generic arguments
  89     public static <T> NormalizedNodeBuilder<NodeWithValue, T, LeafSetEntryNode<T>> leafSetEntryBuilder(
  90             final LeafListSchemaNode schema) {
  91         return ImmutableLeafSetEntryNodeSchemaAwareBuilder.create(schema);
  92     }
  93
  94     public static NormalizedNodeBuilder<NodeIdentifier, DOMSource, DOMSourceAnyxmlNode> anyXmlBuilder() {
  95         return ImmutableAnyXmlNodeBuilder.create();
  96     }
  97
  98     public static NormalizedNodeBuilder<NodeIdentifier, DOMSource, DOMSourceAnyxmlNode> anyXmlBuilder(
  99             final AnyxmlSchemaNode schema) {
 100         return ImmutableAnyXmlNodeSchemaAwareBuilder.create(schema);
 101     }
 102
 103     public static DataContainerNodeBuilder<NodeIdentifier, YangModeledAnyXmlNode> yangModeledAnyXmlBuilder(
 104             final YangModeledAnyxmlSchemaNode schema) {
 105         return ImmutableYangModeledAnyXmlNodeBuilder.create(schema);
 106     }
 107
 108     public static <T> NormalizedNodeBuilder<NodeIdentifier, T, AnydataNode<T>> anydataBuilder(
 109             final Class<T> objectModel) {
 110         return ImmutableAnydataNodeBuilder.create(objectModel);
 111     }
 112
 113     public static <T> ListNodeBuilder<T, UserLeafSetNode<T>> orderedLeafSetBuilder() {
 114         return ImmutableUserLeafSetNodeBuilder.create();
 115     }
 116
 117     public static <T> ListNodeBuilder<T, UserLeafSetNode<T>> orderedLeafSetBuilder(final LeafListSchemaNode schema) {
 118         return ImmutableUserLeafSetNodeSchemaAwareBuilder.create(schema);
 119     }
 120
 121     public static <T> ListNodeBuilder<T, UserLeafSetNode<T>> orderedLeafSetBuilder(final LeafListSchemaNode schema,
 122             final UserLeafSetNode<T> node) {
 123         return ImmutableUserLeafSetNodeSchemaAwareBuilder.create(schema, node);
 124     }
 125
 126     public static <T> ListNodeBuilder<T, SystemLeafSetNode<T>> leafSetBuilder() {
 127         return ImmutableLeafSetNodeBuilder.create();
 128     }
 129
 130     public static <T> ListNodeBuilder<T, SystemLeafSetNode<T>> leafSetBuilder(final SystemLeafSetNode<T> node) {
 131         return ImmutableLeafSetNodeBuilder.create(node);
 132     }
 133
 134     public static <T> ListNodeBuilder<T, SystemLeafSetNode<T>> leafSetBuilder(final LeafListSchemaNode schema) {
 135         return ImmutableLeafSetNodeSchemaAwareBuilder.create(schema);
 136     }
 137
 138     public static <T> ListNodeBuilder<T, SystemLeafSetNode<T>> leafSetBuilder(final LeafListSchemaNode schema,
 139             final SystemLeafSetNode<T> node) {
 140         return ImmutableLeafSetNodeSchemaAwareBuilder.create(schema, node);
 141     }
 142
 143     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder() {
 144         return ImmutableContainerNodeBuilder.create();
 145     }
 146
 147     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder(
 148             final ContainerNode node) {
 149         return ImmutableContainerNodeBuilder.create(node);
 150     }
 151
 152     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder(final ContainerLike schema) {
 153         return ImmutableContainerNodeSchemaAwareBuilder.create(schema);
 154     }
 155
 156     public static DataContainerNodeBuilder<NodeIdentifier, ContainerNode> containerBuilder(final ContainerLike schema,
 157             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, UserMapNode> orderedMapBuilder() {
 176         return ImmutableUserMapNodeBuilder.create();
 177     }
 178
 179     public static CollectionNodeBuilder<MapEntryNode, UserMapNode> orderedMapBuilder(final ListSchemaNode schema) {
 180         return ImmutableUserMapNodeSchemaAwareBuilder.create(schema);
 181     }
 182
 183     public static CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> unkeyedListBuilder() {
 184         return ImmutableUnkeyedListNodeBuilder.create();
 185     }
 186
 187     public static CollectionNodeBuilder<MapEntryNode, SystemMapNode> mapBuilder() {
 188         return ImmutableMapNodeBuilder.create();
 189     }
 190
 191     public static CollectionNodeBuilder<MapEntryNode, SystemMapNode> mapBuilder(final SystemMapNode node) {
 192         return ImmutableMapNodeBuilder.create(node);
 193     }
 194
 195     public static CollectionNodeBuilder<MapEntryNode, SystemMapNode> mapBuilder(final ListSchemaNode schema) {
 196         return ImmutableMapNodeSchemaAwareBuilder.create(schema);
 197     }
 198
 199     public static CollectionNodeBuilder<MapEntryNode, SystemMapNode> mapBuilder(final ListSchemaNode schema,
 200             final SystemMapNode 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 }