Create common parent for extensions families
[bgpcep.git] / bgp / extensions / 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.rev180329.evpn.EvpnChoice;
14 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
15
16 public interface EvpnSerializer {
17     /**
18      * Serialize Evpn.
19      *
20      * @param evpn   Evpn
21      * @param buffer Encode common Evpn parts to output buffer
22      * @return Encode Evpn to output buffer
23      */
24     @Nonnull
25     ByteBuf serializeEvpn(@Nonnull EvpnChoice evpn, @Nonnull ByteBuf buffer);
26
27     /**
28      * Serialize Evpn Model.
29      *
30      * @param evpn ChoiceNode containing Evpn
31      * @return Evpn
32      */
33     @Nonnull
34     EvpnChoice serializeEvpnModel(@Nonnull ContainerNode evpn);
35
36     /**
37      * create Route key from Evpn model.
38      *
39      * @param evpn ContainerNode containing Evpn
40      * @return Evpn
41      */
42     @Nonnull
43     EvpnChoice createRouteKey(@Nonnull ContainerNode evpn);
44 }