org.onosproject.vtnrsc

Interface PortPairGroup

All Known Implementing Classes:

DefaultPortPairGroup

public interface PortPairGroup

Abstraction of an entity providing Port Pair Group information. A port pair group consists of one or more port pairs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PortPairGroup.Builder A port pair group builder..

Method Summary

Modifier and Type	Method and Description
void	addLoad(PortPairId portPairId) Adds the load on the given port pair id.
String	description() Returns the description of this port pair group.
boolean	exactMatch(PortPairGroup portPairGroup) Returns whether this port pair group is an exact match to the port pair group given in the argument.
int	getLoad(PortPairId portPairId) Get the load on the given port pair id.
String	name() Returns the name of this port pair group.
PortPairGroupId	portPairGroupId() Returns the ID of this port pair group.
Map<PortPairId,Integer>	portPairLoadMap() Get the map of port pair id and its load.
List<PortPairId>	portPairs() Returns the list of port pairs associated with this port pair group.
void	resetLoad() Reset the load for all the port pairs in the group.
TenantId	tenantId() Returns the tenant id of this port pair group.

Method Detail

portPairGroupId

PortPairGroupId portPairGroupId()

Returns the ID of this port pair group.

Returns:

the port pair group id

tenantId

TenantId tenantId()

Returns the tenant id of this port pair group.

Returns:

the tenant id

name

String name()

Returns the name of this port pair group.

Returns:

name of port pair group

description

String description()

Returns the description of this port pair group.

Returns:

description of port pair group

portPairs

List<PortPairId> portPairs()

Returns the list of port pairs associated with this port pair group.

Returns:

list of port pairs

addLoad

void addLoad(PortPairId portPairId)

Adds the load on the given port pair id.

Parameters:

portPairId - port pair id.

resetLoad

void resetLoad()

Reset the load for all the port pairs in the group.

getLoad

int getLoad(PortPairId portPairId)

Get the load on the given port pair id.

Parameters:

portPairId - port pair id

Returns:

load on the given port pair id.

portPairLoadMap

Map<PortPairId,Integer> portPairLoadMap()

Get the map of port pair id and its load.

Returns:

port pair and load map

exactMatch

boolean exactMatch(PortPairGroup portPairGroup)

Returns whether this port pair group is an exact match to the port pair group given in the argument.

Exact match means the Port pairs match with the given port pair group. It does not consider the port pair group id, name and description.

Parameters:

portPairGroup - other port pair group to match against

Returns:

true if the port pairs are an exact match, otherwise false