Package org.onosproject.net.flowobjective

Interface NextObjective.Builder

All Superinterfaces:

Objective.Builder

All Known Implementing Classes:

DefaultNextObjective.Builder

Enclosing interface:

NextObjective

public static interface NextObjective.Builder
extends Objective.Builder

A next step builder.

Method Summary

Modifier and Type	Method	Description
NextObjective	add()	Builds the next objective that will be added.
NextObjective	add(ObjectiveContext context)	Builds the next objective that will be added.
NextObjective	addToExisting()	Build the next objective that will be added, with Objective.Operation ADD_TO_EXISTING.
NextObjective	addToExisting(ObjectiveContext context)	Builds the next objective that will be added, with Objective.Operation ADD_TO_EXISTING.
NextObjective.Builder	addTreatment(TrafficTreatment treatment)	Deprecated. in 1.14.2, replaced by addTreatment(NextTreatment)
NextObjective.Builder	addTreatment(NextTreatment nextTreatment)	Adds a next treatment to this next step.
NextObjective.Builder	fromApp(ApplicationId appId)	Specifies the application which applied the filter.
NextObjective	modify()	Build the next objective that will be modified with Objective.Operation MODIFY.
NextObjective	modify(ObjectiveContext context)	Build the next objective that will be modified, with Objective.Operation MODIFY.
NextObjective	remove()	Builds the next objective that will be removed.
NextObjective	remove(ObjectiveContext context)	Builds the next objective that will be removed.
NextObjective	removeFromExisting()	Build the next objective that will be removed, with Objective.Operation REMOVE_FROM_EXISTING.
NextObjective	removeFromExisting(ObjectiveContext context)	Builds the next objective that will be removed, with Objective.Operation REMOVE_FROM_EXISTING.
NextObjective	verify()	Builds the next objective that needs to be verified.
NextObjective	verify(ObjectiveContext context)	Builds the next objective that needs to be verified.
NextObjective.Builder	withId(int nextId)	Specifies the id for this next objective.
NextObjective.Builder	withMeta(TrafficSelector selector)	Set meta information related to this next objective.
NextObjective.Builder	withPriority(int priority)	Sets the priority for this objective.
NextObjective.Builder	withType(NextObjective.Type type)	Sets the type of next step.

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

makePermanent, makeTemporary

Method Detail

withId

NextObjective.Builder withId(int nextId)

Specifies the id for this next objective.

Parameters:

nextId - an integer

Returns:

a next objective builder

withType

NextObjective.Builder withType(NextObjective.Type type)

Sets the type of next step.

Parameters:

type - a type

Returns:

a next step builder

addTreatment

@Deprecated
NextObjective.Builder addTreatment(TrafficTreatment treatment)

Deprecated.

in 1.14.2, replaced by addTreatment(NextTreatment)

Adds a treatment to this next step.

Parameters:

treatment - a traffic treatment

Returns:

a next step builder

addTreatment

NextObjective.Builder addTreatment(NextTreatment nextTreatment)

Adds a next treatment to this next step.

Parameters:

nextTreatment - a next treatment

Returns:

a next step builder

fromApp

NextObjective.Builder fromApp(ApplicationId appId)

Specifies the application which applied the filter.

Specified by:

fromApp in interface Objective.Builder

Parameters:

appId - an application id

Returns:

an objective builder

withPriority

NextObjective.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

withMeta

NextObjective.Builder withMeta(TrafficSelector selector)

Set meta information related to this next objective.

Parameters:

selector - match conditions

Returns:

an objective builder

add

NextObjective add()

Builds the next objective that will be added.

Specified by:

add in interface Objective.Builder

Returns:

a next objective

remove

NextObjective remove()

Builds the next objective that will be removed.

Specified by:

remove in interface Objective.Builder

Returns:

a next objective.

add

NextObjective add(ObjectiveContext context)

Builds the next 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 next objective

remove

NextObjective remove(ObjectiveContext context)

Builds the next 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 next objective

addToExisting

NextObjective addToExisting()

Build the next objective that will be added, with Objective.Operation ADD_TO_EXISTING.

Returns:

a next objective

removeFromExisting

NextObjective removeFromExisting()

Build the next objective that will be removed, with Objective.Operation REMOVE_FROM_EXISTING.

Returns:

a next objective

addToExisting

NextObjective addToExisting(ObjectiveContext context)

Builds the next objective that will be added, with Objective.Operation ADD_TO_EXISTING. The context will be used to notify the calling application.

Parameters:

context - an objective context

Returns:

a next objective

removeFromExisting

NextObjective removeFromExisting(ObjectiveContext context)

Builds the next objective that will be removed, with Objective.Operation REMOVE_FROM_EXISTING. The context will be used to notify the calling application.

Parameters:

context - an objective context

Returns:

a next objective

modify

NextObjective modify()

Build the next objective that will be modified with Objective.Operation MODIFY.

Returns:

a next objective

modify

NextObjective modify(ObjectiveContext context)

Build the next objective that will be modified, with Objective.Operation MODIFY. The context will be used to notify the calling application.

Parameters:

context - an objective context

Returns:

a next objective

verify

NextObjective verify()

Builds the next objective that needs to be verified.

Returns:

a next objective with Objective.Operation VERIFY

verify

NextObjective verify(ObjectiveContext context)

Builds the next objective that needs to be verified. The context will be used to notify the calling application.

Parameters:

context - an objective context

Returns:

a next objective with Objective.Operation VERIFY