data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/ListNodeDataWithSchema.java

   1 /*
   2  * Copyright (c) 2016 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.util;
   9
  10 import java.io.IOException;
  11 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  12 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter.MetadataExtension;
  13 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  14
  15 /**
  16  * Utility class used for tracking parser state as needed by a StAX-like parser.
  17  * This class is to be used only by respective XML and JSON parsers in yang-data-codec-xml and yang-data-codec-gson.
  18  *
  19  * <p>
  20  * Represents a YANG list node.
  21  */
  22 public final class ListNodeDataWithSchema extends CompositeNodeDataWithSchema<ListSchemaNode>
  23         implements MultipleEntryDataWithSchema<ListEntryNodeDataWithSchema> {
  24     ListNodeDataWithSchema(final ListSchemaNode schema) {
  25         super(schema);
  26     }
  27
  28     @Override
  29     public void write(final NormalizedNodeStreamWriter writer, final MetadataExtension metaWriter) throws IOException {
  30         final ListSchemaNode schema = getSchema();
  31         writer.nextDataSchemaNode(schema);
  32         if (schema.getKeyDefinition().isEmpty()) {
  33             writer.startUnkeyedList(provideNodeIdentifier(), childSizeHint());
  34         } else if (schema.isUserOrdered()) {
  35             writer.startOrderedMapNode(provideNodeIdentifier(), childSizeHint());
  36         } else {
  37             writer.startMapNode(provideNodeIdentifier(), childSizeHint());
  38         }
  39         super.write(writer, metaWriter);
  40         writer.endNode();
  41     }
  42
  43     @Override
  44     public ListEntryNodeDataWithSchema newChildEntry() {
  45         final ListEntryNodeDataWithSchema child = ListEntryNodeDataWithSchema.forSchema(getSchema());
  46         addChild(child);
  47         return child;
  48     }
  49 }