Package org.onosproject.net.flowobjective

Interface ForwardingObjective.Builder

All Superinterfaces:

Objective.Builder

All Known Implementing Classes:

DefaultForwardingObjective.Builder

Enclosing interface:

ForwardingObjective

public static interface ForwardingObjective.Builder
extends Objective.Builder

A forwarding objective builder.

Method Summary

Modifier and Type	Method	Description
ForwardingObjective	add()	Builds the forwarding objective that will be added.
ForwardingObjective	add(ObjectiveContext context)	Builds the forwarding objective that will be added.
ForwardingObjective.Builder	fromApp(ApplicationId appId)	Assigns an application id.
ForwardingObjective.Builder	makePermanent()	Makes the forwarding objective permanent.
ForwardingObjective.Builder	nextStep(int nextId)	Assigns a next step to the forwarding objective.
ForwardingObjective	remove()	Builds the forwarding objective that will be removed.
ForwardingObjective	remove(ObjectiveContext context)	Builds the forwarding objective that will be removed.
ForwardingObjective.Builder	withAnnotations(Annotations annotations)	Adds annotations to the forwarding objective.
ForwardingObjective.Builder	withFlag(ForwardingObjective.Flag flag)	Assigns the flag to the forwarding objective.
ForwardingObjective.Builder	withMeta(TrafficSelector selector)	Set meta information related to this forwarding objective.
ForwardingObjective.Builder	withPriority(int priority)	Sets the priority for this objective.
ForwardingObjective.Builder	withSelector(TrafficSelector selector)	Assigns a selector to the forwarding objective.
ForwardingObjective.Builder	withTreatment(TrafficTreatment treatment)	Assigns the treatment for this forwarding objective.

Methods inherited from interface org.onosproject.net.flowobjective.Objective.Builder

makeTemporary

Method Detail

withSelector

ForwardingObjective.Builder withSelector(TrafficSelector selector)

Assigns a selector to the forwarding objective.

Parameters:

selector - a traffic selector

Returns:

a forwarding objective builder

nextStep

ForwardingObjective.Builder nextStep(int nextId)

Assigns a next step to the forwarding objective.

Parameters:

nextId - a next objective id.

Returns:

a forwarding objective builder

withTreatment

ForwardingObjective.Builder withTreatment(TrafficTreatment treatment)

Assigns the treatment for this forwarding objective.

Parameters:

treatment - a traffic treatment

Returns:

a forwarding objective

withFlag

ForwardingObjective.Builder withFlag(ForwardingObjective.Flag flag)

Assigns the flag to the forwarding objective.

Parameters:

flag - a flag

Returns:

a forwarding objective builder

withMeta

ForwardingObjective.Builder withMeta(TrafficSelector selector)

Set meta information related to this forwarding objective.

Parameters:

selector - match conditions

Returns:

an objective builder

fromApp

ForwardingObjective.Builder fromApp(ApplicationId appId)

Assigns an application id.

Specified by:

fromApp in interface Objective.Builder

Parameters:

appId - an application id

Returns:

a filtering builder

withPriority

ForwardingObjective.Builder withPriority(int priority)

Sets the priority for this objective.

Specified by:

withPriority in interface Objective.Builder

Parameters:

priority - an integer

Returns:

an objective builder

makePermanent

ForwardingObjective.Builder makePermanent()

Makes the forwarding objective permanent.

Specified by:

makePermanent in interface Objective.Builder

Returns:

an objective builder

withAnnotations

ForwardingObjective.Builder withAnnotations(Annotations annotations)

Adds annotations to the forwarding objective.

Specified by:

withAnnotations in interface Objective.Builder

Parameters:

annotations - the annotations for the forwarding objective

Returns:

a forwarding objective builder

add

ForwardingObjective add()

Builds the forwarding objective that will be added.

Specified by:

add in interface Objective.Builder

Returns:

a forwarding objective

remove

ForwardingObjective remove()

Builds the forwarding objective that will be removed.

Specified by:

remove in interface Objective.Builder

Returns:

a forwarding objective.

add

ForwardingObjective add(ObjectiveContext context)

Builds the forwarding objective that will be added. The context will be used to notify the calling application.

Specified by:

add in interface Objective.Builder

Parameters:

context - an objective context

Returns:

a forwarding objective

remove

ForwardingObjective remove(ObjectiveContext context)

Builds the forwarding objective that will be removed. The context will be used to notify the calling application.

Specified by:

remove in interface Objective.Builder

Parameters:

context - an objective context

Returns:

a forwarding objective