openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/common/ParametrizedConvertor.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
   9 package org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common;
  10
  11 /**
  12  * Converts OpenflowJava to MDSal model and vice versa
  13  *
  14  * @param <FROM> type of source
  15  * @param <TO>   type of result
  16  * @param <DATA>   type of convertor data
  17  */
  18 public interface ParametrizedConvertor<FROM, TO, DATA extends ConvertorData> {
  19
  20     /**
  21      * Gets type of convertor, used in
  22      * {@link org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager}.
  23      *
  24      * @return the type of convertor
  25      */
  26     Class<?> getType();
  27
  28     /**
  29      * Converts source to result
  30      *
  31      * @param source source
  32      * @param data   convertor data
  33      * @return converted source
  34      */
  35     TO convert(FROM source, DATA data);
  36 }