7d9d380f36c2bed06a38acc3de43cae0ee8a61b3
[bgpcep.git] / bgp / evpn / src / main / java / org / opendaylight / protocol / bgp / evpn / spi / EvpnSerializer.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.protocol.bgp.evpn.spi;
10
11 import io.netty.buffer.ByteBuf;
12 import javax.annotation.Nonnull;
13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev171213.evpn.EvpnChoice;
14 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
15
16 public interface EvpnSerializer {
17     /**
18      * @param evpn   Evpn
19      * @param buffer Encode common Evpn parts to output buffer
20      * @return Encode Evpn to output buffer
21      */
22     @Nonnull
23     ByteBuf serializeEvpn(@Nonnull EvpnChoice evpn, @Nonnull ByteBuf buffer);
24
25     /**
26      * Serialize Evpn
27      *
28      * @param evpn ChoiceNode containing Evpn
29      * @return Evpn
30      */
31     @Nonnull
32     EvpnChoice serializeEvpnModel(@Nonnull ContainerNode evpn);
33
34     /**
35      * create Route key from Evpn model
36      *
37      * @param evpn ContainerNode containing Evpn
38      * @return Evpn
39      */
40     @Nonnull
41     EvpnChoice createRouteKey(@Nonnull ContainerNode evpn);
42 }