Fix checkstyle violations in openflowplugin extensions
[openflowplugin.git] / extension / openflowplugin-extension-api / src / main / java / org / opendaylight / openflowplugin / extension / api / ConvertorFromOFJava.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.extension.api;
9
10 import org.opendaylight.openflowplugin.extension.api.path.AugmentationPath;
11 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general.rev140714.general.extension.grouping.Extension;
12 import org.opendaylight.yangtools.yang.binding.Augmentation;
13 import org.opendaylight.yangtools.yang.binding.DataContainer;
14
15 /**
16  * Convert message from OFJava-API model into MD-SAL model.
17  *
18  * @param <F> input message model - OFJava-API
19  * @param <P> represents possible paths in yang schema for augmentations
20  */
21 public interface ConvertorFromOFJava<F extends DataContainer, P extends AugmentationPath> {
22
23     /**
24      * Convert OF model to MD-SAL model.
25      *
26      * @param input OF model
27      * @param path in yang schema where a converted value has to be augmented
28      * @return message converted to MD-SAL and its type
29      */
30     ExtensionAugment<? extends Augmentation<Extension>> convert(F input, P path);
31 }