Package org.opendaylight.protocol.bgp.rib.spi.entry

Record Class BestPathUpdate

java.lang.Object

java.lang.Record

org.opendaylight.protocol.bgp.rib.spi.entry.BestPathUpdate

Record Components:

adverized - collection of AdvertizedRoutes to advertize after processing update of stale and new advertisement of routes

stale - the StaleBestPathRoute to withdraw, or null if there is nothing to withdraw

@NonNullByDefault
public record BestPathUpdate(List<AdvertizedRoute> adverized, @Nullable StaleBestPathRoute stale)
extends Record

An update to advertized BestPath.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
BestPathUpdate(List<AdvertizedRoute> adverized, @Nullable StaleBestPathRoute stale)	Creates an instance of a BestPathUpdate record class.

Method Summary

Modifier and Type	Method	Description
List<AdvertizedRoute>	adverized()	Returns the value of the adverized record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable StaleBestPathRoute	stale()	Returns the value of the stale record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

BestPathUpdate

public BestPathUpdate(List<AdvertizedRoute> adverized,
 @Nullable StaleBestPathRoute stale)

Creates an instance of a BestPathUpdate record class.

Parameters:

adverized - the value for the adverized record component

stale - the value for the stale record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

adverized

public List<AdvertizedRoute> adverized()

Returns the value of the adverized record component.

Returns:

the value of the adverized record component

stale

public @Nullable StaleBestPathRoute stale()

Returns the value of the stale record component.

Returns:

the value of the stale record component