openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/extension/ExtensionConverterProvider.java

   1 /**
   2  * Copyright (c) 2014 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.openflowplugin.openflow.md.core.extension;
   9
  10 import org.opendaylight.openflowjava.protocol.api.extensibility.MessageTypeKey;
  11 import org.opendaylight.openflowplugin.extension.api.ConverterExtensionKey;
  12 import org.opendaylight.openflowplugin.extension.api.ConvertorActionFromOFJava;
  13 import org.opendaylight.openflowplugin.extension.api.ConvertorActionToOFJava;
  14 import org.opendaylight.openflowplugin.extension.api.ConvertorFromOFJava;
  15 import org.opendaylight.openflowplugin.extension.api.ConvertorToOFJava;
  16 import org.opendaylight.openflowplugin.extension.api.TypeVersionKey;
  17 import org.opendaylight.openflowplugin.extension.api.path.AugmentationPath;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action;
  19 import org.opendaylight.yangtools.yang.binding.DataContainer;
  20
  21 /**
  22  *
  23  */
  24 public interface ExtensionConverterProvider {
  25
  26     /**
  27      * lookup converter
  28      * @param key
  29      * @return found converter
  30      */
  31     <FROM extends DataContainer, PATH extends AugmentationPath> ConvertorFromOFJava<FROM, PATH> getConverter(MessageTypeKey<?> key);
  32
  33     /**
  34      * lookup converter
  35      * @param key
  36      * @return found converter
  37      */
  38     <TO extends DataContainer> ConvertorToOFJava<TO> getConverter(ConverterExtensionKey<?> key);
  39
  40     /**
  41      * @param key
  42      * @return found converter
  43      */
  44     <FROM extends Action, TO extends DataContainer> ConvertorActionToOFJava<FROM, TO> getConverter(TypeVersionKey<FROM> key);
  45
  46     /**
  47      * lookup converter<br/>
  48      * TODO: this method should be compatible with {@link #getConverter(MessageTypeKey)} after matches are migrated to similar structure
  49      * @param key
  50      * @return found converter
  51      */
  52     <FROM extends DataContainer, PATH extends AugmentationPath> ConvertorActionFromOFJava<FROM, PATH> getActionConverter(MessageTypeKey<?> key);
  53 }