extension/openflowplugin-extension-api/src/main/java/org/opendaylight/openflowplugin/extension/api/ConverterMessageToOFJava.java

   1 /*
   2  * Copyright (c) 2015 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.extension.api;
   9
  10 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
  11 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.ExperimenterId;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.experimenter.core.message.ExperimenterMessageOfChoice;
  13 import org.opendaylight.yangtools.yang.binding.DataContainer;
  14
  15 /**
  16  * convert message from MD-SAL model into OFJava-API model
  17  *
  18  * @param <F> input message model - MD-SAL model
  19  * @param <T> output message model - OFJava-API
  20  */
  21 public interface ConverterMessageToOFJava<F extends ExperimenterMessageOfChoice, T extends DataContainer> {
  22
  23     /**
  24      * @param experimenterMessageCase where is vendor's augmentation
  25      * @return message converted to OFJava-API
  26      */
  27     T convert(F experimenterMessageCase) throws ConversionException;
  28
  29     /**
  30      * @return corresponding experimenter id (vendor id)
  31      */
  32     ExperimenterId getExperimenterId();
  33
  34     /**
  35      * @return corresponding experimenter message type
  36      */
  37     long getType();
  38 }