org.onosproject.vtnrsc

Class DefaultPortPairGroup

java.lang.Object

org.onosproject.vtnrsc.DefaultPortPairGroup

All Implemented Interfaces:

PortPairGroup

public final class DefaultPortPairGroup
extends Object
implements PortPairGroup

Implementation of port pair group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPortPairGroup.Builder Builder class for Port pair group.

Method Summary

Modifier and Type	Method and Description
void	addLoad(PortPairId portPairId) Adds the load on the given port pair id.
static DefaultPortPairGroup.Builder	builder() To create an instance of the builder.
String	description() Returns the description of this port pair group.
boolean	equals(Object obj)
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.
int	hashCode()
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.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

portPairGroupId

public PortPairGroupId portPairGroupId()

Description copied from interface: PortPairGroup

Returns the ID of this port pair group.

Specified by:

portPairGroupId in interface PortPairGroup

Returns:

the port pair group id

tenantId

public TenantId tenantId()

Description copied from interface: PortPairGroup

Returns the tenant id of this port pair group.

Specified by:

tenantId in interface PortPairGroup

Returns:

the tenant id

name

public String name()

Description copied from interface: PortPairGroup

Returns the name of this port pair group.

Specified by:

name in interface PortPairGroup

Returns:

name of port pair group

description

public String description()

Description copied from interface: PortPairGroup

Returns the description of this port pair group.

Specified by:

description in interface PortPairGroup

Returns:

description of port pair group

portPairs

public List<PortPairId> portPairs()

Description copied from interface: PortPairGroup

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

Specified by:

portPairs in interface PortPairGroup

Returns:

list of port pairs

addLoad

public void addLoad(PortPairId portPairId)

Description copied from interface: PortPairGroup

Adds the load on the given port pair id.

Specified by:

addLoad in interface PortPairGroup

Parameters:

portPairId - port pair id.

resetLoad

public void resetLoad()

Description copied from interface: PortPairGroup

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

Specified by:

resetLoad in interface PortPairGroup

getLoad

public int getLoad(PortPairId portPairId)

Description copied from interface: PortPairGroup

Get the load on the given port pair id.

Specified by:

getLoad in interface PortPairGroup

Parameters:

portPairId - port pair id

Returns:

load on the given port pair id.

portPairLoadMap

public Map<PortPairId,Integer> portPairLoadMap()

Description copied from interface: PortPairGroup

Get the map of port pair id and its load.

Specified by:

portPairLoadMap in interface PortPairGroup

Returns:

port pair and load map

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

exactMatch

public boolean exactMatch(PortPairGroup portPairGroup)

Description copied from interface: 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.

Specified by:

exactMatch in interface PortPairGroup

Parameters:

portPairGroup - other port pair group to match against

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

builder

public static DefaultPortPairGroup.Builder builder()

To create an instance of the builder.

Returns:

instance of builder