Bug 5540 - ConvertorManager base
[openflowplugin.git] / openflowplugin / src / main / java / org / opendaylight / openflowplugin / openflow / md / core / sal / convertor / common / Convertor.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  */
17 public interface Convertor<FROM, TO> {
18
19     /**
20      * Gets type of convertor, used in
21      * {@link org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager}.
22      *
23      * @return the type of convertor
24      */
25     Class<?> getType();
26
27     /**
28      * Converts source to result
29      *
30      * @param source source
31      * @return converted source
32      */
33     TO convert(FROM source);
34 }