yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/transform/base/parser/ListNodeBaseParser.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.transform.base.parser;
   9
  10 import java.util.Collections;
  11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  12 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  13 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  14 import org.opendaylight.yangtools.yang.data.impl.schema.transform.ToNormalizedNodeParser;
  15 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  16
  17 /**
  18  * Abstract(base) parser for ListNodes (MapNode, UnkeyedListNode), parses elements of type E.
  19  *
  20  * @param <E>
  21  *            type of elements to be parsed
  22  */
  23 public abstract class ListNodeBaseParser<E, N extends NormalizedNode<?, ?>, O extends NormalizedNode<YangInstanceIdentifier.NodeIdentifier, ?>, S extends ListSchemaNode>
  24         implements ToNormalizedNodeParser<E, O, S> {
  25
  26     @Override
  27     public final O parse(Iterable<E> childNodes, S schema) {
  28         CollectionNodeBuilder<N, O> listBuilder = provideBuilder(schema);
  29         for (E childNode : childNodes) {
  30             N listChild = getListEntryNodeParser().parse(Collections.singletonList(childNode), schema);
  31             listBuilder.withChild(listChild);
  32         }
  33
  34         return listBuilder.build();
  35     }
  36
  37     /**
  38      *
  39      * @return parser for inner ListEntryNodes used to parse every entry of ListNode, might be the same instance in case
  40      *         its immutable
  41      */
  42     protected abstract ToNormalizedNodeParser<E, N, S> getListEntryNodeParser();
  43
  44     /**
  45      *
  46      * @return prepares builder which will contain entries of list according to concrete list type
  47      */
  48     protected abstract CollectionNodeBuilder<N, O> provideBuilder(S schema);
  49 }