Package org.onosproject.net

Class DefaultPath

java.lang.Object

org.onosproject.net.AbstractAnnotated

org.onosproject.net.AbstractModel

org.onosproject.net.AbstractProjectableModel

org.onosproject.net.DefaultLink

org.onosproject.net.DefaultPath

All Implemented Interfaces:

Annotated, Projectable, Link, NetworkResource, Path, Provided

Direct Known Subclasses:

DefaultDisjointPath

public class DefaultPath
extends DefaultLink
implements Path

Default implementation of a network path.

Nested Class Summary

Nested classes/interfaces inherited from class org.onosproject.net.DefaultLink

DefaultLink.Builder

Nested classes/interfaces inherited from class org.onosproject.net.AbstractProjectableModel

AbstractProjectableModel.AnnotationDriverData

Nested classes/interfaces inherited from interface org.onosproject.net.Link

Link.State, Link.Type

Field Summary

Fields inherited from class org.onosproject.net.AbstractProjectableModel

NO_DRIVER, NO_DRIVER_SERVICE

Constructor Summary

Constructors

Constructor	Description
DefaultPath(ProviderId providerId, java.util.List<Link> links, Weight cost, Annotations... annotations)	Creates a path from the specified source and destination using the supplied list of links.

Method Summary

Modifier and Type	Method	Description
double	cost()	Returns the path cost as a unit-less value.
boolean	equals(java.lang.Object obj)
int	hashCode()
java.util.List<Link>	links()	Returns sequence of links comprising the path.
java.lang.String	toString()
Weight	weight()	Returns the path cost as an weight instance.

Methods inherited from class org.onosproject.net.DefaultLink

builder, dst, isExpected, src, state, type

Methods inherited from class org.onosproject.net.AbstractProjectableModel

as, asData, bindAndCheckDriver, bindDriver, driver, driverService, is, locateDriver, setDriverService

Methods inherited from class org.onosproject.net.AbstractModel

providerId

Methods inherited from class org.onosproject.net.AbstractAnnotated

annotations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.onosproject.net.Annotated

annotations

Methods inherited from interface org.onosproject.net.Link

dst, isExpected, src, state, type

Methods inherited from interface org.onosproject.net.driver.Projectable

as, is, project

Methods inherited from interface org.onosproject.net.Provided

providerId

Constructor Detail

DefaultPath

public DefaultPath(ProviderId providerId,
                   java.util.List<Link> links,
                   Weight cost,
                   Annotations... annotations)

Creates a path from the specified source and destination using the supplied list of links.

Parameters:

providerId - provider identity

links - contiguous links that comprise the path

cost - unit-less path cost

annotations - optional key/value annotations

Method Detail

links

public java.util.List<Link> links()

Description copied from interface: Path

Returns sequence of links comprising the path.

Specified by:

links in interface Path

Returns:

list of links

cost

public double cost()

Description copied from interface: Path

Returns the path cost as a unit-less value.

Specified by:

cost in interface Path

Returns:

unit-less path cost

weight

public Weight weight()

Description copied from interface: Path

Returns the path cost as an weight instance.

Specified by:

weight in interface Path

Returns:

weight path cost

toString

public java.lang.String toString()

Overrides:

toString in class DefaultLink

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultLink

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class DefaultLink