Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 15 | */ |
tom | e348941 | 2014-08-29 02:30:38 -0700 | [diff] [blame] | 16 | package org.onlab.graph; |
| 17 | |
| 18 | import java.util.List; |
| 19 | |
| 20 | /** |
| 21 | * Representation of a path in a graph as a sequence of edges. Paths are |
| 22 | * assumed to be continuous, where adjacent edges must share a vertex. |
| 23 | * |
| 24 | * @param <V> vertex type |
| 25 | * @param <E> edge type |
| 26 | */ |
| 27 | public interface Path<V extends Vertex, E extends Edge<V>> extends Edge<V> { |
| 28 | |
| 29 | /** |
| 30 | * Returns the list of edges comprising the path. Adjacent edges will |
| 31 | * share the same vertex, meaning that a source of one edge, will be the |
| 32 | * same as the destination of the prior edge. |
| 33 | * |
| 34 | * @return list of path edges |
| 35 | */ |
| 36 | List<E> edges(); |
| 37 | |
| 38 | /** |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 39 | * Returns the total cost of the path as a weight object. |
tom | e348941 | 2014-08-29 02:30:38 -0700 | [diff] [blame] | 40 | * |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 41 | * @return path cost as a weight object |
tom | e348941 | 2014-08-29 02:30:38 -0700 | [diff] [blame] | 42 | */ |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 43 | Weight cost(); |
tom | e348941 | 2014-08-29 02:30:38 -0700 | [diff] [blame] | 44 | |
| 45 | } |