openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ListDeserializer.java

   1 /*
   2  * Copyright (c) 2013 Pantheon Technologies s.r.o. 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
   9 package org.opendaylight.openflowjava.protocol.impl.util;
  10
  11 import io.netty.buffer.ByteBuf;
  12
  13 import java.util.ArrayList;
  14 import java.util.List;
  15
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
  17 import org.opendaylight.openflowjava.protocol.api.extensibility.HeaderDeserializer;
  18 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  19 import org.opendaylight.yangtools.yang.binding.DataObject;
  20
  21 /**
  22  * @author michal.polkorab
  23  *
  24  */
  25 public final class ListDeserializer {
  26
  27     private ListDeserializer() {
  28         throw new UnsupportedOperationException("Utility class shouldn't be instantiated");
  29     }
  30
  31     /**
  32      * Deserializes items into list
  33      * @param version openflow wire version
  34      * @param length length of list in ByteBuf (bytes)
  35      * @param input input buffer
  36      * @param keyMaker creates keys for deserializer lookup
  37      * @param registry stores deserializers
  38      * @return list of items
  39      */
  40     public static <E extends DataObject> List<E> deserializeList(short version, int length,
  41             ByteBuf input, CodeKeyMaker keyMaker, DeserializerRegistry registry) {
  42         List<E> items = null;
  43         if (input.readableBytes() > 0) {
  44             items = new ArrayList<>();
  45             int startIndex = input.readerIndex();
  46             while ((input.readerIndex() - startIndex) < length){
  47                 OFDeserializer<E> deserializer = registry.getDeserializer(keyMaker.make(input));
  48                 E item = deserializer.deserialize(input);
  49                 items.add(item);
  50             }
  51         }
  52         return items;
  53     }
  54
  55     /**
  56      * Deserializes headers of items into list
  57      * @param version openflow wire version
  58      * @param length length of list in ByteBuf (bytes)
  59      * @param input input buffer
  60      * @param keyMaker creates keys for deserializer lookup
  61      * @param registry stores deserializers
  62      * @return list of items
  63      */
  64     public static <E extends DataObject> List<E> deserializeHeaders(short version, int length,
  65             ByteBuf input, CodeKeyMaker keyMaker, DeserializerRegistry registry) {
  66         List<E> items = null;
  67         if (input.readableBytes() > 0) {
  68             items = new ArrayList<>();
  69             int startIndex = input.readerIndex();
  70             while ((input.readerIndex() - startIndex) < length){
  71                 HeaderDeserializer<E> deserializer = registry.getDeserializer(keyMaker.make(input));
  72                 E item = deserializer.deserializeHeader(input);
  73                 items.add(item);
  74             }
  75         }
  76         return items;
  77     }
  78 }