Provide Add Path support for all AFI/SAFI
[bgpcep.git] / bgp / path-selection-mode / src / main / java / org / opendaylight / protocol / bgp / mode / api / PathSelectionMode.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 package org.opendaylight.protocol.bgp.mode.api;
9
10 import javax.annotation.Nonnull;
11
12 public interface PathSelectionMode extends AutoCloseable {
13     /**
14      * Create a RouteEntry.
15      *
16      * @param isComplex true if is complex
17      * @return ComplexRouteEntry if is complex otherwise a SimpleRouteEntry
18      * @deprecated All routes are complex.
19      */
20     @Deprecated
21     default @Nonnull RouteEntry createRouteEntry(boolean isComplex) {
22         return createRouteEntry();
23     }
24
25     /**
26      * Create a RouteEntry.
27      *
28      * @return ComplexRouteEntry if is complex otherwise a SimpleRouteEntry
29      */
30     @Nonnull
31     RouteEntry createRouteEntry();
32 }