Package org.onosproject.net.pi.runtime

Class PiActionProfileGroup

java.lang.Object

org.onosproject.net.pi.runtime.PiActionProfileGroup

All Implemented Interfaces:

PiEntity

@Beta
public final class PiActionProfileGroup
extends Object
implements PiEntity

Instance of an action profile group of a protocol-independent pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PiActionProfileGroup.Builder	Builder of action profile groups.
static class	PiActionProfileGroup.WeightedMember	Weighted reference to an action profile member as used in an action profile group.

Method Summary

Modifier and Type	Method	Description
PiActionProfileId	actionProfile()	Returns the ID of the action profile where this group belong.
static PiActionProfileGroup.Builder	builder()	Returns a new builder of action profile groups.
boolean	equals(Object obj)
PiActionProfileGroupHandle	handle(DeviceId deviceId)	Returns a handle for this PI entity and the given device ID.
int	hashCode()
PiActionProfileGroupId	id()	Returns the ID of this action profile group.
int	maxSize()	Returns the maximum number of members that this group can hold.
Optional<PiActionProfileGroup.WeightedMember>	member(PiActionProfileMemberId memberId)	Returns the group member identified by the given action profile member ID, if present.
Collection<PiActionProfileGroup.WeightedMember>	members()	Returns the list of member references of this action profile group.
PiEntityType	piEntityType()	Returns the type of this entity.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

id

public PiActionProfileGroupId id()

Returns the ID of this action profile group.

Returns:

action profile group ID

members

public Collection<PiActionProfileGroup.WeightedMember> members()

Returns the list of member references of this action profile group.

Returns:

collection of action profile members.

member

public Optional<PiActionProfileGroup.WeightedMember> member(PiActionProfileMemberId memberId)

Returns the group member identified by the given action profile member ID, if present.

Parameters:

memberId - action profile member ID

Returns:

optional group member

maxSize

public int maxSize()

Returns the maximum number of members that this group can hold. 0 signifies that a limit is not set.

Returns:

maximum number of members that this group can hold

actionProfile

public PiActionProfileId actionProfile()

Returns the ID of the action profile where this group belong.

Returns:

action profile ID

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static PiActionProfileGroup.Builder builder()

Returns a new builder of action profile groups.

Returns:

action profile group builder

piEntityType

public PiEntityType piEntityType()

Description copied from interface: PiEntity

Returns the type of this entity.

Specified by:

piEntityType in interface PiEntity

Returns:

entity type

handle

public PiActionProfileGroupHandle handle(DeviceId deviceId)

Description copied from interface: PiEntity

Returns a handle for this PI entity and the given device ID.

Specified by:

handle in interface PiEntity

Parameters:

deviceId - device ID

Returns:

handle